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

Class AcceptPortfolioShareResponse

This is the response object from the AcceptPortfolioShare operation.

Class AccessLevelFilter

The access level to limit 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 a product with a portfolio.

Class AssociateProductWithPortfolioResponse

This is the response object from the AssociateProductWithPortfolio operation.

Class AssociateTagOptionWithResourceRequest

Container for the parameters to the AssociateTagOptionWithResource operation. Associate a TagOption identifier with a resource identifier.

Class AssociateTagOptionWithResourceResponse

This is the response object from the AssociateTagOptionWithResource operation.

Class ConstraintDetail

Detailed constraint information.

Class ConstraintSummary

An administrator-specified constraint to apply when provisioning a product.

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

Class CopyProductResponse

This is the response object from the CopyProduct operation.

Class CreateConstraintRequest

Container for the parameters to the CreateConstraint operation. Creates a new constraint. For more information, see Using Constraints.

Class CreateConstraintResponse

This is the response object from the CreateConstraint operation.

Class CreatePortfolioRequest

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

Class CreatePortfolioResponse

This is the response object from the CreatePortfolio operation.

Class CreatePortfolioShareRequest

Container for the parameters to the CreatePortfolioShare operation. Creates a new portfolio share.

Class CreatePortfolioShareResponse

This is the response object from the CreatePortfolioShare operation.

Class CreateProductRequest

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

Class CreateProductResponse

This is the response object from the CreateProduct operation.

Class CreateProvisioningArtifactRequest

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

Class CreateProvisioningArtifactResponse

This is the response object from the CreateProvisioningArtifact operation.

Class CreateTagOptionRequest

Container for the parameters to the CreateTagOption operation. Create a new 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. 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.

Class DeletePortfolioResponse

This is the response object from the DeletePortfolio operation.

Class DeletePortfolioShareRequest

Container for the parameters to the DeletePortfolioShare operation. Deletes the specified portfolio share.

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. This operation does not work with a product that has been 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. 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).

Class DeleteProvisioningArtifactResponse

This is the response object from the DeleteProvisioningArtifact operation.

Class DescribeConstraintRequest

Container for the parameters to the DescribeConstraint operation. Retrieves detailed information for a specified constraint.

Class DescribeConstraintResponse

This is the response object from the DescribeConstraint operation.

Class DescribeCopyProductStatusRequest

Container for the parameters to the DescribeCopyProductStatus operation. Describes 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. Retrieves detailed information and any tags associated with the specified portfolio.

Class DescribePortfolioResponse

This is the response object from the DescribePortfolio operation.

Class DescribeProductAsAdminRequest

Container for the parameters to the DescribeProductAsAdmin operation. Retrieves information about a specified product, 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. Retrieves information about a specified product.

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

Class DescribeProductResponse

This is the response object from the DescribeProduct operation.

Class DescribeProductViewRequest

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

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

Class DescribeProductViewResponse

This is the response object from the DescribeProductView operation.

Class DescribeProvisionedProductRequest

Container for the parameters to the DescribeProvisionedProduct operation. Retrieve detailed information about the provisioned product.

Class DescribeProvisionedProductResponse

This is the response object from the DescribeProvisionedProduct operation.

Class DescribeProvisioningArtifactRequest

Container for the parameters to the DescribeProvisioningArtifact operation. Retrieves detailed information about the specified provisioning artifact.

Class DescribeProvisioningArtifactResponse

This is the response object from the DescribeProvisioningArtifact operation.

Class DescribeProvisioningParametersRequest

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

Class DescribeProvisioningParametersResponse

This is the response object from the DescribeProvisioningParameters operation.

Class DescribeRecordRequest

