AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing ServiceCatalog AWS Service Catalog

Overview

AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, be familiar with the terminology discussed in AWS Service Catalog Concepts.

Additional Resources

Inheritance Hierarchy

Amazon.ServiceCatalog.IAmazonServiceCatalog

Namespace: Amazon.ServiceCatalog
Assembly: AWSSDK.ServiceCatalog.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonServiceCatalog
         IAmazonService, IDisposable

The IAmazonServiceCatalog type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AcceptPortfolioShare(AcceptPortfolioShareRequest)

Accepts an offer to share a portfolio.

Public Method AcceptPortfolioShareAsync(AcceptPortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the AcceptPortfolioShare operation.

Public Method AssociatePrincipalWithPortfolio(AssociatePrincipalWithPortfolioRequest)

Associates the specified principal ARN with the specified portfolio.

Public Method AssociatePrincipalWithPortfolioAsync(AssociatePrincipalWithPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the AssociatePrincipalWithPortfolio operation.

Public Method AssociateProductWithPortfolio(AssociateProductWithPortfolioRequest)

Associates a product with a portfolio.

Public Method AssociateProductWithPortfolioAsync(AssociateProductWithPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateProductWithPortfolio operation.

Public Method AssociateTagOptionWithResource(AssociateTagOptionWithResourceRequest)

Associate a TagOption identifier with a resource identifier.

Public Method AssociateTagOptionWithResourceAsync(AssociateTagOptionWithResourceRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateTagOptionWithResource operation.

Public Method CopyProduct(CopyProductRequest)

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

You can copy the product to the same account or another account. You can copy the product to the same region or another region.

This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

Public Method CopyProductAsync(CopyProductRequest, CancellationToken)

Initiates the asynchronous execution of the CopyProduct operation.

Public Method CreateConstraint(CreateConstraintRequest)

Creates a new constraint. For more information, see Using Constraints.

Public Method CreateConstraintAsync(CreateConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConstraint operation.

Public Method CreatePortfolio(CreatePortfolioRequest)

Creates a new portfolio.

Public Method CreatePortfolioAsync(CreatePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePortfolio operation.

Public Method CreatePortfolioShare(CreatePortfolioShareRequest)

Creates a new portfolio share.

Public Method CreatePortfolioShareAsync(CreatePortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePortfolioShare operation.

Public Method CreateProduct(CreateProductRequest)

Creates a new product.

Public Method CreateProductAsync(CreateProductRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProduct operation.

Public Method CreateProvisioningArtifact(CreateProvisioningArtifactRequest)

Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.

Public Method CreateProvisioningArtifactAsync(CreateProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProvisioningArtifact operation.

Public Method CreateTagOption(CreateTagOptionRequest)

Create a new TagOption.

Public Method CreateTagOptionAsync(CreateTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTagOption operation.

Public Method DeleteConstraint(DeleteConstraintRequest)

Deletes the specified constraint.

Public Method DeleteConstraintAsync(DeleteConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConstraint operation.

Public Method DeletePortfolio(DeletePortfolioRequest)

Deletes the specified portfolio. This operation does not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

Public Method DeletePortfolioAsync(DeletePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePortfolio operation.

Public Method DeletePortfolioShare(DeletePortfolioShareRequest)

Deletes the specified portfolio share.

Public Method DeletePortfolioShareAsync(DeletePortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePortfolioShare operation.

Public Method DeleteProduct(DeleteProductRequest)

Deletes the specified product. This operation does not work with a product that has been shared with you or is associated with a portfolio.

Public Method DeleteProductAsync(DeleteProductRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProduct operation.

Public Method DeleteProvisioningArtifact(DeleteProvisioningArtifactRequest)

Deletes the specified provisioning artifact. This operation does not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).

Public Method DeleteProvisioningArtifactAsync(DeleteProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProvisioningArtifact operation.

Public Method DescribeConstraint(DescribeConstraintRequest)

Retrieves detailed information for a specified constraint.

Public Method DescribeConstraintAsync(DescribeConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConstraint operation.

Public Method DescribeCopyProductStatus(DescribeCopyProductStatusRequest)

Describes the status of the specified copy product operation.

Public Method DescribeCopyProductStatusAsync(DescribeCopyProductStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCopyProductStatus operation.

Public Method DescribePortfolio(DescribePortfolioRequest)

Retrieves detailed information and any tags associated with the specified portfolio.

Public Method DescribePortfolioAsync(DescribePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePortfolio operation.

Public Method DescribeProduct(DescribeProductRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

Public Method DescribeProductAsAdmin(DescribeProductAsAdminRequest)

Retrieves information about a specified product, run with administrator access.

Public Method DescribeProductAsAdminAsync(DescribeProductAsAdminRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProductAsAdmin operation.

Public Method DescribeProductAsync(DescribeProductRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProduct operation.

Public Method DescribeProductView(DescribeProductViewRequest)

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

Public Method DescribeProductViewAsync(DescribeProductViewRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProductView operation.

Public Method DescribeProvisionedProduct(DescribeProvisionedProductRequest)

Retrieve detailed information about the provisioned product.

Public Method DescribeProvisionedProductAsync(DescribeProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisionedProduct operation.

Public Method DescribeProvisioningArtifact(DescribeProvisioningArtifactRequest)

Retrieves detailed information about the specified provisioning artifact.

Public Method DescribeProvisioningArtifactAsync(DescribeProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisioningArtifact operation.

Public Method DescribeProvisioningParameters(DescribeProvisioningParametersRequest)

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to the ProvisionProduct operation, do not include conflicted TagOption keys as tags. Calls to ProvisionProduct with empty TagOption values cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value ". Calls to ProvisionProduct with conflicted TagOption keys automatically tag the provisioned product with the conflicted keys with the value "sc-tagoption-conflict-portfolioId-productId".

Public Method DescribeProvisioningParametersAsync(DescribeProvisioningParametersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisioningParameters operation.

Public Method DescribeRecord(DescribeRecordRequest)

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Public Method DescribeRecordAsync(DescribeRecordRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRecord operation.

Public Method DescribeTagOption(DescribeTagOptionRequest)

Describes a TagOption.

Public Method DescribeTagOptionAsync(DescribeTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeTagOption operation.

Public Method DisassociatePrincipalFromPortfolio(DisassociatePrincipalFromPortfolioRequest)

Disassociates a previously associated principal ARN from a specified portfolio.

Public Method DisassociatePrincipalFromPortfolioAsync(DisassociatePrincipalFromPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociatePrincipalFromPortfolio operation.

Public Method DisassociateProductFromPortfolio(DisassociateProductFromPortfolioRequest)

Disassociates the specified product from the specified portfolio.

Public Method DisassociateProductFromPortfolioAsync(DisassociateProductFromPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateProductFromPortfolio operation.

Public Method DisassociateTagOptionFromResource(DisassociateTagOptionFromResourceRequest)

Disassociates a TagOption from a resource.

Public Method DisassociateTagOptionFromResourceAsync(DisassociateTagOptionFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateTagOptionFromResource operation.

Public Method ListAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest)

Lists details of all portfolios for which sharing was accepted by this account.

Public Method ListAcceptedPortfolioSharesAsync(ListAcceptedPortfolioSharesRequest, CancellationToken)

Initiates the asynchronous execution of the ListAcceptedPortfolioShares operation.

Public Method ListConstraintsForPortfolio(ListConstraintsForPortfolioRequest)

Retrieves detailed constraint information for the specified portfolio and product.

Public Method ListConstraintsForPortfolioAsync(ListConstraintsForPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the ListConstraintsForPortfolio operation.

Public Method ListLaunchPaths(ListLaunchPathsRequest)

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

Public Method ListLaunchPathsAsync(ListLaunchPathsRequest, CancellationToken)

Initiates the asynchronous execution of the ListLaunchPaths operation.

Public Method ListPortfolioAccess(ListPortfolioAccessRequest)

Lists the account IDs that have been authorized sharing of the specified portfolio.

Public Method ListPortfolioAccessAsync(ListPortfolioAccessRequest, CancellationToken)

Initiates the asynchronous execution of the ListPortfolioAccess operation.

Public Method ListPortfolios(ListPortfoliosRequest)

Lists all portfolios in the catalog.

Public Method ListPortfoliosAsync(ListPortfoliosRequest, CancellationToken)

Initiates the asynchronous execution of the ListPortfolios operation.

Public Method ListPortfoliosForProduct(ListPortfoliosForProductRequest)

Lists all portfolios that the specified product is associated with.

Public Method ListPortfoliosForProductAsync(ListPortfoliosForProductRequest, CancellationToken)

Initiates the asynchronous execution of the ListPortfoliosForProduct operation.

Public Method ListPrincipalsForPortfolio(ListPrincipalsForPortfolioRequest)

Lists all principal ARNs associated with the specified portfolio.

Public Method ListPrincipalsForPortfolioAsync(ListPrincipalsForPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the ListPrincipalsForPortfolio operation.

Public Method ListProvisioningArtifacts(ListProvisioningArtifactsRequest)

Lists all provisioning artifacts associated with the specified product.

Public Method ListProvisioningArtifactsAsync(ListProvisioningArtifactsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProvisioningArtifacts operation.

Public Method ListRecordHistory(ListRecordHistoryRequest)

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Public Method ListRecordHistoryAsync(ListRecordHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the ListRecordHistory operation.

Public Method ListResourcesForTagOption(ListResourcesForTagOptionRequest)

Lists resources associated with a TagOption.

Public Method ListResourcesForTagOptionAsync(ListResourcesForTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourcesForTagOption operation.

Public Method ListTagOptions(ListTagOptionsRequest)

Lists detailed TagOptions information.

Public Method ListTagOptionsAsync(ListTagOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagOptions operation.

Public Method ProvisionProduct(ProvisionProductRequest)

Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation. The error "Parameter validation failed: Missing required parameter in Tags[N]:Value" indicates that your request contains a tag which has a tag key but no corresponding tag value (value is empty or null). Your call may have included values returned from a DescribeProvisioningParameters call that resulted in a TagOption key with an empty list. This happens when TagOption keys are in conflict. For more information, see DescribeProvisioningParameters.

Public Method ProvisionProductAsync(ProvisionProductRequest, CancellationToken)

Initiates the asynchronous execution of the ProvisionProduct operation.

Public Method RejectPortfolioShare(RejectPortfolioShareRequest)

Rejects an offer to share a portfolio.

Public Method RejectPortfolioShareAsync(RejectPortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the RejectPortfolioShare operation.

Public Method ScanProvisionedProducts(ScanProvisionedProductsRequest)

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Public Method ScanProvisionedProductsAsync(ScanProvisionedProductsRequest, CancellationToken)

Initiates the asynchronous execution of the ScanProvisionedProducts operation.

Public Method SearchProducts(SearchProductsRequest)

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

Public Method SearchProductsAsAdmin(SearchProductsAsAdminRequest)

Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

Public Method SearchProductsAsAdminAsync(SearchProductsAsAdminRequest, CancellationToken)

Initiates the asynchronous execution of the SearchProductsAsAdmin operation.

Public Method SearchProductsAsync(SearchProductsRequest, CancellationToken)

Initiates the asynchronous execution of the SearchProducts operation.

Public Method TerminateProvisionedProduct(TerminateProvisionedProductRequest)

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

Public Method TerminateProvisionedProductAsync(TerminateProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateProvisionedProduct operation.

Public Method UpdateConstraint(UpdateConstraintRequest)

Updates an existing constraint.

Public Method UpdateConstraintAsync(UpdateConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConstraint operation.

Public Method UpdatePortfolio(UpdatePortfolioRequest)

Updates the specified portfolio's details. This operation does not work with a product that has been shared with you.

Public Method UpdatePortfolioAsync(UpdatePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePortfolio operation.

Public Method UpdateProduct(UpdateProductRequest)

Updates an existing product.

Public Method UpdateProductAsync(UpdateProductRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProduct operation.

Public Method UpdateProvisionedProduct(UpdateProvisionedProductRequest)

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

Public Method UpdateProvisionedProductAsync(UpdateProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProvisionedProduct operation.

Public Method UpdateProvisioningArtifact(UpdateProvisioningArtifactRequest)

Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.

Public Method UpdateProvisioningArtifactAsync(UpdateProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProvisioningArtifact operation.

Public Method UpdateTagOption(UpdateTagOptionRequest)

Updates an existing TagOption.

Public Method UpdateTagOptionAsync(UpdateTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTagOption operation.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms