servicecatalog/aws.sdk.kotlin.services.servicecatalog/ServiceCatalogClient

ServiceCatalogClient

interface ServiceCatalogClient : SdkClient

Service Catalog

Service Catalog enables organizations to create and manage catalogs of IT services that are approved for Amazon Web Services. To get the most out of this documentation, you should be familiar with the terminology discussed in Service Catalog Concepts.

Properties

Link copied to clipboard
abstract override val config: ServiceCatalogClient.Config

ServiceCatalogClient's configuration

Functions

Link copied to clipboard
abstract suspend fun acceptPortfolioShare(input: AcceptPortfolioShareRequest): AcceptPortfolioShareResponse

Accepts an offer to share the specified portfolio.

Link copied to clipboard
abstract suspend fun associateBudgetWithResource(input: AssociateBudgetWithResourceRequest): AssociateBudgetWithResourceResponse

Associates the specified budget with the specified resource.

Link copied to clipboard
abstract suspend fun associatePrincipalWithPortfolio(input: AssociatePrincipalWithPortfolioRequest): AssociatePrincipalWithPortfolioResponse

Associates the specified principal ARN with the specified portfolio.

Link copied to clipboard
abstract suspend fun associateProductWithPortfolio(input: AssociateProductWithPortfolioRequest): AssociateProductWithPortfolioResponse

Associates the specified product with the specified portfolio.

Link copied to clipboard
abstract suspend fun associateTagOptionWithResource(input: AssociateTagOptionWithResourceRequest): AssociateTagOptionWithResourceResponse

Associate the specified TagOption with the specified portfolio or product.

abstract suspend fun batchDisassociateServiceActionFromProvisioningArtifact(input: BatchDisassociateServiceActionFromProvisioningArtifactRequest): BatchDisassociateServiceActionFromProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun copyProduct(input: CopyProductRequest): CopyProductResponse

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

Link copied to clipboard
abstract suspend fun createConstraint(input: CreateConstraintRequest): CreateConstraintResponse

Creates a constraint.

Link copied to clipboard
abstract suspend fun createPortfolio(input: CreatePortfolioRequest): CreatePortfolioResponse

Creates a portfolio.

Link copied to clipboard
abstract suspend fun createPortfolioShare(input: CreatePortfolioShareRequest): CreatePortfolioShareResponse

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Link copied to clipboard
abstract suspend fun createProduct(input: CreateProductRequest): CreateProductResponse

Creates a product.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun createProvisioningArtifact(input: CreateProvisioningArtifactRequest): CreateProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun createServiceAction(input: CreateServiceActionRequest): CreateServiceActionResponse

Creates a self-service action.

Link copied to clipboard
abstract suspend fun createTagOption(input: CreateTagOptionRequest): CreateTagOptionResponse

Creates a TagOption.

Link copied to clipboard
abstract suspend fun deleteConstraint(input: DeleteConstraintRequest): DeleteConstraintResponse

Deletes the specified constraint.

Link copied to clipboard
abstract suspend fun deletePortfolio(input: DeletePortfolioRequest): DeletePortfolioResponse

Deletes the specified portfolio.

Link copied to clipboard
abstract suspend fun deletePortfolioShare(input: DeletePortfolioShareRequest): DeletePortfolioShareResponse

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Link copied to clipboard
abstract suspend fun deleteProduct(input: DeleteProductRequest): DeleteProductResponse

Deletes the specified product.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun deleteProvisioningArtifact(input: DeleteProvisioningArtifactRequest): DeleteProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun deleteServiceAction(input: DeleteServiceActionRequest): DeleteServiceActionResponse

Deletes a self-service action.

Link copied to clipboard
abstract suspend fun deleteTagOption(input: DeleteTagOptionRequest): DeleteTagOptionResponse

Deletes the specified TagOption.

Link copied to clipboard
abstract suspend fun describeConstraint(input: DescribeConstraintRequest): DescribeConstraintResponse

