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.

Classes

NameDescription
Class AcceptPortfolioShareRequest

Container for the parameters to the AcceptPortfolioShare operation. Accepts an offer to share the specified portfolio.

Class AcceptPortfolioShareResponse

This is the response object from the AcceptPortfolioShare operation.

Class AccessLevelFilter

The access level to use to filter results.

Class AssociatePrincipalWithPortfolioRequest

Container for the parameters to the AssociatePrincipalWithPortfolio operation. Associates the specified principal ARN with the specified portfolio.

Class AssociatePrincipalWithPortfolioResponse

This is the response object from the AssociatePrincipalWithPortfolio operation.

Class AssociateProductWithPortfolioRequest

Container for the parameters to the AssociateProductWithPortfolio operation. Associates the specified product with the specified portfolio.

Class AssociateProductWithPortfolioResponse

This is the response object from the AssociateProductWithPortfolio operation.

Class AssociateTagOptionWithResourceRequest

Container for the parameters to the AssociateTagOptionWithResource operation. Associate the specified TagOption with the specified portfolio or product.

Class AssociateTagOptionWithResourceResponse

This is the response object from the AssociateTagOptionWithResource operation.

Class ConstraintDetail

Information about a constraint.

Class ConstraintSummary

Summary information about a constraint.

Class CopyProductRequest

Container for the parameters to the CopyProduct operation. 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.

Class CopyProductResponse

This is the response object from the CopyProduct operation.

Class CreateConstraintRequest

Container for the parameters to the CreateConstraint operation. Creates a constraint.

Class CreateConstraintResponse

This is the response object from the CreateConstraint operation.

Class CreatePortfolioRequest

Container for the parameters to the CreatePortfolio operation. Creates a portfolio.

Class CreatePortfolioResponse

This is the response object from the CreatePortfolio operation.

Class CreatePortfolioShareRequest

Container for the parameters to the CreatePortfolioShare operation. Shares the specified portfolio with the specified account.

Class CreatePortfolioShareResponse

This is the response object from the CreatePortfolioShare operation.

Class CreateProductRequest

Container for the parameters to the CreateProduct operation. Creates a product.

Class CreateProductResponse

This is the response object from the CreateProduct operation.

Class CreateProvisioningArtifactRequest

Container for the parameters to the CreateProvisioningArtifact operation. 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.

Class CreateProvisioningArtifactResponse

This is the response object from the CreateProvisioningArtifact operation.

Class CreateTagOptionRequest

Container for the parameters to the CreateTagOption operation. Creates a TagOption.

Class CreateTagOptionResponse

This is the response object from the CreateTagOption operation.

Class DeleteConstraintRequest

Container for the parameters to the DeleteConstraint operation. Deletes the specified constraint.

Class DeleteConstraintResponse

This is the response object from the DeleteConstraint operation.

Class DeletePortfolioRequest

Container for the parameters to the DeletePortfolio operation. 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.

Class DeletePortfolioResponse

This is the response object from the DeletePortfolio operation.

Class DeletePortfolioShareRequest

Container for the parameters to the DeletePortfolioShare operation. Stops sharing the specified portfolio with the specified account.

Class DeletePortfolioShareResponse

This is the response object from the DeletePortfolioShare operation.

Class DeleteProductRequest

Container for the parameters to the DeleteProduct operation. Deletes the specified product.

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

Class DeleteProductResponse

This is the response object from the DeleteProduct operation.

Class DeleteProvisioningArtifactRequest

Container for the parameters to the DeleteProvisioningArtifact operation. 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.

Class DeleteProvisioningArtifactResponse

This is the response object from the DeleteProvisioningArtifact operation.

Class DescribeConstraintRequest

Container for the parameters to the DescribeConstraint operation. Gets information about the specified constraint.

Class DescribeConstraintResponse

This is the response object from the DescribeConstraint operation.

Class DescribeCopyProductStatusRequest

Container for the parameters to the DescribeCopyProductStatus operation. Gets the status of the specified copy product operation.

Class DescribeCopyProductStatusResponse

This is the response object from the DescribeCopyProductStatus operation.

Class DescribePortfolioRequest

Container for the parameters to the DescribePortfolio operation. Gets information about the specified portfolio.

Class DescribePortfolioResponse

This is the response object from the DescribePortfolio operation.

Class DescribeProductAsAdminRequest

Container for the parameters to the DescribeProductAsAdmin operation. Gets information about the specified product. This operation is run with administrator access.

Class DescribeProductAsAdminResponse

This is the response object from the DescribeProductAsAdmin operation.

Class DescribeProductRequest

Container for the parameters to the DescribeProduct operation. Gets information about the specified product.

Class DescribeProductResponse

This is the response object from the DescribeProduct operation.

Class DescribeProductViewRequest

Container for the parameters to the DescribeProductView operation. Gets information about the specified product.

