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]:
...
# accept_portfolio_share method usage example with argument unpacking
kwargs: AcceptPortfolioShareInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.accept_portfolio_share(**kwargs)
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)
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]:
...
# associate_principal_with_portfolio method usage example with argument unpacking
kwargs: AssociatePrincipalWithPortfolioInputRequestTypeDef = { # (1)
"PortfolioId": ...,
"PrincipalARN": ...,
"PrincipalType": ...,
}
parent.associate_principal_with_portfolio(**kwargs)
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)
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)
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)
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)
...
- See ServiceActionAssociationTypeDef
- 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)
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)
...
- See ServiceActionAssociationTypeDef
- 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)
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.
boto3 documentation
# close method definition
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 boto3.client("servicecatalog").copy_product
method.
boto3 documentation
# copy_product method definition
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)
...
# copy_product method usage example with argument unpacking
kwargs: CopyProductInputRequestTypeDef = { # (1)
"SourceProductArn": ...,
"IdempotencyToken": ...,
}
parent.copy_product(**kwargs)
create_constraint#
Creates a constraint.
Type annotations and code completion for boto3.client("servicecatalog").create_constraint
method.
boto3 documentation
# create_constraint method definition
def create_constraint(
self,
*,
PortfolioId: str,
ProductId: str,
Parameters: str,
Type: str,
IdempotencyToken: str,
AcceptLanguage: str = ...,
Description: str = ...,
) -> CreateConstraintOutputTypeDef: # (1)
...
# create_constraint method usage example with argument unpacking
kwargs: CreateConstraintInputRequestTypeDef = { # (1)
"PortfolioId": ...,
"ProductId": ...,
"Parameters": ...,
"Type": ...,
"IdempotencyToken": ...,
}
parent.create_constraint(**kwargs)
create_portfolio#
Creates a portfolio.
Type annotations and code completion for boto3.client("servicecatalog").create_portfolio
method.
boto3 documentation
# create_portfolio method definition
def create_portfolio(
self,
*,
DisplayName: str,
ProviderName: str,
IdempotencyToken: str,
AcceptLanguage: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreatePortfolioOutputTypeDef: # (2)
...
# create_portfolio method usage example with argument unpacking
kwargs: CreatePortfolioInputRequestTypeDef = { # (1)
"DisplayName": ...,
"ProviderName": ...,
"IdempotencyToken": ...,
}
parent.create_portfolio(**kwargs)
create_portfolio_share#
Shares the specified portfolio with the specified account or organization node.
Type annotations and code completion for boto3.client("servicecatalog").create_portfolio_share
method.
boto3 documentation
# create_portfolio_share method definition
def create_portfolio_share(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
AccountId: str = ...,
OrganizationNode: OrganizationNodeTypeDef = ..., # (1)
ShareTagOptions: bool = ...,
SharePrincipals: bool = ...,
) -> CreatePortfolioShareOutputTypeDef: # (2)
...
# create_portfolio_share method usage example with argument unpacking
kwargs: CreatePortfolioShareInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.create_portfolio_share(**kwargs)
create_product#
Creates a product.
Type annotations and code completion for boto3.client("servicecatalog").create_product
method.
boto3 documentation
# create_product method definition
def create_product(
self,
*,
Name: str,
Owner: str,
ProductType: ProductTypeType, # (1)
IdempotencyToken: str,
AcceptLanguage: str = ...,
Description: str = ...,
Distributor: str = ...,
SupportDescription: str = ...,
SupportEmail: str = ...,
SupportUrl: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ProvisioningArtifactParameters: ProvisioningArtifactPropertiesTypeDef = ..., # (3)
SourceConnection: SourceConnectionTypeDef = ..., # (4)
) -> CreateProductOutputTypeDef: # (5)
...
- See ProductTypeType
- See TagTypeDef
- See ProvisioningArtifactPropertiesTypeDef
- See SourceConnectionTypeDef
- See CreateProductOutputTypeDef
# create_product method usage example with argument unpacking
kwargs: CreateProductInputRequestTypeDef = { # (1)
"Name": ...,
"Owner": ...,
"ProductType": ...,
"IdempotencyToken": ...,
}
parent.create_product(**kwargs)
create_provisioned_product_plan#
Creates a plan.
Type annotations and code completion for boto3.client("servicecatalog").create_provisioned_product_plan
method.
boto3 documentation
# create_provisioned_product_plan method definition
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)
...
- See ProvisionedProductPlanTypeType
- See UpdateProvisioningParameterTypeDef
- See TagTypeDef
- See CreateProvisionedProductPlanOutputTypeDef
# create_provisioned_product_plan method usage example with argument unpacking
kwargs: CreateProvisionedProductPlanInputRequestTypeDef = { # (1)
"PlanName": ...,
"PlanType": ...,
"ProductId": ...,
"ProvisionedProductName": ...,
"ProvisioningArtifactId": ...,
"IdempotencyToken": ...,
}
parent.create_provisioned_product_plan(**kwargs)
create_provisioning_artifact#
Creates a provisioning artifact (also known as a version) for the specified product.
Type annotations and code completion for boto3.client("servicecatalog").create_provisioning_artifact
method.
boto3 documentation
# create_provisioning_artifact method definition
def create_provisioning_artifact(
self,
*,
ProductId: str,
Parameters: ProvisioningArtifactPropertiesTypeDef, # (1)
IdempotencyToken: str,
AcceptLanguage: str = ...,
) -> CreateProvisioningArtifactOutputTypeDef: # (2)
...
# create_provisioning_artifact method usage example with argument unpacking
kwargs: CreateProvisioningArtifactInputRequestTypeDef = { # (1)
"ProductId": ...,
"Parameters": ...,
"IdempotencyToken": ...,
}
parent.create_provisioning_artifact(**kwargs)
create_service_action#
Creates a self-service action.
Type annotations and code completion for boto3.client("servicecatalog").create_service_action
method.
boto3 documentation
# create_service_action method definition
def create_service_action(
self,
*,
Name: str,
DefinitionType: ServiceActionDefinitionTypeType, # (1)
Definition: Mapping[ServiceActionDefinitionKeyType, str], # (2)
IdempotencyToken: str,
Description: str = ...,
AcceptLanguage: str = ...,
) -> CreateServiceActionOutputTypeDef: # (3)
...
- See ServiceActionDefinitionTypeType
- See ServiceActionDefinitionKeyType
- See CreateServiceActionOutputTypeDef
# create_service_action method usage example with argument unpacking
kwargs: CreateServiceActionInputRequestTypeDef = { # (1)
"Name": ...,
"DefinitionType": ...,
"Definition": ...,
"IdempotencyToken": ...,
}
parent.create_service_action(**kwargs)
create_tag_option#
Creates a TagOption.
Type annotations and code completion for boto3.client("servicecatalog").create_tag_option
method.
boto3 documentation
# create_tag_option method definition
def create_tag_option(
self,
*,
Key: str,
Value: str,
) -> CreateTagOptionOutputTypeDef: # (1)
...
# create_tag_option method usage example with argument unpacking
kwargs: CreateTagOptionInputRequestTypeDef = { # (1)
"Key": ...,
"Value": ...,
}
parent.create_tag_option(**kwargs)
delete_constraint#
Deletes the specified constraint.
Type annotations and code completion for boto3.client("servicecatalog").delete_constraint
method.
boto3 documentation
# delete_constraint method definition
def delete_constraint(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> Dict[str, Any]:
...
# delete_constraint method usage example with argument unpacking
kwargs: DeleteConstraintInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_constraint(**kwargs)
delete_portfolio#
Deletes the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").delete_portfolio
method.
boto3 documentation
# delete_portfolio method definition
def delete_portfolio(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> Dict[str, Any]:
...
# delete_portfolio method usage example with argument unpacking
kwargs: DeletePortfolioInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_portfolio(**kwargs)
delete_portfolio_share#
Stops sharing the specified portfolio with the specified account or organization node.
Type annotations and code completion for boto3.client("servicecatalog").delete_portfolio_share
method.
boto3 documentation
# delete_portfolio_share method definition
def delete_portfolio_share(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
AccountId: str = ...,
OrganizationNode: OrganizationNodeTypeDef = ..., # (1)
) -> DeletePortfolioShareOutputTypeDef: # (2)
...
# delete_portfolio_share method usage example with argument unpacking
kwargs: DeletePortfolioShareInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.delete_portfolio_share(**kwargs)
delete_product#
Deletes the specified product.
Type annotations and code completion for boto3.client("servicecatalog").delete_product
method.
boto3 documentation
# delete_product method definition
def delete_product(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> Dict[str, Any]:
...
# delete_product method usage example with argument unpacking
kwargs: DeleteProductInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_product(**kwargs)
delete_provisioned_product_plan#
Deletes the specified plan.
Type annotations and code completion for boto3.client("servicecatalog").delete_provisioned_product_plan
method.
boto3 documentation
# delete_provisioned_product_plan method definition
def delete_provisioned_product_plan(
self,
*,
PlanId: str,
AcceptLanguage: str = ...,
IgnoreErrors: bool = ...,
) -> Dict[str, Any]:
...
# delete_provisioned_product_plan method usage example with argument unpacking
kwargs: DeleteProvisionedProductPlanInputRequestTypeDef = { # (1)
"PlanId": ...,
}
parent.delete_provisioned_product_plan(**kwargs)
delete_provisioning_artifact#
Deletes the specified provisioning artifact (also known as a version) for the specified product.
Type annotations and code completion for boto3.client("servicecatalog").delete_provisioning_artifact
method.
boto3 documentation
# delete_provisioning_artifact method definition
def delete_provisioning_artifact(
self,
*,
ProductId: str,
ProvisioningArtifactId: str,
AcceptLanguage: str = ...,
) -> Dict[str, Any]:
...
# delete_provisioning_artifact method usage example with argument unpacking
kwargs: DeleteProvisioningArtifactInputRequestTypeDef = { # (1)
"ProductId": ...,
"ProvisioningArtifactId": ...,
}
parent.delete_provisioning_artifact(**kwargs)
delete_service_action#
Deletes a self-service action.
Type annotations and code completion for boto3.client("servicecatalog").delete_service_action
method.
boto3 documentation
# delete_service_action method definition
def delete_service_action(
self,
*,
Id: str,
AcceptLanguage: str = ...,
IdempotencyToken: str = ...,
) -> Dict[str, Any]:
...
# delete_service_action method usage example with argument unpacking
kwargs: DeleteServiceActionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_service_action(**kwargs)
delete_tag_option#
Deletes the specified TagOption.
Type annotations and code completion for boto3.client("servicecatalog").delete_tag_option
method.
boto3 documentation
# delete_tag_option method definition
def delete_tag_option(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
# delete_tag_option method usage example with argument unpacking
kwargs: DeleteTagOptionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_tag_option(**kwargs)
describe_constraint#
Gets information about the specified constraint.
Type annotations and code completion for boto3.client("servicecatalog").describe_constraint
method.
boto3 documentation
# describe_constraint method definition
def describe_constraint(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> DescribeConstraintOutputTypeDef: # (1)
...
# describe_constraint method usage example with argument unpacking
kwargs: DescribeConstraintInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_constraint(**kwargs)
describe_copy_product_status#
Gets the status of the specified copy product operation.
Type annotations and code completion for boto3.client("servicecatalog").describe_copy_product_status
method.
boto3 documentation
# describe_copy_product_status method definition
def describe_copy_product_status(
self,
*,
CopyProductToken: str,
AcceptLanguage: str = ...,
) -> DescribeCopyProductStatusOutputTypeDef: # (1)
...
# describe_copy_product_status method usage example with argument unpacking
kwargs: DescribeCopyProductStatusInputRequestTypeDef = { # (1)
"CopyProductToken": ...,
}
parent.describe_copy_product_status(**kwargs)
describe_portfolio#
Gets information about the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").describe_portfolio
method.
boto3 documentation
# describe_portfolio method definition
def describe_portfolio(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> DescribePortfolioOutputTypeDef: # (1)
...
# describe_portfolio method usage example with argument unpacking
kwargs: DescribePortfolioInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_portfolio(**kwargs)
describe_portfolio_share_status#
Gets the status of the specified portfolio share operation.
Type annotations and code completion for boto3.client("servicecatalog").describe_portfolio_share_status
method.
boto3 documentation
# describe_portfolio_share_status method definition
def describe_portfolio_share_status(
self,
*,
PortfolioShareToken: str,
) -> DescribePortfolioShareStatusOutputTypeDef: # (1)
...
# describe_portfolio_share_status method usage example with argument unpacking
kwargs: DescribePortfolioShareStatusInputRequestTypeDef = { # (1)
"PortfolioShareToken": ...,
}
parent.describe_portfolio_share_status(**kwargs)
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 boto3.client("servicecatalog").describe_portfolio_shares
method.
boto3 documentation
# describe_portfolio_shares method definition
def describe_portfolio_shares(
self,
*,
PortfolioId: str,
Type: DescribePortfolioShareTypeType, # (1)
PageToken: str = ...,
PageSize: int = ...,
) -> DescribePortfolioSharesOutputTypeDef: # (2)
...
# describe_portfolio_shares method usage example with argument unpacking
kwargs: DescribePortfolioSharesInputRequestTypeDef = { # (1)
"PortfolioId": ...,
"Type": ...,
}
parent.describe_portfolio_shares(**kwargs)
describe_product#
Gets information about the specified product.
Type annotations and code completion for boto3.client("servicecatalog").describe_product
method.
boto3 documentation
# describe_product method definition
def describe_product(
self,
*,
AcceptLanguage: str = ...,
Id: str = ...,
Name: str = ...,
) -> DescribeProductOutputTypeDef: # (1)
...
# describe_product method usage example with argument unpacking
kwargs: DescribeProductInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.describe_product(**kwargs)
describe_product_as_admin#
Gets information about the specified product.
Type annotations and code completion for boto3.client("servicecatalog").describe_product_as_admin
method.
boto3 documentation
# describe_product_as_admin method definition
def describe_product_as_admin(
self,
*,
AcceptLanguage: str = ...,
Id: str = ...,
Name: str = ...,
SourcePortfolioId: str = ...,
) -> DescribeProductAsAdminOutputTypeDef: # (1)
...
# describe_product_as_admin method usage example with argument unpacking
kwargs: DescribeProductAsAdminInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.describe_product_as_admin(**kwargs)
describe_product_view#
Gets information about the specified product.
Type annotations and code completion for boto3.client("servicecatalog").describe_product_view
method.
boto3 documentation
# describe_product_view method definition
def describe_product_view(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> DescribeProductViewOutputTypeDef: # (1)
...
# describe_product_view method usage example with argument unpacking
kwargs: DescribeProductViewInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_product_view(**kwargs)
describe_provisioned_product#
Gets information about the specified provisioned product.
Type annotations and code completion for boto3.client("servicecatalog").describe_provisioned_product
method.
boto3 documentation
# describe_provisioned_product method definition
def describe_provisioned_product(
self,
*,
AcceptLanguage: str = ...,
Id: str = ...,
Name: str = ...,
) -> DescribeProvisionedProductOutputTypeDef: # (1)
...
# describe_provisioned_product method usage example with argument unpacking
kwargs: DescribeProvisionedProductInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.describe_provisioned_product(**kwargs)
describe_provisioned_product_plan#
Gets information about the resource changes for the specified plan.
Type annotations and code completion for boto3.client("servicecatalog").describe_provisioned_product_plan
method.
boto3 documentation
# describe_provisioned_product_plan method definition
def describe_provisioned_product_plan(
self,
*,
PlanId: str,
AcceptLanguage: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> DescribeProvisionedProductPlanOutputTypeDef: # (1)
...
# describe_provisioned_product_plan method usage example with argument unpacking
kwargs: DescribeProvisionedProductPlanInputRequestTypeDef = { # (1)
"PlanId": ...,
}
parent.describe_provisioned_product_plan(**kwargs)
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 boto3.client("servicecatalog").describe_provisioning_artifact
method.
boto3 documentation
# describe_provisioning_artifact method definition
def describe_provisioning_artifact(
self,
*,
AcceptLanguage: str = ...,
ProvisioningArtifactId: str = ...,
ProductId: str = ...,
ProvisioningArtifactName: str = ...,
ProductName: str = ...,
Verbose: bool = ...,
IncludeProvisioningArtifactParameters: bool = ...,
) -> DescribeProvisioningArtifactOutputTypeDef: # (1)
...
# describe_provisioning_artifact method usage example with argument unpacking
kwargs: DescribeProvisioningArtifactInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.describe_provisioning_artifact(**kwargs)
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 boto3.client("servicecatalog").describe_provisioning_parameters
method.
boto3 documentation
# describe_provisioning_parameters method definition
def describe_provisioning_parameters(
self,
*,
AcceptLanguage: str = ...,
ProductId: str = ...,
ProductName: str = ...,
ProvisioningArtifactId: str = ...,
ProvisioningArtifactName: str = ...,
PathId: str = ...,
PathName: str = ...,
) -> DescribeProvisioningParametersOutputTypeDef: # (1)
...
# describe_provisioning_parameters method usage example with argument unpacking
kwargs: DescribeProvisioningParametersInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.describe_provisioning_parameters(**kwargs)
describe_record#
Gets information about the specified request operation.
Type annotations and code completion for boto3.client("servicecatalog").describe_record
method.
boto3 documentation
# describe_record method definition
def describe_record(
self,
*,
Id: str,
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> DescribeRecordOutputTypeDef: # (1)
...
# describe_record method usage example with argument unpacking
kwargs: DescribeRecordInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_record(**kwargs)
describe_service_action#
Describes a self-service action.
Type annotations and code completion for boto3.client("servicecatalog").describe_service_action
method.
boto3 documentation
# describe_service_action method definition
def describe_service_action(
self,
*,
Id: str,
AcceptLanguage: str = ...,
) -> DescribeServiceActionOutputTypeDef: # (1)
...
# describe_service_action method usage example with argument unpacking
kwargs: DescribeServiceActionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_service_action(**kwargs)
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 boto3.client("servicecatalog").describe_service_action_execution_parameters
method.
boto3 documentation
# describe_service_action_execution_parameters method definition
def describe_service_action_execution_parameters(
self,
*,
ProvisionedProductId: str,
ServiceActionId: str,
AcceptLanguage: str = ...,
) -> DescribeServiceActionExecutionParametersOutputTypeDef: # (1)
...
# describe_service_action_execution_parameters method usage example with argument unpacking
kwargs: DescribeServiceActionExecutionParametersInputRequestTypeDef = { # (1)
"ProvisionedProductId": ...,
"ServiceActionId": ...,
}
parent.describe_service_action_execution_parameters(**kwargs)
describe_tag_option#
Gets information about the specified TagOption.
Type annotations and code completion for boto3.client("servicecatalog").describe_tag_option
method.
boto3 documentation
# describe_tag_option method definition
def describe_tag_option(
self,
*,
Id: str,
) -> DescribeTagOptionOutputTypeDef: # (1)
...
# describe_tag_option method usage example with argument unpacking
kwargs: DescribeTagOptionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_tag_option(**kwargs)
disable_aws_organizations_access#
Disable portfolio sharing through the Organizations service.
Type annotations and code completion for boto3.client("servicecatalog").disable_aws_organizations_access
method.
boto3 documentation
# disable_aws_organizations_access method definition
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 boto3.client("servicecatalog").disassociate_budget_from_resource
method.
boto3 documentation
# disassociate_budget_from_resource method definition
def disassociate_budget_from_resource(
self,
*,
BudgetName: str,
ResourceId: str,
) -> Dict[str, Any]:
...
# disassociate_budget_from_resource method usage example with argument unpacking
kwargs: DisassociateBudgetFromResourceInputRequestTypeDef = { # (1)
"BudgetName": ...,
"ResourceId": ...,
}
parent.disassociate_budget_from_resource(**kwargs)
disassociate_principal_from_portfolio#
Disassociates a previously associated principal ARN from a specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").disassociate_principal_from_portfolio
method.
boto3 documentation
# disassociate_principal_from_portfolio method definition
def disassociate_principal_from_portfolio(
self,
*,
PortfolioId: str,
PrincipalARN: str,
AcceptLanguage: str = ...,
PrincipalType: PrincipalTypeType = ..., # (1)
) -> Dict[str, Any]:
...
# disassociate_principal_from_portfolio method usage example with argument unpacking
kwargs: DisassociatePrincipalFromPortfolioInputRequestTypeDef = { # (1)
"PortfolioId": ...,
"PrincipalARN": ...,
}
parent.disassociate_principal_from_portfolio(**kwargs)
disassociate_product_from_portfolio#
Disassociates the specified product from the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").disassociate_product_from_portfolio
method.
boto3 documentation
# disassociate_product_from_portfolio method definition
def disassociate_product_from_portfolio(
self,
*,
ProductId: str,
PortfolioId: str,
AcceptLanguage: str = ...,
) -> Dict[str, Any]:
...
# disassociate_product_from_portfolio method usage example with argument unpacking
kwargs: DisassociateProductFromPortfolioInputRequestTypeDef = { # (1)
"ProductId": ...,
"PortfolioId": ...,
}
parent.disassociate_product_from_portfolio(**kwargs)
disassociate_service_action_from_provisioning_artifact#
Disassociates the specified self-service action association from the specified provisioning artifact.
Type annotations and code completion for boto3.client("servicecatalog").disassociate_service_action_from_provisioning_artifact
method.
boto3 documentation
# disassociate_service_action_from_provisioning_artifact method definition
def disassociate_service_action_from_provisioning_artifact(
self,
*,
ProductId: str,
ProvisioningArtifactId: str,
ServiceActionId: str,
AcceptLanguage: str = ...,
IdempotencyToken: str = ...,
) -> Dict[str, Any]:
...
# disassociate_service_action_from_provisioning_artifact method usage example with argument unpacking
kwargs: DisassociateServiceActionFromProvisioningArtifactInputRequestTypeDef = { # (1)
"ProductId": ...,
"ProvisioningArtifactId": ...,
"ServiceActionId": ...,
}
parent.disassociate_service_action_from_provisioning_artifact(**kwargs)
disassociate_tag_option_from_resource#
Disassociates the specified TagOption from the specified resource.
Type annotations and code completion for boto3.client("servicecatalog").disassociate_tag_option_from_resource
method.
boto3 documentation
# disassociate_tag_option_from_resource method definition
def disassociate_tag_option_from_resource(
self,
*,
ResourceId: str,
TagOptionId: str,
) -> Dict[str, Any]:
...
# disassociate_tag_option_from_resource method usage example with argument unpacking
kwargs: DisassociateTagOptionFromResourceInputRequestTypeDef = { # (1)
"ResourceId": ...,
"TagOptionId": ...,
}
parent.disassociate_tag_option_from_resource(**kwargs)
enable_aws_organizations_access#
Enable portfolio sharing feature through Organizations.
Type annotations and code completion for boto3.client("servicecatalog").enable_aws_organizations_access
method.
boto3 documentation
# enable_aws_organizations_access method definition
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 boto3.client("servicecatalog").execute_provisioned_product_plan
method.
boto3 documentation
# execute_provisioned_product_plan method definition
def execute_provisioned_product_plan(
self,
*,
PlanId: str,
IdempotencyToken: str,
AcceptLanguage: str = ...,
) -> ExecuteProvisionedProductPlanOutputTypeDef: # (1)
...
# execute_provisioned_product_plan method usage example with argument unpacking
kwargs: ExecuteProvisionedProductPlanInputRequestTypeDef = { # (1)
"PlanId": ...,
"IdempotencyToken": ...,
}
parent.execute_provisioned_product_plan(**kwargs)
execute_provisioned_product_service_action#
Executes a self-service action against a provisioned product.
Type annotations and code completion for boto3.client("servicecatalog").execute_provisioned_product_service_action
method.
boto3 documentation
# execute_provisioned_product_service_action method definition
def execute_provisioned_product_service_action(
self,
*,
ProvisionedProductId: str,
ServiceActionId: str,
ExecuteToken: str,
AcceptLanguage: str = ...,
Parameters: Mapping[str, Sequence[str]] = ...,
) -> ExecuteProvisionedProductServiceActionOutputTypeDef: # (1)
...
# execute_provisioned_product_service_action method usage example with argument unpacking
kwargs: ExecuteProvisionedProductServiceActionInputRequestTypeDef = { # (1)
"ProvisionedProductId": ...,
"ServiceActionId": ...,
"ExecuteToken": ...,
}
parent.execute_provisioned_product_service_action(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("servicecatalog").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
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 boto3.client("servicecatalog").get_aws_organizations_access_status
method.
boto3 documentation
# get_aws_organizations_access_status method definition
def get_aws_organizations_access_status(
self,
) -> GetAWSOrganizationsAccessStatusOutputTypeDef: # (1)
...
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 boto3.client("servicecatalog").get_provisioned_product_outputs
method.
boto3 documentation
# get_provisioned_product_outputs method definition
def get_provisioned_product_outputs(
self,
*,
AcceptLanguage: str = ...,
ProvisionedProductId: str = ...,
ProvisionedProductName: str = ...,
OutputKeys: Sequence[str] = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> GetProvisionedProductOutputsOutputTypeDef: # (1)
...
# get_provisioned_product_outputs method usage example with argument unpacking
kwargs: GetProvisionedProductOutputsInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.get_provisioned_product_outputs(**kwargs)
import_as_provisioned_product#
Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact.
Type annotations and code completion for boto3.client("servicecatalog").import_as_provisioned_product
method.
boto3 documentation
# import_as_provisioned_product method definition
def import_as_provisioned_product(
self,
*,
ProductId: str,
ProvisioningArtifactId: str,
ProvisionedProductName: str,
PhysicalId: str,
IdempotencyToken: str,
AcceptLanguage: str = ...,
) -> ImportAsProvisionedProductOutputTypeDef: # (1)
...
# import_as_provisioned_product method usage example with argument unpacking
kwargs: ImportAsProvisionedProductInputRequestTypeDef = { # (1)
"ProductId": ...,
"ProvisioningArtifactId": ...,
"ProvisionedProductName": ...,
"PhysicalId": ...,
"IdempotencyToken": ...,
}
parent.import_as_provisioned_product(**kwargs)
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 boto3.client("servicecatalog").list_accepted_portfolio_shares
method.
boto3 documentation
# list_accepted_portfolio_shares method definition
def list_accepted_portfolio_shares(
self,
*,
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
PortfolioShareType: PortfolioShareTypeType = ..., # (1)
) -> ListAcceptedPortfolioSharesOutputTypeDef: # (2)
...
# list_accepted_portfolio_shares method usage example with argument unpacking
kwargs: ListAcceptedPortfolioSharesInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.list_accepted_portfolio_shares(**kwargs)
list_budgets_for_resource#
Lists all the budgets associated to the specified resource.
Type annotations and code completion for boto3.client("servicecatalog").list_budgets_for_resource
method.
boto3 documentation
# list_budgets_for_resource method definition
def list_budgets_for_resource(
self,
*,
ResourceId: str,
AcceptLanguage: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListBudgetsForResourceOutputTypeDef: # (1)
...
# list_budgets_for_resource method usage example with argument unpacking
kwargs: ListBudgetsForResourceInputRequestTypeDef = { # (1)
"ResourceId": ...,
}
parent.list_budgets_for_resource(**kwargs)
list_constraints_for_portfolio#
Lists the constraints for the specified portfolio and product.
Type annotations and code completion for boto3.client("servicecatalog").list_constraints_for_portfolio
method.
boto3 documentation
# list_constraints_for_portfolio method definition
def list_constraints_for_portfolio(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
ProductId: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListConstraintsForPortfolioOutputTypeDef: # (1)
...
# list_constraints_for_portfolio method usage example with argument unpacking
kwargs: ListConstraintsForPortfolioInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.list_constraints_for_portfolio(**kwargs)
list_launch_paths#
Lists the paths to the specified product.
Type annotations and code completion for boto3.client("servicecatalog").list_launch_paths
method.
boto3 documentation
# list_launch_paths method definition
def list_launch_paths(
self,
*,
ProductId: str,
AcceptLanguage: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListLaunchPathsOutputTypeDef: # (1)
...
# list_launch_paths method usage example with argument unpacking
kwargs: ListLaunchPathsInputRequestTypeDef = { # (1)
"ProductId": ...,
}
parent.list_launch_paths(**kwargs)
list_organization_portfolio_access#
Lists the organization nodes that have access to the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").list_organization_portfolio_access
method.
boto3 documentation
# list_organization_portfolio_access method definition
def list_organization_portfolio_access(
self,
*,
PortfolioId: str,
OrganizationNodeType: OrganizationNodeTypeType, # (1)
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> ListOrganizationPortfolioAccessOutputTypeDef: # (2)
...
# list_organization_portfolio_access method usage example with argument unpacking
kwargs: ListOrganizationPortfolioAccessInputRequestTypeDef = { # (1)
"PortfolioId": ...,
"OrganizationNodeType": ...,
}
parent.list_organization_portfolio_access(**kwargs)
list_portfolio_access#
Lists the account IDs that have access to the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").list_portfolio_access
method.
boto3 documentation
# list_portfolio_access method definition
def list_portfolio_access(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
OrganizationParentId: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> ListPortfolioAccessOutputTypeDef: # (1)
...
# list_portfolio_access method usage example with argument unpacking
kwargs: ListPortfolioAccessInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.list_portfolio_access(**kwargs)
list_portfolios#
Lists all portfolios in the catalog.
Type annotations and code completion for boto3.client("servicecatalog").list_portfolios
method.
boto3 documentation
# list_portfolios method definition
def list_portfolios(
self,
*,
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> ListPortfoliosOutputTypeDef: # (1)
...
# list_portfolios method usage example with argument unpacking
kwargs: ListPortfoliosInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.list_portfolios(**kwargs)
list_portfolios_for_product#
Lists all portfolios that the specified product is associated with.
Type annotations and code completion for boto3.client("servicecatalog").list_portfolios_for_product
method.
boto3 documentation
# list_portfolios_for_product method definition
def list_portfolios_for_product(
self,
*,
ProductId: str,
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> ListPortfoliosForProductOutputTypeDef: # (1)
...
# list_portfolios_for_product method usage example with argument unpacking
kwargs: ListPortfoliosForProductInputRequestTypeDef = { # (1)
"ProductId": ...,
}
parent.list_portfolios_for_product(**kwargs)
list_principals_for_portfolio#
Lists all PrincipalARN
s and corresponding PrincipalType
s associated with
the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").list_principals_for_portfolio
method.
boto3 documentation
# list_principals_for_portfolio method definition
def list_principals_for_portfolio(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListPrincipalsForPortfolioOutputTypeDef: # (1)
...
# list_principals_for_portfolio method usage example with argument unpacking
kwargs: ListPrincipalsForPortfolioInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.list_principals_for_portfolio(**kwargs)
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 boto3.client("servicecatalog").list_provisioned_product_plans
method.
boto3 documentation
# list_provisioned_product_plans method definition
def list_provisioned_product_plans(
self,
*,
AcceptLanguage: str = ...,
ProvisionProductId: str = ...,
PageSize: int = ...,
PageToken: str = ...,
AccessLevelFilter: AccessLevelFilterTypeDef = ..., # (1)
) -> ListProvisionedProductPlansOutputTypeDef: # (2)
...
# list_provisioned_product_plans method usage example with argument unpacking
kwargs: ListProvisionedProductPlansInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.list_provisioned_product_plans(**kwargs)
list_provisioning_artifacts#
Lists all provisioning artifacts (also known as versions) for the specified product.
Type annotations and code completion for boto3.client("servicecatalog").list_provisioning_artifacts
method.
boto3 documentation
# list_provisioning_artifacts method definition
def list_provisioning_artifacts(
self,
*,
ProductId: str,
AcceptLanguage: str = ...,
) -> ListProvisioningArtifactsOutputTypeDef: # (1)
...
# list_provisioning_artifacts method usage example with argument unpacking
kwargs: ListProvisioningArtifactsInputRequestTypeDef = { # (1)
"ProductId": ...,
}
parent.list_provisioning_artifacts(**kwargs)
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 boto3.client("servicecatalog").list_provisioning_artifacts_for_service_action
method.
boto3 documentation
# list_provisioning_artifacts_for_service_action method definition
def list_provisioning_artifacts_for_service_action(
self,
*,
ServiceActionId: str,
PageSize: int = ...,
PageToken: str = ...,
AcceptLanguage: str = ...,
) -> ListProvisioningArtifactsForServiceActionOutputTypeDef: # (1)
...
# list_provisioning_artifacts_for_service_action method usage example with argument unpacking
kwargs: ListProvisioningArtifactsForServiceActionInputRequestTypeDef = { # (1)
"ServiceActionId": ...,
}
parent.list_provisioning_artifacts_for_service_action(**kwargs)
list_record_history#
Lists the specified requests or all performed requests.
Type annotations and code completion for boto3.client("servicecatalog").list_record_history
method.
boto3 documentation
# list_record_history method definition
def list_record_history(
self,
*,
AcceptLanguage: str = ...,
AccessLevelFilter: AccessLevelFilterTypeDef = ..., # (1)
SearchFilter: ListRecordHistorySearchFilterTypeDef = ..., # (2)
PageSize: int = ...,
PageToken: str = ...,
) -> ListRecordHistoryOutputTypeDef: # (3)
...
- See AccessLevelFilterTypeDef
- See ListRecordHistorySearchFilterTypeDef
- See ListRecordHistoryOutputTypeDef
# list_record_history method usage example with argument unpacking
kwargs: ListRecordHistoryInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.list_record_history(**kwargs)
list_resources_for_tag_option#
Lists the resources associated with the specified TagOption.
Type annotations and code completion for boto3.client("servicecatalog").list_resources_for_tag_option
method.
boto3 documentation
# list_resources_for_tag_option method definition
def list_resources_for_tag_option(
self,
*,
TagOptionId: str,
ResourceType: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListResourcesForTagOptionOutputTypeDef: # (1)
...
# list_resources_for_tag_option method usage example with argument unpacking
kwargs: ListResourcesForTagOptionInputRequestTypeDef = { # (1)
"TagOptionId": ...,
}
parent.list_resources_for_tag_option(**kwargs)
list_service_actions#
Lists all self-service actions.
Type annotations and code completion for boto3.client("servicecatalog").list_service_actions
method.
boto3 documentation
# list_service_actions method definition
def list_service_actions(
self,
*,
AcceptLanguage: str = ...,
PageSize: int = ...,
PageToken: str = ...,
) -> ListServiceActionsOutputTypeDef: # (1)
...
# list_service_actions method usage example with argument unpacking
kwargs: ListServiceActionsInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.list_service_actions(**kwargs)
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 boto3.client("servicecatalog").list_service_actions_for_provisioning_artifact
method.
boto3 documentation
# list_service_actions_for_provisioning_artifact method definition
def list_service_actions_for_provisioning_artifact(
self,
*,
ProductId: str,
ProvisioningArtifactId: str,
PageSize: int = ...,
PageToken: str = ...,
AcceptLanguage: str = ...,
) -> ListServiceActionsForProvisioningArtifactOutputTypeDef: # (1)
...
# list_service_actions_for_provisioning_artifact method usage example with argument unpacking
kwargs: ListServiceActionsForProvisioningArtifactInputRequestTypeDef = { # (1)
"ProductId": ...,
"ProvisioningArtifactId": ...,
}
parent.list_service_actions_for_provisioning_artifact(**kwargs)
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 boto3.client("servicecatalog").list_stack_instances_for_provisioned_product
method.
boto3 documentation
# list_stack_instances_for_provisioned_product method definition
def list_stack_instances_for_provisioned_product(
self,
*,
ProvisionedProductId: str,
AcceptLanguage: str = ...,
PageToken: str = ...,
PageSize: int = ...,
) -> ListStackInstancesForProvisionedProductOutputTypeDef: # (1)
...
# list_stack_instances_for_provisioned_product method usage example with argument unpacking
kwargs: ListStackInstancesForProvisionedProductInputRequestTypeDef = { # (1)
"ProvisionedProductId": ...,
}
parent.list_stack_instances_for_provisioned_product(**kwargs)
list_tag_options#
Lists the specified TagOptions or all TagOptions.
Type annotations and code completion for boto3.client("servicecatalog").list_tag_options
method.
boto3 documentation
# list_tag_options method definition
def list_tag_options(
self,
*,
Filters: ListTagOptionsFiltersTypeDef = ..., # (1)
PageSize: int = ...,
PageToken: str = ...,
) -> ListTagOptionsOutputTypeDef: # (2)
...
# list_tag_options method usage example with argument unpacking
kwargs: ListTagOptionsInputRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_tag_options(**kwargs)
notify_provision_product_engine_workflow_result#
Notifies the result of the provisioning engine execution.
Type annotations and code completion for boto3.client("servicecatalog").notify_provision_product_engine_workflow_result
method.
boto3 documentation
# notify_provision_product_engine_workflow_result method definition
def notify_provision_product_engine_workflow_result(
self,
*,
WorkflowToken: str,
RecordId: str,
Status: EngineWorkflowStatusType, # (1)
IdempotencyToken: str,
FailureReason: str = ...,
ResourceIdentifier: EngineWorkflowResourceIdentifierTypeDef = ..., # (2)
Outputs: Sequence[RecordOutputTypeDef] = ..., # (3)
) -> Dict[str, Any]:
...
# notify_provision_product_engine_workflow_result method usage example with argument unpacking
kwargs: NotifyProvisionProductEngineWorkflowResultInputRequestTypeDef = { # (1)
"WorkflowToken": ...,
"RecordId": ...,
"Status": ...,
"IdempotencyToken": ...,
}
parent.notify_provision_product_engine_workflow_result(**kwargs)
notify_terminate_provisioned_product_engine_workflow_result#
Notifies the result of the terminate engine execution.
Type annotations and code completion for boto3.client("servicecatalog").notify_terminate_provisioned_product_engine_workflow_result
method.
boto3 documentation
# notify_terminate_provisioned_product_engine_workflow_result method definition
def notify_terminate_provisioned_product_engine_workflow_result(
self,
*,
WorkflowToken: str,
RecordId: str,
Status: EngineWorkflowStatusType, # (1)
IdempotencyToken: str,
FailureReason: str = ...,
) -> Dict[str, Any]:
...
# notify_terminate_provisioned_product_engine_workflow_result method usage example with argument unpacking
kwargs: NotifyTerminateProvisionedProductEngineWorkflowResultInputRequestTypeDef = { # (1)
"WorkflowToken": ...,
"RecordId": ...,
"Status": ...,
"IdempotencyToken": ...,
}
parent.notify_terminate_provisioned_product_engine_workflow_result(**kwargs)
notify_update_provisioned_product_engine_workflow_result#
Notifies the result of the update engine execution.
Type annotations and code completion for boto3.client("servicecatalog").notify_update_provisioned_product_engine_workflow_result
method.
boto3 documentation
# notify_update_provisioned_product_engine_workflow_result method definition
def notify_update_provisioned_product_engine_workflow_result(
self,
*,
WorkflowToken: str,
RecordId: str,
Status: EngineWorkflowStatusType, # (1)
IdempotencyToken: str,
FailureReason: str = ...,
Outputs: Sequence[RecordOutputTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
# notify_update_provisioned_product_engine_workflow_result method usage example with argument unpacking
kwargs: NotifyUpdateProvisionedProductEngineWorkflowResultInputRequestTypeDef = { # (1)
"WorkflowToken": ...,
"RecordId": ...,
"Status": ...,
"IdempotencyToken": ...,
}
parent.notify_update_provisioned_product_engine_workflow_result(**kwargs)
provision_product#
Provisions the specified product.
Type annotations and code completion for boto3.client("servicecatalog").provision_product
method.
boto3 documentation
# provision_product method definition
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)
...
- See ProvisioningParameterTypeDef
- See ProvisioningPreferencesTypeDef
- See TagTypeDef
- See ProvisionProductOutputTypeDef
# provision_product method usage example with argument unpacking
kwargs: ProvisionProductInputRequestTypeDef = { # (1)
"ProvisionedProductName": ...,
"ProvisionToken": ...,
}
parent.provision_product(**kwargs)
reject_portfolio_share#
Rejects an offer to share the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").reject_portfolio_share
method.
boto3 documentation
# reject_portfolio_share method definition
def reject_portfolio_share(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
PortfolioShareType: PortfolioShareTypeType = ..., # (1)
) -> Dict[str, Any]:
...
# reject_portfolio_share method usage example with argument unpacking
kwargs: RejectPortfolioShareInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.reject_portfolio_share(**kwargs)
scan_provisioned_products#
Lists the provisioned products that are available (not terminated).
Type annotations and code completion for boto3.client("servicecatalog").scan_provisioned_products
method.
boto3 documentation
# scan_provisioned_products method definition
def scan_provisioned_products(
self,
*,
AcceptLanguage: str = ...,
AccessLevelFilter: AccessLevelFilterTypeDef = ..., # (1)
PageSize: int = ...,
PageToken: str = ...,
) -> ScanProvisionedProductsOutputTypeDef: # (2)
...
# scan_provisioned_products method usage example with argument unpacking
kwargs: ScanProvisionedProductsInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.scan_provisioned_products(**kwargs)
search_products#
Gets information about the products to which the caller has access.
Type annotations and code completion for boto3.client("servicecatalog").search_products
method.
boto3 documentation
# search_products method definition
def search_products(
self,
*,
AcceptLanguage: str = ...,
Filters: Mapping[ProductViewFilterByType, Sequence[str]] = ..., # (1)
PageSize: int = ...,
SortBy: ProductViewSortByType = ..., # (2)
SortOrder: SortOrderType = ..., # (3)
PageToken: str = ...,
) -> SearchProductsOutputTypeDef: # (4)
...
- See ProductViewFilterByType
- See ProductViewSortByType
- See SortOrderType
- See SearchProductsOutputTypeDef
# search_products method usage example with argument unpacking
kwargs: SearchProductsInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.search_products(**kwargs)
search_products_as_admin#
Gets information about the products for the specified portfolio or all products.
Type annotations and code completion for boto3.client("servicecatalog").search_products_as_admin
method.
boto3 documentation
# search_products_as_admin method definition
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)
...
- See ProductViewFilterByType
- See ProductViewSortByType
- See SortOrderType
- See ProductSourceType
- See SearchProductsAsAdminOutputTypeDef
# search_products_as_admin method usage example with argument unpacking
kwargs: SearchProductsAsAdminInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.search_products_as_admin(**kwargs)
search_provisioned_products#
Gets information about the provisioned products that meet the specified criteria.
Type annotations and code completion for boto3.client("servicecatalog").search_provisioned_products
method.
boto3 documentation
# search_provisioned_products method definition
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)
...
- See AccessLevelFilterTypeDef
- See ProvisionedProductViewFilterByType
- See SortOrderType
- See SearchProvisionedProductsOutputTypeDef
# search_provisioned_products method usage example with argument unpacking
kwargs: SearchProvisionedProductsInputRequestTypeDef = { # (1)
"AcceptLanguage": ...,
}
parent.search_provisioned_products(**kwargs)
terminate_provisioned_product#
Terminates the specified provisioned product.
Type annotations and code completion for boto3.client("servicecatalog").terminate_provisioned_product
method.
boto3 documentation
# terminate_provisioned_product method definition
def terminate_provisioned_product(
self,
*,
TerminateToken: str,
ProvisionedProductName: str = ...,
ProvisionedProductId: str = ...,
IgnoreErrors: bool = ...,
AcceptLanguage: str = ...,
RetainPhysicalResources: bool = ...,
) -> TerminateProvisionedProductOutputTypeDef: # (1)
...
# terminate_provisioned_product method usage example with argument unpacking
kwargs: TerminateProvisionedProductInputRequestTypeDef = { # (1)
"TerminateToken": ...,
}
parent.terminate_provisioned_product(**kwargs)
update_constraint#
Updates the specified constraint.
Type annotations and code completion for boto3.client("servicecatalog").update_constraint
method.
boto3 documentation
# update_constraint method definition
def update_constraint(
self,
*,
Id: str,
AcceptLanguage: str = ...,
Description: str = ...,
Parameters: str = ...,
) -> UpdateConstraintOutputTypeDef: # (1)
...
# update_constraint method usage example with argument unpacking
kwargs: UpdateConstraintInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_constraint(**kwargs)
update_portfolio#
Updates the specified portfolio.
Type annotations and code completion for boto3.client("servicecatalog").update_portfolio
method.
boto3 documentation
# update_portfolio method definition
def update_portfolio(
self,
*,
Id: str,
AcceptLanguage: str = ...,
DisplayName: str = ...,
Description: str = ...,
ProviderName: str = ...,
AddTags: Sequence[TagTypeDef] = ..., # (1)
RemoveTags: Sequence[str] = ...,
) -> UpdatePortfolioOutputTypeDef: # (2)
...
# update_portfolio method usage example with argument unpacking
kwargs: UpdatePortfolioInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_portfolio(**kwargs)
update_portfolio_share#
Updates the specified portfolio share.
Type annotations and code completion for boto3.client("servicecatalog").update_portfolio_share
method.
boto3 documentation
# update_portfolio_share method definition
def update_portfolio_share(
self,
*,
PortfolioId: str,
AcceptLanguage: str = ...,
AccountId: str = ...,
OrganizationNode: OrganizationNodeTypeDef = ..., # (1)
ShareTagOptions: bool = ...,
SharePrincipals: bool = ...,
) -> UpdatePortfolioShareOutputTypeDef: # (2)
...
# update_portfolio_share method usage example with argument unpacking
kwargs: UpdatePortfolioShareInputRequestTypeDef = { # (1)
"PortfolioId": ...,
}
parent.update_portfolio_share(**kwargs)
update_product#
Updates the specified product.
Type annotations and code completion for boto3.client("servicecatalog").update_product
method.
boto3 documentation
# update_product method definition
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] = ...,
SourceConnection: SourceConnectionTypeDef = ..., # (2)
) -> UpdateProductOutputTypeDef: # (3)
...
# update_product method usage example with argument unpacking
kwargs: UpdateProductInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_product(**kwargs)
update_provisioned_product#
Requests updates to the configuration of the specified provisioned product.
Type annotations and code completion for boto3.client("servicecatalog").update_provisioned_product
method.
boto3 documentation
# update_provisioned_product method definition
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)
...
- See UpdateProvisioningParameterTypeDef
- See UpdateProvisioningPreferencesTypeDef
- See TagTypeDef
- See UpdateProvisionedProductOutputTypeDef
# update_provisioned_product method usage example with argument unpacking
kwargs: UpdateProvisionedProductInputRequestTypeDef = { # (1)
"UpdateToken": ...,
}
parent.update_provisioned_product(**kwargs)
update_provisioned_product_properties#
Requests updates to the properties of the specified provisioned product.
Type annotations and code completion for boto3.client("servicecatalog").update_provisioned_product_properties
method.
boto3 documentation
# update_provisioned_product_properties method definition
def update_provisioned_product_properties(
self,
*,
ProvisionedProductId: str,
ProvisionedProductProperties: Mapping[PropertyKeyType, str], # (1)
IdempotencyToken: str,
AcceptLanguage: str = ...,
) -> UpdateProvisionedProductPropertiesOutputTypeDef: # (2)
...
# update_provisioned_product_properties method usage example with argument unpacking
kwargs: UpdateProvisionedProductPropertiesInputRequestTypeDef = { # (1)
"ProvisionedProductId": ...,
"ProvisionedProductProperties": ...,
"IdempotencyToken": ...,
}
parent.update_provisioned_product_properties(**kwargs)
update_provisioning_artifact#
Updates the specified provisioning artifact (also known as a version) for the specified product.
Type annotations and code completion for boto3.client("servicecatalog").update_provisioning_artifact
method.
boto3 documentation
# update_provisioning_artifact method definition
def update_provisioning_artifact(
self,
*,
ProductId: str,
ProvisioningArtifactId: str,
AcceptLanguage: str = ...,
Name: str = ...,
Description: str = ...,
Active: bool = ...,
Guidance: ProvisioningArtifactGuidanceType = ..., # (1)
) -> UpdateProvisioningArtifactOutputTypeDef: # (2)
...
# update_provisioning_artifact method usage example with argument unpacking
kwargs: UpdateProvisioningArtifactInputRequestTypeDef = { # (1)
"ProductId": ...,
"ProvisioningArtifactId": ...,
}
parent.update_provisioning_artifact(**kwargs)
update_service_action#
Updates a self-service action.
Type annotations and code completion for boto3.client("servicecatalog").update_service_action
method.
boto3 documentation
# update_service_action method definition
def update_service_action(
self,
*,
Id: str,
Name: str = ...,
Definition: Mapping[ServiceActionDefinitionKeyType, str] = ..., # (1)
Description: str = ...,
AcceptLanguage: str = ...,
) -> UpdateServiceActionOutputTypeDef: # (2)
...
# update_service_action method usage example with argument unpacking
kwargs: UpdateServiceActionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_service_action(**kwargs)
update_tag_option#
Updates the specified TagOption.
Type annotations and code completion for boto3.client("servicecatalog").update_tag_option
method.
boto3 documentation
# update_tag_option method definition
def update_tag_option(
self,
*,
Id: str,
Value: str = ...,
Active: bool = ...,
) -> UpdateTagOptionOutputTypeDef: # (1)
...
# update_tag_option method usage example with argument unpacking
kwargs: UpdateTagOptionInputRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_tag_option(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("servicecatalog").get_paginator
method with overloads.
client.get_paginator("list_accepted_portfolio_shares")
-> ListAcceptedPortfolioSharesPaginatorclient.get_paginator("list_constraints_for_portfolio")
-> ListConstraintsForPortfolioPaginatorclient.get_paginator("list_launch_paths")
-> ListLaunchPathsPaginatorclient.get_paginator("list_organization_portfolio_access")
-> ListOrganizationPortfolioAccessPaginatorclient.get_paginator("list_portfolios_for_product")
-> ListPortfoliosForProductPaginatorclient.get_paginator("list_portfolios")
-> ListPortfoliosPaginatorclient.get_paginator("list_principals_for_portfolio")
-> ListPrincipalsForPortfolioPaginatorclient.get_paginator("list_provisioned_product_plans")
-> ListProvisionedProductPlansPaginatorclient.get_paginator("list_provisioning_artifacts_for_service_action")
-> ListProvisioningArtifactsForServiceActionPaginatorclient.get_paginator("list_record_history")
-> ListRecordHistoryPaginatorclient.get_paginator("list_resources_for_tag_option")
-> ListResourcesForTagOptionPaginatorclient.get_paginator("list_service_actions_for_provisioning_artifact")
-> ListServiceActionsForProvisioningArtifactPaginatorclient.get_paginator("list_service_actions")
-> ListServiceActionsPaginatorclient.get_paginator("list_tag_options")
-> ListTagOptionsPaginatorclient.get_paginator("scan_provisioned_products")
-> ScanProvisionedProductsPaginatorclient.get_paginator("search_products_as_admin")
-> SearchProductsAsAdminPaginator