Gets information about the specified constraint.

Link copied to clipboard
abstract suspend fun describeCopyProductStatus(input: DescribeCopyProductStatusRequest): DescribeCopyProductStatusResponse

Gets the status of the specified copy product operation.

Link copied to clipboard
abstract suspend fun describePortfolio(input: DescribePortfolioRequest): DescribePortfolioResponse

Gets information about the specified portfolio.

Link copied to clipboard
abstract suspend fun describePortfolioShares(input: DescribePortfolioSharesRequest): DescribePortfolioSharesResponse

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

Link copied to clipboard
abstract suspend fun describePortfolioShareStatus(input: DescribePortfolioShareStatusRequest): DescribePortfolioShareStatusResponse

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
abstract suspend fun describeProduct(input: DescribeProductRequest = DescribeProductRequest { }): DescribeProductResponse

Gets information about the specified product.

Link copied to clipboard
abstract suspend fun describeProductAsAdmin(input: DescribeProductAsAdminRequest = DescribeProductAsAdminRequest { }): DescribeProductAsAdminResponse

Gets information about the specified product. This operation is run with administrator access.

Link copied to clipboard
abstract suspend fun describeProductView(input: DescribeProductViewRequest): DescribeProductViewResponse

Gets information about the specified product.

Link copied to clipboard
abstract suspend fun describeProvisionedProduct(input: DescribeProvisionedProductRequest = DescribeProvisionedProductRequest { }): DescribeProvisionedProductResponse

Gets information about the specified provisioned product.

Link copied to clipboard
abstract suspend fun describeProvisionedProductPlan(input: DescribeProvisionedProductPlanRequest): DescribeProvisionedProductPlanResponse

Gets information about the resource changes for the specified plan.

Link copied to clipboard
abstract suspend fun describeProvisioningArtifact(input: DescribeProvisioningArtifactRequest = DescribeProvisioningArtifactRequest { }): DescribeProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun describeProvisioningParameters(input: DescribeProvisioningParametersRequest = DescribeProvisioningParametersRequest { }): DescribeProvisioningParametersResponse

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

Link copied to clipboard
abstract suspend fun describeRecord(input: DescribeRecordRequest): DescribeRecordResponse

Gets information about the specified request operation.

Link copied to clipboard
abstract suspend fun describeServiceAction(input: DescribeServiceActionRequest): DescribeServiceActionResponse

Describes a self-service action.

Link copied to clipboard
abstract suspend fun describeServiceActionExecutionParameters(input: DescribeServiceActionExecutionParametersRequest): DescribeServiceActionExecutionParametersResponse

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.

Link copied to clipboard
abstract suspend fun describeTagOption(input: DescribeTagOptionRequest): DescribeTagOptionResponse

Gets information about the specified TagOption.

Link copied to clipboard
abstract suspend fun disableAwsOrganizationsAccess(input: DisableAwsOrganizationsAccessRequest = DisableAwsOrganizationsAccessRequest { }): DisableAwsOrganizationsAccessResponse

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

Link copied to clipboard
abstract suspend fun disassociateBudgetFromResource(input: DisassociateBudgetFromResourceRequest): DisassociateBudgetFromResourceResponse

Disassociates the specified budget from the specified resource.

Link copied to clipboard
abstract suspend fun disassociatePrincipalFromPortfolio(input: DisassociatePrincipalFromPortfolioRequest): DisassociatePrincipalFromPortfolioResponse

Disassociates a previously associated principal ARN from a specified portfolio.

Link copied to clipboard
abstract suspend fun disassociateProductFromPortfolio(input: DisassociateProductFromPortfolioRequest): DisassociateProductFromPortfolioResponse

Disassociates the specified product from the specified portfolio.

abstract suspend fun disassociateServiceActionFromProvisioningArtifact(input: DisassociateServiceActionFromProvisioningArtifactRequest): DisassociateServiceActionFromProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun disassociateTagOptionFromResource(input: DisassociateTagOptionFromResourceRequest): DisassociateTagOptionFromResourceResponse