Class DescribeProductViewResponse

This is the response object from the DescribeProductView operation.

Class DescribeProvisionedProductRequest

Container for the parameters to the DescribeProvisionedProduct operation. Gets information about the specified provisioned product.

Class DescribeProvisionedProductResponse

This is the response object from the DescribeProvisionedProduct operation.

Class DescribeProvisioningArtifactRequest

Container for the parameters to the DescribeProvisioningArtifact operation. Gets information about the specified provisioning artifact (also known as a version) for the specified product.

Class DescribeProvisioningArtifactResponse

This is the response object from the DescribeProvisioningArtifact operation.

Class DescribeProvisioningParametersRequest

Container for the parameters to the DescribeProvisioningParameters operation. 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 will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value" and tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

Class DescribeProvisioningParametersResponse

This is the response object from the DescribeProvisioningParameters operation.

Class DescribeRecordRequest

Container for the parameters to the DescribeRecord operation. Gets information about the specified request operation.

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

Class DescribeRecordResponse

This is the response object from the DescribeRecord operation.

Class DescribeTagOptionRequest

Container for the parameters to the DescribeTagOption operation. Gets information about the specified TagOption.

Class DescribeTagOptionResponse

This is the response object from the DescribeTagOption operation.

Class DisassociatePrincipalFromPortfolioRequest

Container for the parameters to the DisassociatePrincipalFromPortfolio operation. Disassociates a previously associated principal ARN from a specified portfolio.

Class DisassociatePrincipalFromPortfolioResponse

This is the response object from the DisassociatePrincipalFromPortfolio operation.

Class DisassociateProductFromPortfolioRequest

Container for the parameters to the DisassociateProductFromPortfolio operation. Disassociates the specified product from the specified portfolio.

Class DisassociateProductFromPortfolioResponse

This is the response object from the DisassociateProductFromPortfolio operation.

Class DisassociateTagOptionFromResourceRequest

Container for the parameters to the DisassociateTagOptionFromResource operation. Disassociates the specified TagOption from the specified resource.

Class DisassociateTagOptionFromResourceResponse

This is the response object from the DisassociateTagOptionFromResource operation.

Class DuplicateResourceException

ServiceCatalog exception

Class InvalidParametersException

ServiceCatalog exception

Class InvalidStateException

ServiceCatalog exception

Class LaunchPathSummary

Summary information about a product path for a user.

Class LimitExceededException

ServiceCatalog exception

Class ListAcceptedPortfolioSharesRequest

Container for the parameters to the ListAcceptedPortfolioShares operation. Lists all portfolios for which sharing was accepted by this account.

Class ListAcceptedPortfolioSharesResponse

This is the response object from the ListAcceptedPortfolioShares operation.

Class ListConstraintsForPortfolioRequest

Container for the parameters to the ListConstraintsForPortfolio operation. Lists the constraints for the specified portfolio and product.

Class ListConstraintsForPortfolioResponse

This is the response object from the ListConstraintsForPortfolio operation.

Class ListLaunchPathsRequest

Container for the parameters to the ListLaunchPaths operation. 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.

Class ListLaunchPathsResponse

This is the response object from the ListLaunchPaths operation.

Class ListPortfolioAccessRequest

Container for the parameters to the ListPortfolioAccess operation. Lists the account IDs that have access to the specified portfolio.

Class ListPortfolioAccessResponse

This is the response object from the ListPortfolioAccess operation.

Class ListPortfoliosForProductRequest

Container for the parameters to the ListPortfoliosForProduct operation. Lists all portfolios that the specified product is associated with.

Class ListPortfoliosForProductResponse

This is the response object from the ListPortfoliosForProduct operation.

Class ListPortfoliosRequest

Container for the parameters to the ListPortfolios operation. Lists all portfolios in the catalog.

Class ListPortfoliosResponse

This is the response object from the ListPortfolios operation.

Class ListPrincipalsForPortfolioRequest

Container for the parameters to the ListPrincipalsForPortfolio operation. Lists all principal ARNs associated with the specified portfolio.

Class ListPrincipalsForPortfolioResponse

This is the response object from the ListPrincipalsForPortfolio operation.

Class ListProvisioningArtifactsRequest

Container for the parameters to the ListProvisioningArtifacts operation. Lists all provisioning artifacts (also known as versions) for the specified product.

Class ListProvisioningArtifactsResponse

This is the response object from the ListProvisioningArtifacts operation.

Class ListRecordHistoryRequest

Container for the parameters to the ListRecordHistory operation. Lists the specified requests or all performed requests.

Class ListRecordHistoryResponse

This is the response object from the ListRecordHistory operation.

Class ListRecordHistorySearchFilter

The search filter to use when listing history records.

Class ListResourcesForTagOptionRequest

Container for the parameters to the ListResourcesForTagOption operation. Lists the resources associated with the specified TagOption.