Container for the parameters to the DescribeRecord operation. Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (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. Describes a 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 a TagOption from a 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 path for a user to have access to a specified product.

Class LimitExceededException

ServiceCatalog exception

Class ListAcceptedPortfolioSharesRequest

Container for the parameters to the ListAcceptedPortfolioShares operation. Lists details of 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. Retrieves detailed constraint information 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. 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.

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 been authorized sharing of 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 associated with the specified product.

Class ListProvisioningArtifactsResponse

This is the response object from the ListProvisioningArtifacts operation.

Class ListRecordHistoryRequest

Container for the parameters to the ListRecordHistory operation. Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

Class ListRecordHistoryResponse

This is the response object from the ListRecordHistory operation.

Class ListRecordHistorySearchFilter

The search filter to limit results when listing request history records.

Class ListResourcesForTagOptionRequest

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

Class ListResourcesForTagOptionResponse

This is the response object from the ListResourcesForTagOption operation.

Class ListTagOptionsFilters

The ListTagOptions filters.

Class ListTagOptionsRequest

Container for the parameters to the ListTagOptions operation. Lists detailed TagOptions information.

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

Detailed portfolio information.

Class Principal

A principal's ARN and type.

Class ProductViewAggregationValue

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

Class ProductViewDetail

Detailed product view information.

Class ProductViewSummary

The summary metadata about the specified product.

Class ProvisionedProductDetail

Detailed information about a ProvisionedProduct object.

Class ProvisioningArtifact

Contains information indicating the ways in which a product can be provisioned.

Class ProvisioningArtifactDetail

Detailed provisioning artifact information.

Class ProvisioningArtifactParameter

A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.

Class ProvisioningArtifactProperties

Provisioning artifact properties. For example request JSON, see CreateProvisioningArtifact.

Class ProvisioningArtifactSummary

Stores summary information about a provisioning artifact.

Class ProvisioningParameter

The parameter key-value pairs used to provision a product.

Class ProvisionProductRequest

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

Class ProvisionProductResponse

This is the response object from the ProvisionProduct operation.

Class RecordDetail

The full details of a specific ProvisionedProduct object.

Class RecordError

The error code and description resulting from an operation.

Class RecordOutput

An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for 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 a portfolio.

Class RejectPortfolioShareResponse

This is the response object from the RejectPortfolioShare operation.

Class ResourceDetail

Detailed resource information.

Class ResourceInUseException

ServiceCatalog exception

Class ResourceNotFoundException

ServiceCatalog exception

Class ScanProvisionedProductsRequest

Container for the parameters to the ScanProvisionedProducts operation. Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

Class ScanProvisionedProductsResponse

This is the response object from the ScanProvisionedProducts operation.

Class SearchProductsAsAdminRequest

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

Class SearchProductsAsAdminResponse

This is the response object from the SearchProductsAsAdmin operation.

Class SearchProductsRequest

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

Class SearchProductsResponse

This is the response object from the SearchProducts operation.

Class Tag

Key-value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.

Class TagOptionDetail

The TagOption details.

Class TagOptionNotMigratedException

ServiceCatalog exception

Class TagOptionSummary

The TagOption summary key-value pair.

Class TerminateProvisionedProductRequest

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

Class TerminateProvisionedProductResponse

This is the response object from the TerminateProvisionedProduct operation.

Class UpdateConstraintRequest

Container for the parameters to the UpdateConstraint operation. Updates an existing 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's details. This operation does not work with a product that has been 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 an existing 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 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.

Class UpdateProvisionedProductResponse

This is the response object from the UpdateProvisionedProduct operation.

Class UpdateProvisioningArtifactRequest

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

Class UpdateProvisioningArtifactResponse

This is the response object from the UpdateProvisioningArtifact operation.

Class UpdateProvisioningParameter

The parameter key-value pair used to update a ProvisionedProduct object. If UsePreviousValue is set to true, Value is ignored and the value for Key is kept as previously set (current value).

Class UpdateTagOptionRequest

Container for the parameters to the UpdateTagOption operation. Updates an existing TagOption.

Class UpdateTagOptionResponse

This is the response object from the UpdateTagOption operation.

Class UsageInstruction

Additional information provided by the administrator.