Disassociates the specified TagOption from the specified resource.

Link copied to clipboard
abstract suspend fun enableAwsOrganizationsAccess(input: EnableAwsOrganizationsAccessRequest = EnableAwsOrganizationsAccessRequest { }): EnableAwsOrganizationsAccessResponse

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

Link copied to clipboard
abstract suspend fun executeProvisionedProductPlan(input: ExecuteProvisionedProductPlanRequest): ExecuteProvisionedProductPlanResponse

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

Link copied to clipboard
abstract suspend fun executeProvisionedProductServiceAction(input: ExecuteProvisionedProductServiceActionRequest): ExecuteProvisionedProductServiceActionResponse

Executes a self-service action against a provisioned product.

Link copied to clipboard
abstract suspend fun getAwsOrganizationsAccessStatus(input: GetAwsOrganizationsAccessStatusRequest = GetAwsOrganizationsAccessStatusRequest { }): GetAwsOrganizationsAccessStatusResponse

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
abstract suspend fun getProvisionedProductOutputs(input: GetProvisionedProductOutputsRequest = GetProvisionedProductOutputsRequest { }): GetProvisionedProductOutputsResponse

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.

Link copied to clipboard
abstract suspend fun importAsProvisionedProduct(input: ImportAsProvisionedProductRequest): ImportAsProvisionedProductResponse

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Link copied to clipboard
abstract suspend fun listAcceptedPortfolioShares(input: ListAcceptedPortfolioSharesRequest = ListAcceptedPortfolioSharesRequest { }): ListAcceptedPortfolioSharesResponse

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

Link copied to clipboard
abstract suspend fun listBudgetsForResource(input: ListBudgetsForResourceRequest): ListBudgetsForResourceResponse

Lists all the budgets associated to the specified resource.

Link copied to clipboard
abstract suspend fun listConstraintsForPortfolio(input: ListConstraintsForPortfolioRequest): ListConstraintsForPortfolioResponse

Lists the constraints for the specified portfolio and product.

Link copied to clipboard
abstract suspend fun listLaunchPaths(input: ListLaunchPathsRequest): ListLaunchPathsResponse

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

Link copied to clipboard
abstract suspend fun listOrganizationPortfolioAccess(input: ListOrganizationPortfolioAccessRequest): ListOrganizationPortfolioAccessResponse

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
abstract suspend fun listPortfolioAccess(input: ListPortfolioAccessRequest): ListPortfolioAccessResponse

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

Link copied to clipboard
abstract suspend fun listPortfolios(input: ListPortfoliosRequest = ListPortfoliosRequest { }): ListPortfoliosResponse

Lists all portfolios in the catalog.

Link copied to clipboard
abstract suspend fun listPortfoliosForProduct(input: ListPortfoliosForProductRequest): ListPortfoliosForProductResponse

Lists all portfolios that the specified product is associated with.

Link copied to clipboard
abstract suspend fun listPrincipalsForPortfolio(input: ListPrincipalsForPortfolioRequest): ListPrincipalsForPortfolioResponse

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

Link copied to clipboard
abstract suspend fun listProvisionedProductPlans(input: ListProvisionedProductPlansRequest = ListProvisionedProductPlansRequest { }): ListProvisionedProductPlansResponse

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

Link copied to clipboard
abstract suspend fun listProvisioningArtifacts(input: ListProvisioningArtifactsRequest): ListProvisioningArtifactsResponse

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

abstract suspend fun listProvisioningArtifactsForServiceAction(input: ListProvisioningArtifactsForServiceActionRequest): ListProvisioningArtifactsForServiceActionResponse

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

Link copied to clipboard
abstract suspend fun listRecordHistory(input: ListRecordHistoryRequest = ListRecordHistoryRequest { }): ListRecordHistoryResponse

Lists the specified requests or all performed requests.

Link copied to clipboard
abstract suspend fun listResourcesForTagOption(input: ListResourcesForTagOptionRequest): ListResourcesForTagOptionResponse

Lists the resources associated with the specified TagOption.

Link copied to clipboard
abstract suspend fun listServiceActions(input: ListServiceActionsRequest = ListServiceActionsRequest { }): ListServiceActionsResponse

Lists all self-service actions.

abstract suspend fun listServiceActionsForProvisioningArtifact(input: ListServiceActionsForProvisioningArtifactRequest): ListServiceActionsForProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun listStackInstancesForProvisionedProduct(input: ListStackInstancesForProvisionedProductRequest): ListStackInstancesForProvisionedProductResponse

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

Link copied to clipboard
abstract suspend fun listTagOptions(input: ListTagOptionsRequest = ListTagOptionsRequest { }): ListTagOptionsResponse

Lists the specified TagOptions or all TagOptions.

Link copied to clipboard
abstract suspend fun provisionProduct(input: ProvisionProductRequest): ProvisionProductResponse

Provisions the specified product.

Link copied to clipboard
abstract suspend fun rejectPortfolioShare(input: RejectPortfolioShareRequest): RejectPortfolioShareResponse

Rejects an offer to share the specified portfolio.

Link copied to clipboard
abstract suspend fun scanProvisionedProducts(input: ScanProvisionedProductsRequest = ScanProvisionedProductsRequest { }): ScanProvisionedProductsResponse

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

Link copied to clipboard
abstract suspend fun searchProducts(input: SearchProductsRequest = SearchProductsRequest { }): SearchProductsResponse

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

Link copied to clipboard
abstract suspend fun searchProductsAsAdmin(input: SearchProductsAsAdminRequest = SearchProductsAsAdminRequest { }): SearchProductsAsAdminResponse

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

Link copied to clipboard
abstract suspend fun searchProvisionedProducts(input: SearchProvisionedProductsRequest = SearchProvisionedProductsRequest { }): SearchProvisionedProductsResponse

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

Link copied to clipboard
abstract suspend fun terminateProvisionedProduct(input: TerminateProvisionedProductRequest): TerminateProvisionedProductResponse

Terminates the specified provisioned product.

Link copied to clipboard
abstract suspend fun updateConstraint(input: UpdateConstraintRequest): UpdateConstraintResponse

Updates the specified constraint.

Link copied to clipboard
abstract suspend fun updatePortfolio(input: UpdatePortfolioRequest): UpdatePortfolioResponse

Updates the specified portfolio.

Link copied to clipboard
abstract suspend fun updatePortfolioShare(input: UpdatePortfolioShareRequest): UpdatePortfolioShareResponse

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.

Link copied to clipboard
abstract suspend fun updateProduct(input: UpdateProductRequest): UpdateProductResponse

Updates the specified product.

Link copied to clipboard
abstract suspend fun updateProvisionedProduct(input: UpdateProvisionedProductRequest): UpdateProvisionedProductResponse

Requests updates to the configuration of the specified provisioned product.

Link copied to clipboard
abstract suspend fun updateProvisionedProductProperties(input: UpdateProvisionedProductPropertiesRequest): UpdateProvisionedProductPropertiesResponse

Requests updates to the properties of the specified provisioned product.

Link copied to clipboard
abstract suspend fun updateProvisioningArtifact(input: UpdateProvisioningArtifactRequest): UpdateProvisioningArtifactResponse

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

Link copied to clipboard
abstract suspend fun updateServiceAction(input: UpdateServiceActionRequest): UpdateServiceActionResponse

Updates a self-service action.

Link copied to clipboard
abstract suspend fun updateTagOption(input: UpdateTagOptionRequest): UpdateTagOptionResponse

Updates the specified TagOption.

Inherited functions