Class ListResourcesForTagOptionResponse

This is the response object from the ListResourcesForTagOption operation.

Class ListTagOptionsFilters

Filters to use when listing TagOptions.

Class ListTagOptionsRequest

Container for the parameters to the ListTagOptions operation. Lists the specified TagOptions or all TagOptions.

Class ListTagOptionsResponse

This is the response object from the ListTagOptions operation.

Class ParameterConstraints

The constraints that the administrator has put on the parameter.

Class PortfolioDetail

Information about a portfolio.

Class Principal

Information about a principal.

Class ProductViewAggregationValue

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

Class ProductViewDetail

Information about a product view.

Class ProductViewSummary

Summary information about a product view.

Class ProvisionedProductDetail

Information about a provisioned product.

Class ProvisioningArtifact

Information about a provisioning artifact. A provisioning artifact is also known as a product version.

Class ProvisioningArtifactDetail

Information about a provisioning artifact (also known as a version) for a product.

Class ProvisioningArtifactParameter

Information about a parameter used to provision a product.

Class ProvisioningArtifactProperties

Information about a provisioning artifact (also known as a version) for a product.

Class ProvisioningArtifactSummary

Summary information about a provisioning artifact (also known as a version) for a product.

Class ProvisioningParameter

Information about a parameter used to provision a product.

Class ProvisionProductRequest

Container for the parameters to the ProvisionProduct operation. 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 will cause the error "Parameter validation failed: Missing required parameter in Tags[N]:Value".

Class ProvisionProductResponse

This is the response object from the ProvisionProduct operation.

Class RecordDetail

Information about a request operation.

Class RecordError

The error code and description resulting from an operation.

Class RecordOutput

The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

Class RecordTag

A tag associated with the record, stored as a key-value pair.

Class RejectPortfolioShareRequest

Container for the parameters to the RejectPortfolioShare operation. Rejects an offer to share the specified portfolio.

Class RejectPortfolioShareResponse

This is the response object from the RejectPortfolioShare operation.

Class ResourceDetail

Information about a resource.

Class ResourceInUseException

ServiceCatalog exception

Class ResourceNotFoundException

ServiceCatalog exception

Class ScanProvisionedProductsRequest

Container for the parameters to the ScanProvisionedProducts operation. Lists the provisioned products that are available (not terminated).

Class ScanProvisionedProductsResponse

This is the response object from the ScanProvisionedProducts operation.

Class SearchProductsAsAdminRequest

Container for the parameters to the SearchProductsAsAdmin operation. Gets information about the products for the specified portfolio or all products.

Class SearchProductsAsAdminResponse

This is the response object from the SearchProductsAsAdmin operation.

Class SearchProductsRequest

Container for the parameters to the SearchProducts operation. Gets information about the products to which the caller has access.

Class SearchProductsResponse

This is the response object from the SearchProducts operation.

Class Tag

Information about a tag. A tag is a key-value pair. Tags are entirely discretionary and are propagated to the resources created when provisioning a product.

Class TagOptionDetail

Information about a TagOption.

Class TagOptionNotMigratedException

ServiceCatalog exception

Class TagOptionSummary

Summary information about a TagOption.

Class TerminateProvisionedProductRequest

Container for the parameters to the TerminateProvisionedProduct operation. 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.

Class TerminateProvisionedProductResponse

This is the response object from the TerminateProvisionedProduct operation.

Class UpdateConstraintRequest

Container for the parameters to the UpdateConstraint operation. Updates the specified constraint.

Class UpdateConstraintResponse

This is the response object from the UpdateConstraint operation.

Class UpdatePortfolioRequest

Container for the parameters to the UpdatePortfolio operation. Updates the specified portfolio.

You cannot update a product that was shared with you.

Class UpdatePortfolioResponse

This is the response object from the UpdatePortfolio operation.

Class UpdateProductRequest

Container for the parameters to the UpdateProduct operation. Updates the specified product.

Class UpdateProductResponse

This is the response object from the UpdateProduct operation.

Class UpdateProvisionedProductRequest

Container for the parameters to the UpdateProvisionedProduct operation. 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.

Class UpdateProvisionedProductResponse

This is the response object from the UpdateProvisionedProduct operation.

Class UpdateProvisioningArtifactRequest

Container for the parameters to the UpdateProvisioningArtifact operation. 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.

Class UpdateProvisioningArtifactResponse

This is the response object from the UpdateProvisioningArtifact operation.

Class UpdateProvisioningParameter

The parameter key-value pair used to update a provisioned product.

Class UpdateTagOptionRequest

Container for the parameters to the UpdateTagOption operation. Updates the specified TagOption.

Class UpdateTagOptionResponse

This is the response object from the UpdateTagOption operation.

Class UsageInstruction

Additional information provided by the administrator.