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.

Implementation for accessing ServiceCatalog AWS Service Catalog

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ServiceCatalog.AmazonServiceCatalogClient

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

Syntax

C#
public class AmazonServiceCatalogClient : AmazonServiceClient
         IAmazonService, IAmazonServiceCatalog, IDisposable

The AmazonServiceCatalogClient type exposes the following members

Constructors

NameDescription
Public Method AmazonServiceCatalogClient()

Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonServiceCatalogClient(RegionEndpoint)

Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonServiceCatalogClient(AmazonServiceCatalogConfig)

Constructs AmazonServiceCatalogClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonServiceCatalogClient(AWSCredentials)

Constructs AmazonServiceCatalogClient with AWS Credentials

Public Method AmazonServiceCatalogClient(AWSCredentials, RegionEndpoint)

Constructs AmazonServiceCatalogClient with AWS Credentials

Public Method AmazonServiceCatalogClient(AWSCredentials, AmazonServiceCatalogConfig)

Constructs AmazonServiceCatalogClient with AWS Credentials and an AmazonServiceCatalogClient Configuration object.

Public Method AmazonServiceCatalogClient(string, string)

Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonServiceCatalogClient(string, string, RegionEndpoint)

Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonServiceCatalogClient(string, string, AmazonServiceCatalogConfig)

Constructs AmazonServiceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonServiceCatalogClient Configuration object.

Public Method AmazonServiceCatalogClient(string, string, string)

Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonServiceCatalogClient(string, string, string, RegionEndpoint)

Constructs AmazonServiceCatalogClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonServiceCatalogClient(string, string, string, AmazonServiceCatalogConfig)

Constructs AmazonServiceCatalogClient with AWS Access Key ID, AWS Secret Key and an AmazonServiceCatalogClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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 the specified 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 the specified product with the specified portfolio.