Link copied to clipboard
inline suspend fun ServiceCatalogClient.acceptPortfolioShare(crossinline block: AcceptPortfolioShareRequest.Builder.() -> Unit): AcceptPortfolioShareResponse

Accepts an offer to share the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.associateBudgetWithResource(crossinline block: AssociateBudgetWithResourceRequest.Builder.() -> Unit): AssociateBudgetWithResourceResponse

Associates the specified budget with the specified resource.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.associatePrincipalWithPortfolio(crossinline block: AssociatePrincipalWithPortfolioRequest.Builder.() -> Unit): AssociatePrincipalWithPortfolioResponse

Associates the specified principal ARN with the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.associateProductWithPortfolio(crossinline block: AssociateProductWithPortfolioRequest.Builder.() -> Unit): AssociateProductWithPortfolioResponse

Associates the specified product with the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.associateTagOptionWithResource(crossinline block: AssociateTagOptionWithResourceRequest.Builder.() -> Unit): AssociateTagOptionWithResourceResponse

Associate the specified TagOption with the specified portfolio or product.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ServiceCatalogClient.copyProduct(crossinline block: CopyProductRequest.Builder.() -> Unit): CopyProductResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createConstraint(crossinline block: CreateConstraintRequest.Builder.() -> Unit): CreateConstraintResponse

Creates a constraint.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createPortfolio(crossinline block: CreatePortfolioRequest.Builder.() -> Unit): CreatePortfolioResponse

Creates a portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createPortfolioShare(crossinline block: CreatePortfolioShareRequest.Builder.() -> Unit): CreatePortfolioShareResponse

Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the management account of an organization or by a delegated administrator. You can share portfolios to an organization, an organizational unit, or a specific account.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createProduct(crossinline block: CreateProductRequest.Builder.() -> Unit): CreateProductResponse

Creates a product.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.createProvisioningArtifact(crossinline block: CreateProvisioningArtifactRequest.Builder.() -> Unit): CreateProvisioningArtifactResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createServiceAction(crossinline block: CreateServiceActionRequest.Builder.() -> Unit): CreateServiceActionResponse

Creates a self-service action.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.createTagOption(crossinline block: CreateTagOptionRequest.Builder.() -> Unit): CreateTagOptionResponse

Creates a TagOption.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deleteConstraint(crossinline block: DeleteConstraintRequest.Builder.() -> Unit): DeleteConstraintResponse

Deletes the specified constraint.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deletePortfolio(crossinline block: DeletePortfolioRequest.Builder.() -> Unit): DeletePortfolioResponse

Deletes the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deletePortfolioShare(crossinline block: DeletePortfolioShareRequest.Builder.() -> Unit): DeletePortfolioShareResponse

Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the management account of an organization or by a delegated administrator.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deleteProduct(crossinline block: DeleteProductRequest.Builder.() -> Unit): DeleteProductResponse

Deletes the specified product.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.deleteProvisioningArtifact(crossinline block: DeleteProvisioningArtifactRequest.Builder.() -> Unit): DeleteProvisioningArtifactResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deleteServiceAction(crossinline block: DeleteServiceActionRequest.Builder.() -> Unit): DeleteServiceActionResponse

Deletes a self-service action.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.deleteTagOption(crossinline block: DeleteTagOptionRequest.Builder.() -> Unit): DeleteTagOptionResponse

Deletes the specified TagOption.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeConstraint(crossinline block: DescribeConstraintRequest.Builder.() -> Unit): DescribeConstraintResponse

Gets information about the specified constraint.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeCopyProductStatus(crossinline block: DescribeCopyProductStatusRequest.Builder.() -> Unit): DescribeCopyProductStatusResponse

Gets the status of the specified copy product operation.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describePortfolio(crossinline block: DescribePortfolioRequest.Builder.() -> Unit): DescribePortfolioResponse

Gets information about the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describePortfolioShares(crossinline block: DescribePortfolioSharesRequest.Builder.() -> Unit): DescribePortfolioSharesResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.describePortfolioShareStatus(crossinline block: DescribePortfolioShareStatusRequest.Builder.() -> Unit): DescribePortfolioShareStatusResponse

Gets the status of the specified portfolio share operation. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProduct(crossinline block: DescribeProductRequest.Builder.() -> Unit): DescribeProductResponse

Gets information about the specified product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProductAsAdmin(crossinline block: DescribeProductAsAdminRequest.Builder.() -> Unit): DescribeProductAsAdminResponse

Gets information about the specified product. This operation is run with administrator access.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProductView(crossinline block: DescribeProductViewRequest.Builder.() -> Unit): DescribeProductViewResponse

Gets information about the specified product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProvisionedProduct(crossinline block: DescribeProvisionedProductRequest.Builder.() -> Unit): DescribeProvisionedProductResponse

Gets information about the specified provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProvisionedProductPlan(crossinline block: DescribeProvisionedProductPlanRequest.Builder.() -> Unit): DescribeProvisionedProductPlanResponse

Gets information about the resource changes for the specified plan.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProvisioningArtifact(crossinline block: DescribeProvisioningArtifactRequest.Builder.() -> Unit): DescribeProvisioningArtifactResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeProvisioningParameters(crossinline block: DescribeProvisioningParametersRequest.Builder.() -> Unit): DescribeProvisioningParametersResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeRecord(crossinline block: DescribeRecordRequest.Builder.() -> Unit): DescribeRecordResponse

Gets information about the specified request operation.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeServiceAction(crossinline block: DescribeServiceActionRequest.Builder.() -> Unit): DescribeServiceActionResponse

Describes a self-service action.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeServiceActionExecutionParameters(crossinline block: DescribeServiceActionExecutionParametersRequest.Builder.() -> Unit): DescribeServiceActionExecutionParametersResponse

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.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.describeTagOption(crossinline block: DescribeTagOptionRequest.Builder.() -> Unit): DescribeTagOptionResponse

Gets information about the specified TagOption.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.disableAwsOrganizationsAccess(crossinline block: DisableAwsOrganizationsAccessRequest.Builder.() -> Unit): DisableAwsOrganizationsAccessResponse

Disable portfolio sharing through the Organizations service. This command will not delete your current shares, but prevents you from creating new shares throughout your organization. Current shares are not kept in sync with your organization structure if the structure changes after calling this API. Only the management account in the organization can call this API.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.disassociateBudgetFromResource(crossinline block: DisassociateBudgetFromResourceRequest.Builder.() -> Unit): DisassociateBudgetFromResourceResponse

Disassociates the specified budget from the specified resource.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.disassociatePrincipalFromPortfolio(crossinline block: DisassociatePrincipalFromPortfolioRequest.Builder.() -> Unit): DisassociatePrincipalFromPortfolioResponse

Disassociates a previously associated principal ARN from a specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.disassociateProductFromPortfolio(crossinline block: DisassociateProductFromPortfolioRequest.Builder.() -> Unit): DisassociateProductFromPortfolioResponse

Disassociates the specified product from the specified portfolio.

inline suspend fun ServiceCatalogClient.disassociateServiceActionFromProvisioningArtifact(crossinline block: DisassociateServiceActionFromProvisioningArtifactRequest.Builder.() -> Unit): DisassociateServiceActionFromProvisioningArtifactResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.disassociateTagOptionFromResource(crossinline block: DisassociateTagOptionFromResourceRequest.Builder.() -> Unit): DisassociateTagOptionFromResourceResponse

Disassociates the specified TagOption from the specified resource.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.enableAwsOrganizationsAccess(crossinline block: EnableAwsOrganizationsAccessRequest.Builder.() -> Unit): EnableAwsOrganizationsAccessResponse

