ServiceCatalogClient

Index > ServiceCatalog > ServiceCatalogClient

Auto-generated documentation for ServiceCatalog type annotations stubs module types-aiobotocore-servicecatalog.

ServiceCatalogClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_servicecatalog.client import ServiceCatalogClient

session = Session()
async with session.client("servicecatalog") as client:
    client: ServiceCatalogClient

Exceptions

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

Usage example

async with session.client("servicecatalog") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.DuplicateResourceException,
        client.InvalidParametersException,
        client.InvalidStateException,
        client.LimitExceededException,
        client.OperationNotSupportedException,
        client.ResourceInUseException,
        client.ResourceNotFoundException,
        client.TagOptionNotMigratedException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_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 session.client("servicecatalog").accept_portfolio_share method. boto3 documentation

Method definition

await def accept_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    PortfolioShareType: PortfolioShareTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See PortfolioShareTypeType

Usage example with kwargs

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 session.client("servicecatalog").associate_budget_with_resource method. boto3 documentation

Method definition

await def associate_budget_with_resource(
    self,
    *,
    BudgetName: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("servicecatalog").associate_principal_with_portfolio method. boto3 documentation

Method definition

await def associate_principal_with_portfolio(
    self,
    *,
    PortfolioId: str,
    PrincipalARN: str,
    PrincipalType: PrincipalTypeType,  # (1)
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

1. See PrincipalTypeType

Usage example with kwargs

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 session.client("servicecatalog").associate_product_with_portfolio method. boto3 documentation

Method definition

await def associate_product_with_portfolio(
    self,
    *,
    ProductId: str,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    SourcePortfolioId: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("servicecatalog").associate_service_action_with_provisioning_artifact method. boto3 documentation

Method definition

await def associate_service_action_with_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    ServiceActionId: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("servicecatalog").associate_tag_option_with_resource method. boto3 documentation

Method definition

await def associate_tag_option_with_resource(
    self,
    *,
    ResourceId: str,
    TagOptionId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("servicecatalog").batch_associate_service_action_with_provisioning_artifact method. boto3 documentation

Method definition

await def batch_associate_service_action_with_provisioning_artifact(
    self,
    *,
    ServiceActionAssociations: Sequence[ServiceActionAssociationTypeDef],  # (1)
    AcceptLanguage: str = ...,
) -> BatchAssociateServiceActionWithProvisioningArtifactOutputTypeDef:  # (2)
    ...

1. See ServiceActionAssociationTypeDef
2. See BatchAssociateServiceActionWithProvisioningArtifactOutputTypeDef

Usage example with kwargs

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 session.client("servicecatalog").batch_disassociate_service_action_from_provisioning_artifact method. boto3 documentation

Method definition

await def batch_disassociate_service_action_from_provisioning_artifact(
    self,
    *,
    ServiceActionAssociations: Sequence[ServiceActionAssociationTypeDef],  # (1)
    AcceptLanguage: str = ...,
) -> BatchDisassociateServiceActionFromProvisioningArtifactOutputTypeDef:  # (2)
    ...

1. See ServiceActionAssociationTypeDef
2. See BatchDisassociateServiceActionFromProvisioningArtifactOutputTypeDef

Usage example with kwargs

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 session.client("servicecatalog").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

await def close(
    self,
) -> None:
    ...

copy_product

Copies the specified source product to the specified target product or a new product.

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

Method definition

await def copy_product(
    self,
    *,
    SourceProductArn: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
    TargetProductId: str = ...,
    TargetProductName: str = ...,
    SourceProvisioningArtifactIdentifiers: Sequence[Mapping[ProvisioningArtifactPropertyNameType, str]] = ...,  # (1)
    CopyOptions: Sequence[CopyOptionType] = ...,  # (2)
) -> CopyProductOutputTypeDef:  # (3)
    ...

1. See ProvisioningArtifactPropertyNameType
2. See CopyOptionType
3. See CopyProductOutputTypeDef

Usage example with kwargs

kwargs: CopyProductInputRequestTypeDef = {  # (1)
    "SourceProductArn": ...,
    "IdempotencyToken": ...,
}

parent.copy_product(**kwargs)

1. See CopyProductInputRequestTypeDef

create_constraint

Creates a constraint.

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

Method definition

await def create_constraint(
    self,
    *,
    PortfolioId: str,
    ProductId: str,
    Parameters: str,
    Type: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
    Description: str = ...,
) -> CreateConstraintOutputTypeDef:  # (1)
    ...

1. See CreateConstraintOutputTypeDef

Usage example with kwargs

kwargs: CreateConstraintInputRequestTypeDef = {  # (1)
    "PortfolioId": ...,
    "ProductId": ...,
    "Parameters": ...,
    "Type": ...,
    "IdempotencyToken": ...,
}

parent.create_constraint(**kwargs)

1. See CreateConstraintInputRequestTypeDef

create_portfolio

Creates a portfolio.

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

Method definition

await def create_portfolio(
    self,
    *,
    DisplayName: str,
    ProviderName: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreatePortfolioOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreatePortfolioOutputTypeDef

Usage example with kwargs

kwargs: CreatePortfolioInputRequestTypeDef = {  # (1)
    "DisplayName": ...,
    "ProviderName": ...,
    "IdempotencyToken": ...,
}

parent.create_portfolio(**kwargs)

1. See CreatePortfolioInputRequestTypeDef

create_portfolio_share

Shares the specified portfolio with the specified account or organization node.

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

Method definition

await def create_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    AccountId: str = ...,
    OrganizationNode: OrganizationNodeTypeDef = ...,  # (1)
    ShareTagOptions: bool = ...,
) -> CreatePortfolioShareOutputTypeDef:  # (2)
    ...

1. See OrganizationNodeTypeDef
2. See CreatePortfolioShareOutputTypeDef

Usage example with kwargs

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

parent.create_portfolio_share(**kwargs)

1. See CreatePortfolioShareInputRequestTypeDef

create_product

Creates a product.

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

Method definition

await def create_product(
    self,
    *,
    Name: str,
    Owner: str,
    ProductType: ProductTypeType,  # (1)
    ProvisioningArtifactParameters: ProvisioningArtifactPropertiesTypeDef,  # (2)
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
    Description: str = ...,
    Distributor: str = ...,
    SupportDescription: str = ...,
    SupportEmail: str = ...,
    SupportUrl: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateProductOutputTypeDef:  # (4)
    ...

1. See ProductTypeType
2. See ProvisioningArtifactPropertiesTypeDef
3. See TagTypeDef
4. See CreateProductOutputTypeDef

Usage example with kwargs

kwargs: CreateProductInputRequestTypeDef = {  # (1)
    "Name": ...,
    "Owner": ...,
    "ProductType": ...,
    "ProvisioningArtifactParameters": ...,
    "IdempotencyToken": ...,
}

parent.create_product(**kwargs)

1. See CreateProductInputRequestTypeDef

create_provisioned_product_plan

Creates a plan.

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

Method definition

await def create_provisioned_product_plan(
    self,
    *,
    PlanName: str,
    PlanType: ProvisionedProductPlanTypeType,  # (1)
    ProductId: str,
    ProvisionedProductName: str,
    ProvisioningArtifactId: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
    NotificationArns: Sequence[str] = ...,
    PathId: str = ...,
    ProvisioningParameters: Sequence[UpdateProvisioningParameterTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateProvisionedProductPlanOutputTypeDef:  # (4)
    ...

1. See ProvisionedProductPlanTypeType
2. See UpdateProvisioningParameterTypeDef
3. See TagTypeDef
4. See CreateProvisionedProductPlanOutputTypeDef

Usage example with kwargs

kwargs: CreateProvisionedProductPlanInputRequestTypeDef = {  # (1)
    "PlanName": ...,
    "PlanType": ...,
    "ProductId": ...,
    "ProvisionedProductName": ...,
    "ProvisioningArtifactId": ...,
    "IdempotencyToken": ...,
}

parent.create_provisioned_product_plan(**kwargs)

1. See CreateProvisionedProductPlanInputRequestTypeDef

create_provisioning_artifact

Creates a provisioning artifact (also known as a version) for the specified product.

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

Method definition

await def create_provisioning_artifact(
    self,
    *,
    ProductId: str,
    Parameters: ProvisioningArtifactPropertiesTypeDef,  # (1)
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
) -> CreateProvisioningArtifactOutputTypeDef:  # (2)
    ...

1. See ProvisioningArtifactPropertiesTypeDef
2. See CreateProvisioningArtifactOutputTypeDef

Usage example with kwargs

kwargs: CreateProvisioningArtifactInputRequestTypeDef = {  # (1)
    "ProductId": ...,
    "Parameters": ...,
    "IdempotencyToken": ...,
}

parent.create_provisioning_artifact(**kwargs)

1. See CreateProvisioningArtifactInputRequestTypeDef

create_service_action

Creates a self-service action.

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

Method definition

await def create_service_action(
    self,
    *,
    Name: str,
    DefinitionType: ServiceActionDefinitionTypeType,  # (1)
    Definition: Mapping[ServiceActionDefinitionKeyType, str],  # (2)
    IdempotencyToken: str,
    Description: str = ...,
    AcceptLanguage: str = ...,
) -> CreateServiceActionOutputTypeDef:  # (3)
    ...

1. See ServiceActionDefinitionTypeType
2. See ServiceActionDefinitionKeyType
3. See CreateServiceActionOutputTypeDef

Usage example with kwargs

kwargs: CreateServiceActionInputRequestTypeDef = {  # (1)
    "Name": ...,
    "DefinitionType": ...,
    "Definition": ...,
    "IdempotencyToken": ...,
}

parent.create_service_action(**kwargs)

1. See CreateServiceActionInputRequestTypeDef

create_tag_option

Creates a TagOption.

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

Method definition

await def create_tag_option(
    self,
    *,
    Key: str,
    Value: str,
) -> CreateTagOptionOutputTypeDef:  # (1)
    ...

1. See CreateTagOptionOutputTypeDef

Usage example with kwargs

kwargs: CreateTagOptionInputRequestTypeDef = {  # (1)
    "Key": ...,
    "Value": ...,
}

parent.create_tag_option(**kwargs)

1. See CreateTagOptionInputRequestTypeDef

delete_constraint

Deletes the specified constraint.

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

Method definition

await def delete_constraint(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteConstraintInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_constraint(**kwargs)

1. See DeleteConstraintInputRequestTypeDef

delete_portfolio

Deletes the specified portfolio.

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

Method definition

await def delete_portfolio(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeletePortfolioInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_portfolio(**kwargs)

1. See DeletePortfolioInputRequestTypeDef

delete_portfolio_share

Stops sharing the specified portfolio with the specified account or organization node.

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

Method definition

await def delete_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    AccountId: str = ...,
    OrganizationNode: OrganizationNodeTypeDef = ...,  # (1)
) -> DeletePortfolioShareOutputTypeDef:  # (2)
    ...

1. See OrganizationNodeTypeDef
2. See DeletePortfolioShareOutputTypeDef

Usage example with kwargs

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

parent.delete_portfolio_share(**kwargs)

1. See DeletePortfolioShareInputRequestTypeDef

delete_product

Deletes the specified product.

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

Method definition

await def delete_product(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteProductInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_product(**kwargs)

1. See DeleteProductInputRequestTypeDef

delete_provisioned_product_plan

Deletes the specified plan.

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

Method definition

await def delete_provisioned_product_plan(
    self,
    *,
    PlanId: str,
    AcceptLanguage: str = ...,
    IgnoreErrors: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteProvisionedProductPlanInputRequestTypeDef = {  # (1)
    "PlanId": ...,
}

parent.delete_provisioned_product_plan(**kwargs)

1. See DeleteProvisionedProductPlanInputRequestTypeDef

delete_provisioning_artifact

Deletes the specified provisioning artifact (also known as a version) for the specified product.

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

Method definition

await def delete_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_provisioning_artifact(**kwargs)

1. See DeleteProvisioningArtifactInputRequestTypeDef

delete_service_action

Deletes a self-service action.

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

Method definition

await def delete_service_action(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteServiceActionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_service_action(**kwargs)

1. See DeleteServiceActionInputRequestTypeDef

delete_tag_option

Deletes the specified TagOption.

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

Method definition

await def delete_tag_option(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteTagOptionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_tag_option(**kwargs)

1. See DeleteTagOptionInputRequestTypeDef

describe_constraint

Gets information about the specified constraint.

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

Method definition

await def describe_constraint(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> DescribeConstraintOutputTypeDef:  # (1)
    ...

1. See DescribeConstraintOutputTypeDef

Usage example with kwargs

kwargs: DescribeConstraintInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_constraint(**kwargs)

1. See DescribeConstraintInputRequestTypeDef

describe_copy_product_status

Gets the status of the specified copy product operation.

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

Method definition

await def describe_copy_product_status(
    self,
    *,
    CopyProductToken: str,
    AcceptLanguage: str = ...,
) -> DescribeCopyProductStatusOutputTypeDef:  # (1)
    ...

1. See DescribeCopyProductStatusOutputTypeDef

Usage example with kwargs

kwargs: DescribeCopyProductStatusInputRequestTypeDef = {  # (1)
    "CopyProductToken": ...,
}

parent.describe_copy_product_status(**kwargs)

1. See DescribeCopyProductStatusInputRequestTypeDef

describe_portfolio

Gets information about the specified portfolio.

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

Method definition

await def describe_portfolio(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> DescribePortfolioOutputTypeDef:  # (1)
    ...

1. See DescribePortfolioOutputTypeDef

Usage example with kwargs

kwargs: DescribePortfolioInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_portfolio(**kwargs)

1. See DescribePortfolioInputRequestTypeDef

describe_portfolio_share_status

Gets the status of the specified portfolio share operation.

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

Method definition

await def describe_portfolio_share_status(
    self,
    *,
    PortfolioShareToken: str,
) -> DescribePortfolioShareStatusOutputTypeDef:  # (1)
    ...

1. See DescribePortfolioShareStatusOutputTypeDef

Usage example with kwargs

kwargs: DescribePortfolioShareStatusInputRequestTypeDef = {  # (1)
    "PortfolioShareToken": ...,
}

parent.describe_portfolio_share_status(**kwargs)

1. See DescribePortfolioShareStatusInputRequestTypeDef

describe_portfolio_shares

Returns a summary of each of the portfolio shares that were created for the specified portfolio.

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

Method definition

await def describe_portfolio_shares(
    self,
    *,
    PortfolioId: str,
    Type: DescribePortfolioShareTypeType,  # (1)
    PageToken: str = ...,
    PageSize: int = ...,
) -> DescribePortfolioSharesOutputTypeDef:  # (2)
    ...

1. See DescribePortfolioShareTypeType
2. See DescribePortfolioSharesOutputTypeDef

Usage example with kwargs

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

parent.describe_portfolio_shares(**kwargs)

1. See DescribePortfolioSharesInputRequestTypeDef

describe_product

Gets information about the specified product.

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

Method definition

await def describe_product(
    self,
    *,
    AcceptLanguage: str = ...,
    Id: str = ...,
    Name: str = ...,
) -> DescribeProductOutputTypeDef:  # (1)
    ...

1. See DescribeProductOutputTypeDef

Usage example with kwargs

kwargs: DescribeProductInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.describe_product(**kwargs)

1. See DescribeProductInputRequestTypeDef

describe_product_as_admin

Gets information about the specified product.

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

Method definition

await def describe_product_as_admin(
    self,
    *,
    AcceptLanguage: str = ...,
    Id: str = ...,
    Name: str = ...,
    SourcePortfolioId: str = ...,
) -> DescribeProductAsAdminOutputTypeDef:  # (1)
    ...

1. See DescribeProductAsAdminOutputTypeDef

Usage example with kwargs

kwargs: DescribeProductAsAdminInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.describe_product_as_admin(**kwargs)

1. See DescribeProductAsAdminInputRequestTypeDef

describe_product_view

Gets information about the specified product.

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

Method definition

await def describe_product_view(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> DescribeProductViewOutputTypeDef:  # (1)
    ...

1. See DescribeProductViewOutputTypeDef

Usage example with kwargs

kwargs: DescribeProductViewInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_product_view(**kwargs)

1. See DescribeProductViewInputRequestTypeDef

describe_provisioned_product

Gets information about the specified provisioned product.

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

Method definition

await def describe_provisioned_product(
    self,
    *,
    AcceptLanguage: str = ...,
    Id: str = ...,
    Name: str = ...,
) -> DescribeProvisionedProductOutputTypeDef:  # (1)
    ...

1. See DescribeProvisionedProductOutputTypeDef

Usage example with kwargs

kwargs: DescribeProvisionedProductInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.describe_provisioned_product(**kwargs)

1. See DescribeProvisionedProductInputRequestTypeDef

describe_provisioned_product_plan

Gets information about the resource changes for the specified plan.

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

Method definition

await def describe_provisioned_product_plan(
    self,
    *,
    PlanId: str,
    AcceptLanguage: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> DescribeProvisionedProductPlanOutputTypeDef:  # (1)
    ...

1. See DescribeProvisionedProductPlanOutputTypeDef

Usage example with kwargs

kwargs: DescribeProvisionedProductPlanInputRequestTypeDef = {  # (1)
    "PlanId": ...,
}

parent.describe_provisioned_product_plan(**kwargs)

1. See DescribeProvisionedProductPlanInputRequestTypeDef

describe_provisioning_artifact

Gets information about the specified provisioning artifact (also known as a version) for the specified product.

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

Method definition

await def describe_provisioning_artifact(
    self,
    *,
    AcceptLanguage: str = ...,
    ProvisioningArtifactId: str = ...,
    ProductId: str = ...,
    ProvisioningArtifactName: str = ...,
    ProductName: str = ...,
    Verbose: bool = ...,
) -> DescribeProvisioningArtifactOutputTypeDef:  # (1)
    ...

1. See DescribeProvisioningArtifactOutputTypeDef

Usage example with kwargs

kwargs: DescribeProvisioningArtifactInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.describe_provisioning_artifact(**kwargs)

1. See DescribeProvisioningArtifactInputRequestTypeDef

describe_provisioning_parameters

Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

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

Method definition

await def describe_provisioning_parameters(
    self,
    *,
    AcceptLanguage: str = ...,
    ProductId: str = ...,
    ProductName: str = ...,
    ProvisioningArtifactId: str = ...,
    ProvisioningArtifactName: str = ...,
    PathId: str = ...,
    PathName: str = ...,
) -> DescribeProvisioningParametersOutputTypeDef:  # (1)
    ...

1. See DescribeProvisioningParametersOutputTypeDef

Usage example with kwargs

kwargs: DescribeProvisioningParametersInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.describe_provisioning_parameters(**kwargs)

1. See DescribeProvisioningParametersInputRequestTypeDef

describe_record

Gets information about the specified request operation.

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

Method definition

await def describe_record(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> DescribeRecordOutputTypeDef:  # (1)
    ...

1. See DescribeRecordOutputTypeDef

Usage example with kwargs

kwargs: DescribeRecordInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_record(**kwargs)

1. See DescribeRecordInputRequestTypeDef

describe_service_action

Describes a self-service action.

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

Method definition

await def describe_service_action(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
) -> DescribeServiceActionOutputTypeDef:  # (1)
    ...

1. See DescribeServiceActionOutputTypeDef

Usage example with kwargs

kwargs: DescribeServiceActionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_service_action(**kwargs)

1. See DescribeServiceActionInputRequestTypeDef

describe_service_action_execution_parameters

Finds the default parameters for a specific self-service action on a specific provisioned product and returns a map of the results to the user.

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

Method definition

await def describe_service_action_execution_parameters(
    self,
    *,
    ProvisionedProductId: str,
    ServiceActionId: str,
    AcceptLanguage: str = ...,
) -> DescribeServiceActionExecutionParametersOutputTypeDef:  # (1)
    ...

1. See DescribeServiceActionExecutionParametersOutputTypeDef

Usage example with kwargs

kwargs: DescribeServiceActionExecutionParametersInputRequestTypeDef = {  # (1)
    "ProvisionedProductId": ...,
    "ServiceActionId": ...,
}

parent.describe_service_action_execution_parameters(**kwargs)

1. See DescribeServiceActionExecutionParametersInputRequestTypeDef

describe_tag_option

Gets information about the specified TagOption.

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

Method definition

await def describe_tag_option(
    self,
    *,
    Id: str,
) -> DescribeTagOptionOutputTypeDef:  # (1)
    ...

1. See DescribeTagOptionOutputTypeDef

Usage example with kwargs

kwargs: DescribeTagOptionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_tag_option(**kwargs)

1. See DescribeTagOptionInputRequestTypeDef

disable_aws_organizations_access

Disable portfolio sharing through the Organizations service.

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

Method definition

await def disable_aws_organizations_access(
    self,
) -> Dict[str, Any]:
    ...

disassociate_budget_from_resource

Disassociates the specified budget from the specified resource.

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

Method definition

await def disassociate_budget_from_resource(
    self,
    *,
    BudgetName: str,
    ResourceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_budget_from_resource(**kwargs)

1. See DisassociateBudgetFromResourceInputRequestTypeDef

disassociate_principal_from_portfolio

Disassociates a previously associated principal ARN from a specified portfolio.

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

Method definition

await def disassociate_principal_from_portfolio(
    self,
    *,
    PortfolioId: str,
    PrincipalARN: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_principal_from_portfolio(**kwargs)

1. See DisassociatePrincipalFromPortfolioInputRequestTypeDef

disassociate_product_from_portfolio

Disassociates the specified product from the specified portfolio.

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

Method definition

await def disassociate_product_from_portfolio(
    self,
    *,
    ProductId: str,
    PortfolioId: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_product_from_portfolio(**kwargs)

1. See DisassociateProductFromPortfolioInputRequestTypeDef

disassociate_service_action_from_provisioning_artifact

Disassociates the specified self-service action association from the specified provisioning artifact.

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

Method definition

await def disassociate_service_action_from_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    ServiceActionId: str,
    AcceptLanguage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_service_action_from_provisioning_artifact(**kwargs)

1. See DisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef

disassociate_tag_option_from_resource

Disassociates the specified TagOption from the specified resource.

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

Method definition

await def disassociate_tag_option_from_resource(
    self,
    *,
    ResourceId: str,
    TagOptionId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.disassociate_tag_option_from_resource(**kwargs)

1. See DisassociateTagOptionFromResourceInputRequestTypeDef

enable_aws_organizations_access

Enable portfolio sharing feature through Organizations.

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

Method definition

await def enable_aws_organizations_access(
    self,
) -> Dict[str, Any]:
    ...

execute_provisioned_product_plan

Provisions or modifies a product based on the resource changes for the specified plan.

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

Method definition

await def execute_provisioned_product_plan(
    self,
    *,
    PlanId: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
) -> ExecuteProvisionedProductPlanOutputTypeDef:  # (1)
    ...

1. See ExecuteProvisionedProductPlanOutputTypeDef

Usage example with kwargs

kwargs: ExecuteProvisionedProductPlanInputRequestTypeDef = {  # (1)
    "PlanId": ...,
    "IdempotencyToken": ...,
}

parent.execute_provisioned_product_plan(**kwargs)

1. See ExecuteProvisionedProductPlanInputRequestTypeDef

execute_provisioned_product_service_action

Executes a self-service action against a provisioned product.

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

Method definition

await def execute_provisioned_product_service_action(
    self,
    *,
    ProvisionedProductId: str,
    ServiceActionId: str,
    ExecuteToken: str,
    AcceptLanguage: str = ...,
    Parameters: Mapping[str, Sequence[str]] = ...,
) -> ExecuteProvisionedProductServiceActionOutputTypeDef:  # (1)
    ...

1. See ExecuteProvisionedProductServiceActionOutputTypeDef

Usage example with kwargs

kwargs: ExecuteProvisionedProductServiceActionInputRequestTypeDef = {  # (1)
    "ProvisionedProductId": ...,
    "ServiceActionId": ...,
    "ExecuteToken": ...,
}

parent.execute_provisioned_product_service_action(**kwargs)

1. See ExecuteProvisionedProductServiceActionInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_aws_organizations_access_status

Get the Access Status for Organizations portfolio share feature.

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

Method definition

await def get_aws_organizations_access_status(
    self,
) -> GetAWSOrganizationsAccessStatusOutputTypeDef:  # (1)
    ...

1. See GetAWSOrganizationsAccessStatusOutputTypeDef

get_provisioned_product_outputs

This API takes either a ProvisonedProductId or a ProvisionedProductName , along with a list of one or more output keys, and responds with the key/value pairs of those outputs.

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

Method definition

await def get_provisioned_product_outputs(
    self,
    *,
    AcceptLanguage: str = ...,
    ProvisionedProductId: str = ...,
    ProvisionedProductName: str = ...,
    OutputKeys: Sequence[str] = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> GetProvisionedProductOutputsOutputTypeDef:  # (1)
    ...

1. See GetProvisionedProductOutputsOutputTypeDef

Usage example with kwargs

kwargs: GetProvisionedProductOutputsInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.get_provisioned_product_outputs(**kwargs)

1. See GetProvisionedProductOutputsInputRequestTypeDef

import_as_provisioned_product

Requests the import of a resource as a Amazon Web Services Service Catalog provisioned product that is associated to a Amazon Web Services Service Catalog product and provisioning artifact.

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

Method definition

await def import_as_provisioned_product(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    ProvisionedProductName: str,
    PhysicalId: str,
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
) -> ImportAsProvisionedProductOutputTypeDef:  # (1)
    ...

1. See ImportAsProvisionedProductOutputTypeDef

Usage example with kwargs

kwargs: ImportAsProvisionedProductInputRequestTypeDef = {  # (1)
    "ProductId": ...,
    "ProvisioningArtifactId": ...,
    "ProvisionedProductName": ...,
    "PhysicalId": ...,
    "IdempotencyToken": ...,
}

parent.import_as_provisioned_product(**kwargs)

1. See ImportAsProvisionedProductInputRequestTypeDef

list_accepted_portfolio_shares

Lists all imported portfolios for which account-to-account shares were accepted by this account.

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

Method definition

await def list_accepted_portfolio_shares(
    self,
    *,
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
    PortfolioShareType: PortfolioShareTypeType = ...,  # (1)
) -> ListAcceptedPortfolioSharesOutputTypeDef:  # (2)
    ...

1. See PortfolioShareTypeType
2. See ListAcceptedPortfolioSharesOutputTypeDef

Usage example with kwargs

kwargs: ListAcceptedPortfolioSharesInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.list_accepted_portfolio_shares(**kwargs)

1. See ListAcceptedPortfolioSharesInputRequestTypeDef

list_budgets_for_resource

Lists all the budgets associated to the specified resource.

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

Method definition

await def list_budgets_for_resource(
    self,
    *,
    ResourceId: str,
    AcceptLanguage: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListBudgetsForResourceOutputTypeDef:  # (1)
    ...

1. See ListBudgetsForResourceOutputTypeDef

Usage example with kwargs

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

parent.list_budgets_for_resource(**kwargs)

1. See ListBudgetsForResourceInputRequestTypeDef

list_constraints_for_portfolio

Lists the constraints for the specified portfolio and product.

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

Method definition

await def list_constraints_for_portfolio(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    ProductId: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListConstraintsForPortfolioOutputTypeDef:  # (1)
    ...

1. See ListConstraintsForPortfolioOutputTypeDef

Usage example with kwargs

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

parent.list_constraints_for_portfolio(**kwargs)

1. See ListConstraintsForPortfolioInputRequestTypeDef

list_launch_paths

Lists the paths to the specified product.

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

Method definition

await def list_launch_paths(
    self,
    *,
    ProductId: str,
    AcceptLanguage: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListLaunchPathsOutputTypeDef:  # (1)
    ...

1. See ListLaunchPathsOutputTypeDef

Usage example with kwargs

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

parent.list_launch_paths(**kwargs)

1. See ListLaunchPathsInputRequestTypeDef

list_organization_portfolio_access

Lists the organization nodes that have access to the specified portfolio.

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

Method definition

await def list_organization_portfolio_access(
    self,
    *,
    PortfolioId: str,
    OrganizationNodeType: OrganizationNodeTypeType,  # (1)
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> ListOrganizationPortfolioAccessOutputTypeDef:  # (2)
    ...

1. See OrganizationNodeTypeType
2. See ListOrganizationPortfolioAccessOutputTypeDef

Usage example with kwargs

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

parent.list_organization_portfolio_access(**kwargs)

1. See ListOrganizationPortfolioAccessInputRequestTypeDef

list_portfolio_access

Lists the account IDs that have access to the specified portfolio.

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

Method definition

await def list_portfolio_access(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    OrganizationParentId: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> ListPortfolioAccessOutputTypeDef:  # (1)
    ...

1. See ListPortfolioAccessOutputTypeDef

Usage example with kwargs

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

parent.list_portfolio_access(**kwargs)

1. See ListPortfolioAccessInputRequestTypeDef

list_portfolios

Lists all portfolios in the catalog.

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

Method definition

await def list_portfolios(
    self,
    *,
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> ListPortfoliosOutputTypeDef:  # (1)
    ...

1. See ListPortfoliosOutputTypeDef

Usage example with kwargs

kwargs: ListPortfoliosInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.list_portfolios(**kwargs)

1. See ListPortfoliosInputRequestTypeDef

list_portfolios_for_product

Lists all portfolios that the specified product is associated with.

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

Method definition

await def list_portfolios_for_product(
    self,
    *,
    ProductId: str,
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> ListPortfoliosForProductOutputTypeDef:  # (1)
    ...

1. See ListPortfoliosForProductOutputTypeDef

Usage example with kwargs

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

parent.list_portfolios_for_product(**kwargs)

1. See ListPortfoliosForProductInputRequestTypeDef

list_principals_for_portfolio

Lists all principal ARNs associated with the specified portfolio.

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

Method definition

await def list_principals_for_portfolio(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListPrincipalsForPortfolioOutputTypeDef:  # (1)
    ...

1. See ListPrincipalsForPortfolioOutputTypeDef

Usage example with kwargs

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

parent.list_principals_for_portfolio(**kwargs)

1. See ListPrincipalsForPortfolioInputRequestTypeDef

list_provisioned_product_plans

Lists the plans for the specified provisioned product or all plans to which the user has access.

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

Method definition

await def list_provisioned_product_plans(
    self,
    *,
    AcceptLanguage: str = ...,
    ProvisionProductId: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
    AccessLevelFilter: AccessLevelFilterTypeDef = ...,  # (1)
) -> ListProvisionedProductPlansOutputTypeDef:  # (2)
    ...

1. See AccessLevelFilterTypeDef
2. See ListProvisionedProductPlansOutputTypeDef

Usage example with kwargs

kwargs: ListProvisionedProductPlansInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.list_provisioned_product_plans(**kwargs)

1. See ListProvisionedProductPlansInputRequestTypeDef

list_provisioning_artifacts

Lists all provisioning artifacts (also known as versions) for the specified product.

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

Method definition

await def list_provisioning_artifacts(
    self,
    *,
    ProductId: str,
    AcceptLanguage: str = ...,
) -> ListProvisioningArtifactsOutputTypeDef:  # (1)
    ...

1. See ListProvisioningArtifactsOutputTypeDef

Usage example with kwargs

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

parent.list_provisioning_artifacts(**kwargs)

1. See ListProvisioningArtifactsInputRequestTypeDef

list_provisioning_artifacts_for_service_action

Lists all provisioning artifacts (also known as versions) for the specified self-service action.

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

Method definition

await def list_provisioning_artifacts_for_service_action(
    self,
    *,
    ServiceActionId: str,
    PageSize: int = ...,
    PageToken: str = ...,
    AcceptLanguage: str = ...,
) -> ListProvisioningArtifactsForServiceActionOutputTypeDef:  # (1)
    ...

1. See ListProvisioningArtifactsForServiceActionOutputTypeDef

Usage example with kwargs

kwargs: ListProvisioningArtifactsForServiceActionInputRequestTypeDef = {  # (1)
    "ServiceActionId": ...,
}

parent.list_provisioning_artifacts_for_service_action(**kwargs)

1. See ListProvisioningArtifactsForServiceActionInputRequestTypeDef

list_record_history

Lists the specified requests or all performed requests.

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

Method definition

await def list_record_history(
    self,
    *,
    AcceptLanguage: str = ...,
    AccessLevelFilter: AccessLevelFilterTypeDef = ...,  # (1)
    SearchFilter: ListRecordHistorySearchFilterTypeDef = ...,  # (2)
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListRecordHistoryOutputTypeDef:  # (3)
    ...

1. See AccessLevelFilterTypeDef
2. See ListRecordHistorySearchFilterTypeDef
3. See ListRecordHistoryOutputTypeDef

Usage example with kwargs

kwargs: ListRecordHistoryInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.list_record_history(**kwargs)

1. See ListRecordHistoryInputRequestTypeDef

list_resources_for_tag_option

Lists the resources associated with the specified TagOption.

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

Method definition

await def list_resources_for_tag_option(
    self,
    *,
    TagOptionId: str,
    ResourceType: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListResourcesForTagOptionOutputTypeDef:  # (1)
    ...

1. See ListResourcesForTagOptionOutputTypeDef

Usage example with kwargs

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

parent.list_resources_for_tag_option(**kwargs)

1. See ListResourcesForTagOptionInputRequestTypeDef

list_service_actions

Lists all self-service actions.

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

Method definition

await def list_service_actions(
    self,
    *,
    AcceptLanguage: str = ...,
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListServiceActionsOutputTypeDef:  # (1)
    ...

1. See ListServiceActionsOutputTypeDef

Usage example with kwargs

kwargs: ListServiceActionsInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.list_service_actions(**kwargs)

1. See ListServiceActionsInputRequestTypeDef

list_service_actions_for_provisioning_artifact

Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

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

Method definition

await def list_service_actions_for_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    PageSize: int = ...,
    PageToken: str = ...,
    AcceptLanguage: str = ...,
) -> ListServiceActionsForProvisioningArtifactOutputTypeDef:  # (1)
    ...

1. See ListServiceActionsForProvisioningArtifactOutputTypeDef

Usage example with kwargs

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

parent.list_service_actions_for_provisioning_artifact(**kwargs)

1. See ListServiceActionsForProvisioningArtifactInputRequestTypeDef

list_stack_instances_for_provisioned_product

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product.

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

Method definition

await def list_stack_instances_for_provisioned_product(
    self,
    *,
    ProvisionedProductId: str,
    AcceptLanguage: str = ...,
    PageToken: str = ...,
    PageSize: int = ...,
) -> ListStackInstancesForProvisionedProductOutputTypeDef:  # (1)
    ...

1. See ListStackInstancesForProvisionedProductOutputTypeDef

Usage example with kwargs

kwargs: ListStackInstancesForProvisionedProductInputRequestTypeDef = {  # (1)
    "ProvisionedProductId": ...,
}

parent.list_stack_instances_for_provisioned_product(**kwargs)

1. See ListStackInstancesForProvisionedProductInputRequestTypeDef

list_tag_options

Lists the specified TagOptions or all TagOptions.

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

Method definition

await def list_tag_options(
    self,
    *,
    Filters: ListTagOptionsFiltersTypeDef = ...,  # (1)
    PageSize: int = ...,
    PageToken: str = ...,
) -> ListTagOptionsOutputTypeDef:  # (2)
    ...

1. See ListTagOptionsFiltersTypeDef
2. See ListTagOptionsOutputTypeDef

Usage example with kwargs

kwargs: ListTagOptionsInputRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_tag_options(**kwargs)

1. See ListTagOptionsInputRequestTypeDef

provision_product

Provisions the specified product.

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

Method definition

await def provision_product(
    self,
    *,
    ProvisionedProductName: str,
    ProvisionToken: str,
    AcceptLanguage: str = ...,
    ProductId: str = ...,
    ProductName: str = ...,
    ProvisioningArtifactId: str = ...,
    ProvisioningArtifactName: str = ...,
    PathId: str = ...,
    PathName: str = ...,
    ProvisioningParameters: Sequence[ProvisioningParameterTypeDef] = ...,  # (1)
    ProvisioningPreferences: ProvisioningPreferencesTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    NotificationArns: Sequence[str] = ...,
) -> ProvisionProductOutputTypeDef:  # (4)
    ...

1. See ProvisioningParameterTypeDef
2. See ProvisioningPreferencesTypeDef
3. See TagTypeDef
4. See ProvisionProductOutputTypeDef

Usage example with kwargs

kwargs: ProvisionProductInputRequestTypeDef = {  # (1)
    "ProvisionedProductName": ...,
    "ProvisionToken": ...,
}

parent.provision_product(**kwargs)

1. See ProvisionProductInputRequestTypeDef

reject_portfolio_share

Rejects an offer to share the specified portfolio.

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

Method definition

await def reject_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    PortfolioShareType: PortfolioShareTypeType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See PortfolioShareTypeType

Usage example with kwargs

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

parent.reject_portfolio_share(**kwargs)

1. See RejectPortfolioShareInputRequestTypeDef

scan_provisioned_products

Lists the provisioned products that are available (not terminated).

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

Method definition

await def scan_provisioned_products(
    self,
    *,
    AcceptLanguage: str = ...,
    AccessLevelFilter: AccessLevelFilterTypeDef = ...,  # (1)
    PageSize: int = ...,
    PageToken: str = ...,
) -> ScanProvisionedProductsOutputTypeDef:  # (2)
    ...

1. See AccessLevelFilterTypeDef
2. See ScanProvisionedProductsOutputTypeDef

Usage example with kwargs

kwargs: ScanProvisionedProductsInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.scan_provisioned_products(**kwargs)

1. See ScanProvisionedProductsInputRequestTypeDef

search_products

Gets information about the products to which the caller has access.

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

Method definition

await def search_products(
    self,
    *,
    AcceptLanguage: str = ...,
    Filters: Mapping[ProductViewFilterByType, Sequence[str]] = ...,  # (1)
    PageSize: int = ...,
    SortBy: ProductViewSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    PageToken: str = ...,
) -> SearchProductsOutputTypeDef:  # (4)
    ...

1. See ProductViewFilterByType
2. See ProductViewSortByType
3. See SortOrderType
4. See SearchProductsOutputTypeDef

Usage example with kwargs

kwargs: SearchProductsInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.search_products(**kwargs)

1. See SearchProductsInputRequestTypeDef

search_products_as_admin

Gets information about the products for the specified portfolio or all products.

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

Method definition

await def search_products_as_admin(
    self,
    *,
    AcceptLanguage: str = ...,
    PortfolioId: str = ...,
    Filters: Mapping[ProductViewFilterByType, Sequence[str]] = ...,  # (1)
    SortBy: ProductViewSortByType = ...,  # (2)
    SortOrder: SortOrderType = ...,  # (3)
    PageToken: str = ...,
    PageSize: int = ...,
    ProductSource: ProductSourceType = ...,  # (4)
) -> SearchProductsAsAdminOutputTypeDef:  # (5)
    ...

1. See ProductViewFilterByType
2. See ProductViewSortByType
3. See SortOrderType
4. See ProductSourceType
5. See SearchProductsAsAdminOutputTypeDef

Usage example with kwargs

kwargs: SearchProductsAsAdminInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.search_products_as_admin(**kwargs)

1. See SearchProductsAsAdminInputRequestTypeDef

search_provisioned_products

Gets information about the provisioned products that meet the specified criteria.

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

Method definition

await def search_provisioned_products(
    self,
    *,
    AcceptLanguage: str = ...,
    AccessLevelFilter: AccessLevelFilterTypeDef = ...,  # (1)
    Filters: Mapping[ProvisionedProductViewFilterByType, Sequence[str]] = ...,  # (2)
    SortBy: str = ...,
    SortOrder: SortOrderType = ...,  # (3)
    PageSize: int = ...,
    PageToken: str = ...,
) -> SearchProvisionedProductsOutputTypeDef:  # (4)
    ...

1. See AccessLevelFilterTypeDef
2. See ProvisionedProductViewFilterByType
3. See SortOrderType
4. See SearchProvisionedProductsOutputTypeDef

Usage example with kwargs

kwargs: SearchProvisionedProductsInputRequestTypeDef = {  # (1)
    "AcceptLanguage": ...,
}

parent.search_provisioned_products(**kwargs)

1. See SearchProvisionedProductsInputRequestTypeDef

terminate_provisioned_product

Terminates the specified provisioned product.

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

Method definition

await def terminate_provisioned_product(
    self,
    *,
    TerminateToken: str,
    ProvisionedProductName: str = ...,
    ProvisionedProductId: str = ...,
    IgnoreErrors: bool = ...,
    AcceptLanguage: str = ...,
    RetainPhysicalResources: bool = ...,
) -> TerminateProvisionedProductOutputTypeDef:  # (1)
    ...

1. See TerminateProvisionedProductOutputTypeDef

Usage example with kwargs

kwargs: TerminateProvisionedProductInputRequestTypeDef = {  # (1)
    "TerminateToken": ...,
}

parent.terminate_provisioned_product(**kwargs)

1. See TerminateProvisionedProductInputRequestTypeDef

update_constraint

Updates the specified constraint.

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

Method definition

await def update_constraint(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
    Description: str = ...,
    Parameters: str = ...,
) -> UpdateConstraintOutputTypeDef:  # (1)
    ...

1. See UpdateConstraintOutputTypeDef

Usage example with kwargs

kwargs: UpdateConstraintInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_constraint(**kwargs)

1. See UpdateConstraintInputRequestTypeDef

update_portfolio

Updates the specified portfolio.

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

Method definition

await def update_portfolio(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
    DisplayName: str = ...,
    Description: str = ...,
    ProviderName: str = ...,
    AddTags: Sequence[TagTypeDef] = ...,  # (1)
    RemoveTags: Sequence[str] = ...,
) -> UpdatePortfolioOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See UpdatePortfolioOutputTypeDef

Usage example with kwargs

kwargs: UpdatePortfolioInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_portfolio(**kwargs)

1. See UpdatePortfolioInputRequestTypeDef

update_portfolio_share

Updates the specified portfolio share.

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

Method definition

await def update_portfolio_share(
    self,
    *,
    PortfolioId: str,
    AcceptLanguage: str = ...,
    AccountId: str = ...,
    OrganizationNode: OrganizationNodeTypeDef = ...,  # (1)
    ShareTagOptions: bool = ...,
) -> UpdatePortfolioShareOutputTypeDef:  # (2)
    ...

1. See OrganizationNodeTypeDef
2. See UpdatePortfolioShareOutputTypeDef

Usage example with kwargs

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

parent.update_portfolio_share(**kwargs)

1. See UpdatePortfolioShareInputRequestTypeDef

update_product

Updates the specified product.

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

Method definition

await def update_product(
    self,
    *,
    Id: str,
    AcceptLanguage: str = ...,
    Name: str = ...,
    Owner: str = ...,
    Description: str = ...,
    Distributor: str = ...,
    SupportDescription: str = ...,
    SupportEmail: str = ...,
    SupportUrl: str = ...,
    AddTags: Sequence[TagTypeDef] = ...,  # (1)
    RemoveTags: Sequence[str] = ...,
) -> UpdateProductOutputTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See UpdateProductOutputTypeDef

Usage example with kwargs

kwargs: UpdateProductInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_product(**kwargs)

1. See UpdateProductInputRequestTypeDef

update_provisioned_product

Requests updates to the configuration of the specified provisioned product.

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

Method definition

await def update_provisioned_product(
    self,
    *,
    UpdateToken: str,
    AcceptLanguage: str = ...,
    ProvisionedProductName: str = ...,
    ProvisionedProductId: str = ...,
    ProductId: str = ...,
    ProductName: str = ...,
    ProvisioningArtifactId: str = ...,
    ProvisioningArtifactName: str = ...,
    PathId: str = ...,
    PathName: str = ...,
    ProvisioningParameters: Sequence[UpdateProvisioningParameterTypeDef] = ...,  # (1)
    ProvisioningPreferences: UpdateProvisioningPreferencesTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> UpdateProvisionedProductOutputTypeDef:  # (4)
    ...

1. See UpdateProvisioningParameterTypeDef
2. See UpdateProvisioningPreferencesTypeDef
3. See TagTypeDef
4. See UpdateProvisionedProductOutputTypeDef

Usage example with kwargs

kwargs: UpdateProvisionedProductInputRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}

parent.update_provisioned_product(**kwargs)

1. See UpdateProvisionedProductInputRequestTypeDef

update_provisioned_product_properties

Requests updates to the properties of the specified provisioned product.

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

Method definition

await def update_provisioned_product_properties(
    self,
    *,
    ProvisionedProductId: str,
    ProvisionedProductProperties: Mapping[PropertyKeyType, str],  # (1)
    IdempotencyToken: str,
    AcceptLanguage: str = ...,
) -> UpdateProvisionedProductPropertiesOutputTypeDef:  # (2)
    ...

1. See PropertyKeyType
2. See UpdateProvisionedProductPropertiesOutputTypeDef

Usage example with kwargs

kwargs: UpdateProvisionedProductPropertiesInputRequestTypeDef = {  # (1)
    "ProvisionedProductId": ...,
    "ProvisionedProductProperties": ...,
    "IdempotencyToken": ...,
}

parent.update_provisioned_product_properties(**kwargs)

1. See UpdateProvisionedProductPropertiesInputRequestTypeDef

update_provisioning_artifact

Updates the specified provisioning artifact (also known as a version) for the specified product.

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

Method definition

await def update_provisioning_artifact(
    self,
    *,
    ProductId: str,
    ProvisioningArtifactId: str,
    AcceptLanguage: str = ...,
    Name: str = ...,
    Description: str = ...,
    Active: bool = ...,
    Guidance: ProvisioningArtifactGuidanceType = ...,  # (1)
) -> UpdateProvisioningArtifactOutputTypeDef:  # (2)
    ...

1. See ProvisioningArtifactGuidanceType
2. See UpdateProvisioningArtifactOutputTypeDef

Usage example with kwargs

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

parent.update_provisioning_artifact(**kwargs)

1. See UpdateProvisioningArtifactInputRequestTypeDef

update_service_action

Updates a self-service action.

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

Method definition

await def update_service_action(
    self,
    *,
    Id: str,
    Name: str = ...,
    Definition: Mapping[ServiceActionDefinitionKeyType, str] = ...,  # (1)
    Description: str = ...,
    AcceptLanguage: str = ...,
) -> UpdateServiceActionOutputTypeDef:  # (2)
    ...

1. See ServiceActionDefinitionKeyType
2. See UpdateServiceActionOutputTypeDef

Usage example with kwargs

kwargs: UpdateServiceActionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_service_action(**kwargs)

1. See UpdateServiceActionInputRequestTypeDef

update_tag_option

Updates the specified TagOption.

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

Method definition

await def update_tag_option(
    self,
    *,
    Id: str,
    Value: str = ...,
    Active: bool = ...,
) -> UpdateTagOptionOutputTypeDef:  # (1)
    ...

1. See UpdateTagOptionOutputTypeDef

Usage example with kwargs

kwargs: UpdateTagOptionInputRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_tag_option(**kwargs)

1. See UpdateTagOptionInputRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> ServiceCatalogClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("servicecatalog").get_paginator method with overloads.

• client.get_paginator("list_accepted_portfolio_shares") -> ListAcceptedPortfolioSharesPaginator
• client.get_paginator("list_constraints_for_portfolio") -> ListConstraintsForPortfolioPaginator
• client.get_paginator("list_launch_paths") -> ListLaunchPathsPaginator
• client.get_paginator("list_organization_portfolio_access") -> ListOrganizationPortfolioAccessPaginator
• client.get_paginator("list_portfolios") -> ListPortfoliosPaginator
• client.get_paginator("list_portfolios_for_product") -> ListPortfoliosForProductPaginator
• client.get_paginator("list_principals_for_portfolio") -> ListPrincipalsForPortfolioPaginator
• client.get_paginator("list_provisioned_product_plans") -> ListProvisionedProductPlansPaginator
• client.get_paginator("list_provisioning_artifacts_for_service_action") -> ListProvisioningArtifactsForServiceActionPaginator
• client.get_paginator("list_record_history") -> ListRecordHistoryPaginator
• client.get_paginator("list_resources_for_tag_option") -> ListResourcesForTagOptionPaginator
• client.get_paginator("list_service_actions") -> ListServiceActionsPaginator
• client.get_paginator("list_service_actions_for_provisioning_artifact") -> ListServiceActionsForProvisioningArtifactPaginator
• client.get_paginator("list_tag_options") -> ListTagOptionsPaginator
• client.get_paginator("scan_provisioned_products") -> ScanProvisionedProductsPaginator
• client.get_paginator("search_products_as_admin") -> SearchProductsAsAdminPaginator