Public Method AssociateProductWithPortfolioAsync(AssociateProductWithPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the AssociateProductWithPortfolio operation.

Public Method AssociateTagOptionWithResource(AssociateTagOptionWithResourceRequest)

Associate the specified TagOption with the specified portfolio or product.

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 a product to the same account or another account. You can copy a 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 constraint.

Public Method CreateConstraintAsync(CreateConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the CreateConstraint operation.

Public Method CreatePortfolio(CreatePortfolioRequest)

Creates a portfolio.

Public Method CreatePortfolioAsync(CreatePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePortfolio operation.

Public Method CreatePortfolioShare(CreatePortfolioShareRequest)

Shares the specified portfolio with the specified account.

Public Method CreatePortfolioShareAsync(CreatePortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePortfolioShare operation.

Public Method CreateProduct(CreateProductRequest)

Creates a product.

Public Method CreateProductAsync(CreateProductRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProduct operation.

Public Method CreateProvisionedProductPlan(CreateProvisionedProductPlanRequest)

Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

Public Method CreateProvisionedProductPlanAsync(CreateProvisionedProductPlanRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProvisionedProductPlan operation.

Public Method CreateProvisioningArtifact(CreateProvisioningArtifactRequest)

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

You cannot create a provisioning artifact for a product that was shared with you.

Public Method CreateProvisioningArtifactAsync(CreateProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the CreateProvisioningArtifact operation.

Public Method CreateTagOption(CreateTagOptionRequest)

Creates a 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.

You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

Public Method DeletePortfolioAsync(DeletePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePortfolio operation.

Public Method DeletePortfolioShare(DeletePortfolioShareRequest)

Stops sharing the specified portfolio with the specified account.

Public Method DeletePortfolioShareAsync(DeletePortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePortfolioShare operation.

Public Method DeleteProduct(DeleteProductRequest)

Deletes the specified product.

You cannot delete a product if it was shared with you or is associated with a portfolio.

Public Method DeleteProductAsync(DeleteProductRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProduct operation.

Public Method DeleteProvisionedProductPlan(DeleteProvisionedProductPlanRequest)

Deletes the specified plan.

Public Method DeleteProvisionedProductPlanAsync(DeleteProvisionedProductPlanRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProvisionedProductPlan operation.

Public Method DeleteProvisioningArtifact(DeleteProvisioningArtifactRequest)

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

You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

Public Method DeleteProvisioningArtifactAsync(DeleteProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteProvisioningArtifact operation.

Public Method DeleteTagOption(DeleteTagOptionRequest)

Deletes the specified TagOption.

You cannot delete a TagOption if it is associated with a product or portfolio.

Public Method DeleteTagOptionAsync(DeleteTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTagOption operation.

Public Method DescribeConstraint(DescribeConstraintRequest)

Gets information about the specified constraint.

Public Method DescribeConstraintAsync(DescribeConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConstraint operation.

Public Method DescribeCopyProductStatus(DescribeCopyProductStatusRequest)

Gets 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)

Gets information about the specified portfolio.

Public Method DescribePortfolioAsync(DescribePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePortfolio operation.

Public Method DescribeProduct(DescribeProductRequest)

Gets information about the specified product.

Public Method DescribeProductAsAdmin(DescribeProductAsAdminRequest)

Gets information about the specified product. This operation is 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)

Gets information about the specified product.

Public Method DescribeProductViewAsync(DescribeProductViewRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProductView operation.

Public Method DescribeProvisionedProduct(DescribeProvisionedProductRequest)

Gets information about the specified provisioned product.

Public Method DescribeProvisionedProductAsync(DescribeProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisionedProduct operation.

Public Method DescribeProvisionedProductPlan(DescribeProvisionedProductPlanRequest)

Gets information about the resource changes for the specified plan.

Public Method DescribeProvisionedProductPlanAsync(DescribeProvisionedProductPlanRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisionedProductPlan operation.

Public Method DescribeProvisioningArtifact(DescribeProvisioningArtifactRequest)

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

Public Method DescribeProvisioningArtifactAsync(DescribeProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeProvisioningArtifact operation.

Public Method DescribeProvisioningParameters(DescribeProvisioningParametersRequest)

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

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 ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value". Tag the provisioned product 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)

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

Public Method DescribeRecordAsync(DescribeRecordRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeRecord operation.

Public Method DescribeTagOption(DescribeTagOptionRequest)

Gets information about the specified 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 the specified TagOption from the specified resource.

Public Method DisassociateTagOptionFromResourceAsync(DisassociateTagOptionFromResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DisassociateTagOptionFromResource operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method ExecuteProvisionedProductPlan(ExecuteProvisionedProductPlanRequest)

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

Public Method ExecuteProvisionedProductPlanAsync(ExecuteProvisionedProductPlanRequest, CancellationToken)

Initiates the asynchronous execution of the ExecuteProvisionedProductPlan operation.

Public Method ListAcceptedPortfolioShares(ListAcceptedPortfolioSharesRequest)

Lists 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)

Lists the constraints for the specified portfolio and product.

Public Method ListConstraintsForPortfolioAsync(ListConstraintsForPortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the ListConstraintsForPortfolio operation.

Public Method ListLaunchPaths(ListLaunchPathsRequest)

Lists the paths to the 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 access to 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 ListProvisionedProductPlans(ListProvisionedProductPlansRequest)

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

Public Method ListProvisionedProductPlansAsync(ListProvisionedProductPlansRequest, CancellationToken)

Initiates the asynchronous execution of the ListProvisionedProductPlans operation.

Public Method ListProvisioningArtifacts(ListProvisioningArtifactsRequest)

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

Public Method ListProvisioningArtifactsAsync(ListProvisioningArtifactsRequest, CancellationToken)

Initiates the asynchronous execution of the ListProvisioningArtifacts operation.

Public Method ListRecordHistory(ListRecordHistoryRequest)

Lists the specified requests or all performed requests.

Public Method ListRecordHistoryAsync(ListRecordHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the ListRecordHistory operation.

Public Method ListResourcesForTagOption(ListResourcesForTagOptionRequest)

Lists the resources associated with the specified TagOption.

Public Method ListResourcesForTagOptionAsync(ListResourcesForTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the ListResourcesForTagOption operation.

Public Method ListTagOptions(ListTagOptionsRequest)

Lists the specified TagOptions or all TagOptions.

Public Method ListTagOptionsAsync(ListTagOptionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTagOptions operation.

Public Method ProvisionProduct(ProvisionProductRequest)

Provisions the specified product.

A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Public Method ProvisionProductAsync(ProvisionProductRequest, CancellationToken)

Initiates the asynchronous execution of the ProvisionProduct operation.

Public Method RejectPortfolioShare(RejectPortfolioShareRequest)

Rejects an offer to share the specified portfolio.

Public Method RejectPortfolioShareAsync(RejectPortfolioShareRequest, CancellationToken)

Initiates the asynchronous execution of the RejectPortfolioShare operation.

Public Method ScanProvisionedProducts(ScanProvisionedProductsRequest)

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

To use additional filtering, see SearchProvisionedProducts.

Public Method ScanProvisionedProductsAsync(ScanProvisionedProductsRequest, CancellationToken)

Initiates the asynchronous execution of the ScanProvisionedProducts operation.

Public Method SearchProducts(SearchProductsRequest)

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

Public Method SearchProductsAsAdmin(SearchProductsAsAdminRequest)

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

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 SearchProvisionedProducts(SearchProvisionedProductsRequest)

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

Public Method SearchProvisionedProductsAsync(SearchProvisionedProductsRequest, CancellationToken)

Initiates the asynchronous execution of the SearchProvisionedProducts operation.

Public Method TerminateProvisionedProduct(TerminateProvisionedProductRequest)

Terminates the specified provisioned product.

This operation does not delete any records associated with the provisioned product.

You can check the status of this request using DescribeRecord.

Public Method TerminateProvisionedProductAsync(TerminateProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the TerminateProvisionedProduct operation.

Public Method UpdateConstraint(UpdateConstraintRequest)

Updates the specified constraint.

Public Method UpdateConstraintAsync(UpdateConstraintRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateConstraint operation.

Public Method UpdatePortfolio(UpdatePortfolioRequest)

Updates the specified portfolio.

You cannot update a product that was shared with you.

Public Method UpdatePortfolioAsync(UpdatePortfolioRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePortfolio operation.

Public Method UpdateProduct(UpdateProductRequest)

Updates the specified product.

Public Method UpdateProductAsync(UpdateProductRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProduct operation.

Public Method UpdateProvisionedProduct(UpdateProvisionedProductRequest)

Requests updates to the configuration of the specified provisioned product.

If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

You can check the status of this request using DescribeRecord.

Public Method UpdateProvisionedProductAsync(UpdateProvisionedProductRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProvisionedProduct operation.

Public Method UpdateProvisioningArtifact(UpdateProvisioningArtifactRequest)

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

You cannot update a provisioning artifact for a product that was shared with you.

Public Method UpdateProvisioningArtifactAsync(UpdateProvisioningArtifactRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateProvisioningArtifact operation.

Public Method UpdateTagOption(UpdateTagOptionRequest)

Updates the specified TagOption.

Public Method UpdateTagOptionAsync(UpdateTagOptionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateTagOption operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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