Enable portfolio sharing feature through Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the management account in the organization.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.executeProvisionedProductPlan(crossinline block: ExecuteProvisionedProductPlanRequest.Builder.() -> Unit): ExecuteProvisionedProductPlanResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.executeProvisionedProductServiceAction(crossinline block: ExecuteProvisionedProductServiceActionRequest.Builder.() -> Unit): ExecuteProvisionedProductServiceActionResponse

Executes a self-service action against a provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.getAwsOrganizationsAccessStatus(crossinline block: GetAwsOrganizationsAccessStatusRequest.Builder.() -> Unit): GetAwsOrganizationsAccessStatusResponse

Get the Access Status for Organizations portfolio share feature. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.getProvisionedProductOutputs(crossinline block: GetProvisionedProductOutputsRequest.Builder.() -> Unit): GetProvisionedProductOutputsResponse

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.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.importAsProvisionedProduct(crossinline block: ImportAsProvisionedProductRequest.Builder.() -> Unit): ImportAsProvisionedProductResponse

Requests the import of a resource as an Service Catalog provisioned product that is associated to an Service Catalog product and provisioning artifact. Once imported, all supported governance actions are supported on the provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listAcceptedPortfolioShares(crossinline block: ListAcceptedPortfolioSharesRequest.Builder.() -> Unit): ListAcceptedPortfolioSharesResponse

Lists all imported portfolios for which account-to-account shares were accepted by this account. By specifying the PortfolioShareType, you can list portfolios for which organizational shares were accepted by this account.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listBudgetsForResource(crossinline block: ListBudgetsForResourceRequest.Builder.() -> Unit): ListBudgetsForResourceResponse

Lists all the budgets associated to the specified resource.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listConstraintsForPortfolio(crossinline block: ListConstraintsForPortfolioRequest.Builder.() -> Unit): ListConstraintsForPortfolioResponse

Lists the constraints for the specified portfolio and product.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listLaunchPaths(crossinline block: ListLaunchPathsRequest.Builder.() -> Unit): ListLaunchPathsResponse

Lists the paths to the specified product. A path describes how the user gets access to a specified product and is necessary when provisioning a product. A path also determines the constraints that are put on a product. A path is dependent on a specific product, porfolio, and principal.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listOrganizationPortfolioAccess(crossinline block: ListOrganizationPortfolioAccessRequest.Builder.() -> Unit): ListOrganizationPortfolioAccessResponse

Lists the organization nodes that have access to the specified portfolio. This API can only be called by the management account in the organization or by a delegated admin.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listPortfolioAccess(crossinline block: ListPortfolioAccessRequest.Builder.() -> Unit): ListPortfolioAccessResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listPortfolios(crossinline block: ListPortfoliosRequest.Builder.() -> Unit): ListPortfoliosResponse

Lists all portfolios in the catalog.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listPortfoliosForProduct(crossinline block: ListPortfoliosForProductRequest.Builder.() -> Unit): ListPortfoliosForProductResponse

Lists all portfolios that the specified product is associated with.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listPrincipalsForPortfolio(crossinline block: ListPrincipalsForPortfolioRequest.Builder.() -> Unit): ListPrincipalsForPortfolioResponse

Lists all PrincipalARNs and corresponding PrincipalTypes associated with the specified portfolio.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listProvisionedProductPlans(crossinline block: ListProvisionedProductPlansRequest.Builder.() -> Unit): ListProvisionedProductPlansResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listProvisioningArtifacts(crossinline block: ListProvisioningArtifactsRequest.Builder.() -> Unit): ListProvisioningArtifactsResponse

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

inline suspend fun ServiceCatalogClient.listProvisioningArtifactsForServiceAction(crossinline block: ListProvisioningArtifactsForServiceActionRequest.Builder.() -> Unit): ListProvisioningArtifactsForServiceActionResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listRecordHistory(crossinline block: ListRecordHistoryRequest.Builder.() -> Unit): ListRecordHistoryResponse

Lists the specified requests or all performed requests.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listResourcesForTagOption(crossinline block: ListResourcesForTagOptionRequest.Builder.() -> Unit): ListResourcesForTagOptionResponse

Lists the resources associated with the specified TagOption.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listServiceActions(crossinline block: ListServiceActionsRequest.Builder.() -> Unit): ListServiceActionsResponse

Lists all self-service actions.

inline suspend fun ServiceCatalogClient.listServiceActionsForProvisioningArtifact(crossinline block: ListServiceActionsForProvisioningArtifactRequest.Builder.() -> Unit): ListServiceActionsForProvisioningArtifactResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.listStackInstancesForProvisionedProduct(crossinline block: ListStackInstancesForProvisionedProductRequest.Builder.() -> Unit): ListStackInstancesForProvisionedProductResponse

Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.listTagOptions(crossinline block: ListTagOptionsRequest.Builder.() -> Unit): ListTagOptionsResponse

Lists the specified TagOptions or all TagOptions.

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.provisionProduct(crossinline block: ProvisionProductRequest.Builder.() -> Unit): ProvisionProductResponse

Provisions the specified product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.rejectPortfolioShare(crossinline block: RejectPortfolioShareRequest.Builder.() -> Unit): RejectPortfolioShareResponse

Rejects an offer to share the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.scanProvisionedProducts(crossinline block: ScanProvisionedProductsRequest.Builder.() -> Unit): ScanProvisionedProductsResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.searchProducts(crossinline block: SearchProductsRequest.Builder.() -> Unit): SearchProductsResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.searchProductsAsAdmin(crossinline block: SearchProductsAsAdminRequest.Builder.() -> Unit): SearchProductsAsAdminResponse

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.searchProvisionedProducts(crossinline block: SearchProvisionedProductsRequest.Builder.() -> Unit): SearchProvisionedProductsResponse

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

Link copied to clipboard
Link copied to clipboard
inline suspend fun ServiceCatalogClient.terminateProvisionedProduct(crossinline block: TerminateProvisionedProductRequest.Builder.() -> Unit): TerminateProvisionedProductResponse

Terminates the specified provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateConstraint(crossinline block: UpdateConstraintRequest.Builder.() -> Unit): UpdateConstraintResponse

Updates the specified constraint.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updatePortfolio(crossinline block: UpdatePortfolioRequest.Builder.() -> Unit): UpdatePortfolioResponse

Updates the specified portfolio.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updatePortfolioShare(crossinline block: UpdatePortfolioShareRequest.Builder.() -> Unit): UpdatePortfolioShareResponse

Updates the specified portfolio share. You can use this API to enable or disable TagOptions sharing or Principal sharing for an existing portfolio share.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateProduct(crossinline block: UpdateProductRequest.Builder.() -> Unit): UpdateProductResponse

Updates the specified product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateProvisionedProduct(crossinline block: UpdateProvisionedProductRequest.Builder.() -> Unit): UpdateProvisionedProductResponse

Requests updates to the configuration of the specified provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateProvisionedProductProperties(crossinline block: UpdateProvisionedProductPropertiesRequest.Builder.() -> Unit): UpdateProvisionedProductPropertiesResponse

Requests updates to the properties of the specified provisioned product.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateProvisioningArtifact(crossinline block: UpdateProvisioningArtifactRequest.Builder.() -> Unit): UpdateProvisioningArtifactResponse

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

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateServiceAction(crossinline block: UpdateServiceActionRequest.Builder.() -> Unit): UpdateServiceActionResponse

Updates a self-service action.

Link copied to clipboard
inline suspend fun ServiceCatalogClient.updateTagOption(crossinline block: UpdateTagOptionRequest.Builder.() -> Unit): UpdateTagOptionResponse

Updates the specified TagOption.

Link copied to clipboard
fun ServiceCatalogClient.withConfig(block: ServiceCatalogClient.Config.Builder.() -> Unit): ServiceCatalogClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.