# API Reference
<a name="API_Reference"></a>

The following actions and data types are supported:
+ [Actions](API_Operations.md)
+ [Data Types](API_Types.md)

# Actions
<a name="API_Operations"></a>

The following actions are supported by Service Catalog:
+  [AcceptPortfolioShare](API_AcceptPortfolioShare.md) 
+  [AssociateBudgetWithResource](API_AssociateBudgetWithResource.md) 
+  [AssociatePrincipalWithPortfolio](API_AssociatePrincipalWithPortfolio.md) 
+  [AssociateProductWithPortfolio](API_AssociateProductWithPortfolio.md) 
+  [AssociateServiceActionWithProvisioningArtifact](API_AssociateServiceActionWithProvisioningArtifact.md) 
+  [AssociateTagOptionWithResource](API_AssociateTagOptionWithResource.md) 
+  [BatchAssociateServiceActionWithProvisioningArtifact](API_BatchAssociateServiceActionWithProvisioningArtifact.md) 
+  [BatchDisassociateServiceActionFromProvisioningArtifact](API_BatchDisassociateServiceActionFromProvisioningArtifact.md) 
+  [CopyProduct](API_CopyProduct.md) 
+  [CreateConstraint](API_CreateConstraint.md) 
+  [CreatePortfolio](API_CreatePortfolio.md) 
+  [CreatePortfolioShare](API_CreatePortfolioShare.md) 
+  [CreateProduct](API_CreateProduct.md) 
+  [CreateProvisionedProductPlan](API_CreateProvisionedProductPlan.md) 
+  [CreateProvisioningArtifact](API_CreateProvisioningArtifact.md) 
+  [CreateServiceAction](API_CreateServiceAction.md) 
+  [CreateTagOption](API_CreateTagOption.md) 
+  [DeleteConstraint](API_DeleteConstraint.md) 
+  [DeletePortfolio](API_DeletePortfolio.md) 
+  [DeletePortfolioShare](API_DeletePortfolioShare.md) 
+  [DeleteProduct](API_DeleteProduct.md) 
+  [DeleteProvisionedProductPlan](API_DeleteProvisionedProductPlan.md) 
+  [DeleteProvisioningArtifact](API_DeleteProvisioningArtifact.md) 
+  [DeleteServiceAction](API_DeleteServiceAction.md) 
+  [DeleteTagOption](API_DeleteTagOption.md) 
+  [DescribeConstraint](API_DescribeConstraint.md) 
+  [DescribeCopyProductStatus](API_DescribeCopyProductStatus.md) 
+  [DescribePortfolio](API_DescribePortfolio.md) 
+  [DescribePortfolioShares](API_DescribePortfolioShares.md) 
+  [DescribePortfolioShareStatus](API_DescribePortfolioShareStatus.md) 
+  [DescribeProduct](API_DescribeProduct.md) 
+  [DescribeProductAsAdmin](API_DescribeProductAsAdmin.md) 
+  [DescribeProductView](API_DescribeProductView.md) 
+  [DescribeProvisionedProduct](API_DescribeProvisionedProduct.md) 
+  [DescribeProvisionedProductPlan](API_DescribeProvisionedProductPlan.md) 
+  [DescribeProvisioningArtifact](API_DescribeProvisioningArtifact.md) 
+  [DescribeProvisioningParameters](API_DescribeProvisioningParameters.md) 
+  [DescribeRecord](API_DescribeRecord.md) 
+  [DescribeServiceAction](API_DescribeServiceAction.md) 
+  [DescribeServiceActionExecutionParameters](API_DescribeServiceActionExecutionParameters.md) 
+  [DescribeTagOption](API_DescribeTagOption.md) 
+  [DisableAWSOrganizationsAccess](API_DisableAWSOrganizationsAccess.md) 
+  [DisassociateBudgetFromResource](API_DisassociateBudgetFromResource.md) 
+  [DisassociatePrincipalFromPortfolio](API_DisassociatePrincipalFromPortfolio.md) 
+  [DisassociateProductFromPortfolio](API_DisassociateProductFromPortfolio.md) 
+  [DisassociateServiceActionFromProvisioningArtifact](API_DisassociateServiceActionFromProvisioningArtifact.md) 
+  [DisassociateTagOptionFromResource](API_DisassociateTagOptionFromResource.md) 
+  [EnableAWSOrganizationsAccess](API_EnableAWSOrganizationsAccess.md) 
+  [ExecuteProvisionedProductPlan](API_ExecuteProvisionedProductPlan.md) 
+  [ExecuteProvisionedProductServiceAction](API_ExecuteProvisionedProductServiceAction.md) 
+  [GetAWSOrganizationsAccessStatus](API_GetAWSOrganizationsAccessStatus.md) 
+  [GetProvisionedProductOutputs](API_GetProvisionedProductOutputs.md) 
+  [ImportAsProvisionedProduct](API_ImportAsProvisionedProduct.md) 
+  [ListAcceptedPortfolioShares](API_ListAcceptedPortfolioShares.md) 
+  [ListBudgetsForResource](API_ListBudgetsForResource.md) 
+  [ListConstraintsForPortfolio](API_ListConstraintsForPortfolio.md) 
+  [ListLaunchPaths](API_ListLaunchPaths.md) 
+  [ListOrganizationPortfolioAccess](API_ListOrganizationPortfolioAccess.md) 
+  [ListPortfolioAccess](API_ListPortfolioAccess.md) 
+  [ListPortfolios](API_ListPortfolios.md) 
+  [ListPortfoliosForProduct](API_ListPortfoliosForProduct.md) 
+  [ListPrincipalsForPortfolio](API_ListPrincipalsForPortfolio.md) 
+  [ListProvisionedProductPlans](API_ListProvisionedProductPlans.md) 
+  [ListProvisioningArtifacts](API_ListProvisioningArtifacts.md) 
+  [ListProvisioningArtifactsForServiceAction](API_ListProvisioningArtifactsForServiceAction.md) 
+  [ListRecordHistory](API_ListRecordHistory.md) 
+  [ListResourcesForTagOption](API_ListResourcesForTagOption.md) 
+  [ListServiceActions](API_ListServiceActions.md) 
+  [ListServiceActionsForProvisioningArtifact](API_ListServiceActionsForProvisioningArtifact.md) 
+  [ListStackInstancesForProvisionedProduct](API_ListStackInstancesForProvisionedProduct.md) 
+  [ListTagOptions](API_ListTagOptions.md) 
+  [NotifyProvisionProductEngineWorkflowResult](API_NotifyProvisionProductEngineWorkflowResult.md) 
+  [NotifyTerminateProvisionedProductEngineWorkflowResult](API_NotifyTerminateProvisionedProductEngineWorkflowResult.md) 
+  [NotifyUpdateProvisionedProductEngineWorkflowResult](API_NotifyUpdateProvisionedProductEngineWorkflowResult.md) 
+  [ProvisionProduct](API_ProvisionProduct.md) 
+  [RejectPortfolioShare](API_RejectPortfolioShare.md) 
+  [ScanProvisionedProducts](API_ScanProvisionedProducts.md) 
+  [SearchProducts](API_SearchProducts.md) 
+  [SearchProductsAsAdmin](API_SearchProductsAsAdmin.md) 
+  [SearchProvisionedProducts](API_SearchProvisionedProducts.md) 
+  [TerminateProvisionedProduct](API_TerminateProvisionedProduct.md) 
+  [UpdateConstraint](API_UpdateConstraint.md) 
+  [UpdatePortfolio](API_UpdatePortfolio.md) 
+  [UpdatePortfolioShare](API_UpdatePortfolioShare.md) 
+  [UpdateProduct](API_UpdateProduct.md) 
+  [UpdateProvisionedProduct](API_UpdateProvisionedProduct.md) 
+  [UpdateProvisionedProductProperties](API_UpdateProvisionedProductProperties.md) 
+  [UpdateProvisioningArtifact](API_UpdateProvisioningArtifact.md) 
+  [UpdateServiceAction](API_UpdateServiceAction.md) 
+  [UpdateTagOption](API_UpdateTagOption.md) 

The following actions are supported by AppRegistry:
+  [AssociateAttributeGroup](API_app-registry_AssociateAttributeGroup.md) 
+  [AssociateResource](API_app-registry_AssociateResource.md) 
+  [CreateApplication](API_app-registry_CreateApplication.md) 
+  [CreateAttributeGroup](API_app-registry_CreateAttributeGroup.md) 
+  [DeleteApplication](API_app-registry_DeleteApplication.md) 
+  [DeleteAttributeGroup](API_app-registry_DeleteAttributeGroup.md) 
+  [DisassociateAttributeGroup](API_app-registry_DisassociateAttributeGroup.md) 
+  [DisassociateResource](API_app-registry_DisassociateResource.md) 
+  [GetApplication](API_app-registry_GetApplication.md) 
+  [GetAssociatedResource](API_app-registry_GetAssociatedResource.md) 
+  [GetAttributeGroup](API_app-registry_GetAttributeGroup.md) 
+  [GetConfiguration](API_app-registry_GetConfiguration.md) 
+  [ListApplications](API_app-registry_ListApplications.md) 
+  [ListAssociatedAttributeGroups](API_app-registry_ListAssociatedAttributeGroups.md) 
+  [ListAssociatedResources](API_app-registry_ListAssociatedResources.md) 
+  [ListAttributeGroups](API_app-registry_ListAttributeGroups.md) 
+  [ListAttributeGroupsForApplication](API_app-registry_ListAttributeGroupsForApplication.md) 
+  [ListTagsForResource](API_app-registry_ListTagsForResource.md) 
+  [PutConfiguration](API_app-registry_PutConfiguration.md) 
+  [SyncResource](API_app-registry_SyncResource.md) 
+  [TagResource](API_app-registry_TagResource.md) 
+  [UntagResource](API_app-registry_UntagResource.md) 
+  [UpdateApplication](API_app-registry_UpdateApplication.md) 
+  [UpdateAttributeGroup](API_app-registry_UpdateAttributeGroup.md) 

# Service Catalog
<a name="API_Operations_AWS_Service_Catalog"></a>

The following actions are supported by Service Catalog:
+  [AcceptPortfolioShare](API_AcceptPortfolioShare.md) 
+  [AssociateBudgetWithResource](API_AssociateBudgetWithResource.md) 
+  [AssociatePrincipalWithPortfolio](API_AssociatePrincipalWithPortfolio.md) 
+  [AssociateProductWithPortfolio](API_AssociateProductWithPortfolio.md) 
+  [AssociateServiceActionWithProvisioningArtifact](API_AssociateServiceActionWithProvisioningArtifact.md) 
+  [AssociateTagOptionWithResource](API_AssociateTagOptionWithResource.md) 
+  [BatchAssociateServiceActionWithProvisioningArtifact](API_BatchAssociateServiceActionWithProvisioningArtifact.md) 
+  [BatchDisassociateServiceActionFromProvisioningArtifact](API_BatchDisassociateServiceActionFromProvisioningArtifact.md) 
+  [CopyProduct](API_CopyProduct.md) 
+  [CreateConstraint](API_CreateConstraint.md) 
+  [CreatePortfolio](API_CreatePortfolio.md) 
+  [CreatePortfolioShare](API_CreatePortfolioShare.md) 
+  [CreateProduct](API_CreateProduct.md) 
+  [CreateProvisionedProductPlan](API_CreateProvisionedProductPlan.md) 
+  [CreateProvisioningArtifact](API_CreateProvisioningArtifact.md) 
+  [CreateServiceAction](API_CreateServiceAction.md) 
+  [CreateTagOption](API_CreateTagOption.md) 
+  [DeleteConstraint](API_DeleteConstraint.md) 
+  [DeletePortfolio](API_DeletePortfolio.md) 
+  [DeletePortfolioShare](API_DeletePortfolioShare.md) 
+  [DeleteProduct](API_DeleteProduct.md) 
+  [DeleteProvisionedProductPlan](API_DeleteProvisionedProductPlan.md) 
+  [DeleteProvisioningArtifact](API_DeleteProvisioningArtifact.md) 
+  [DeleteServiceAction](API_DeleteServiceAction.md) 
+  [DeleteTagOption](API_DeleteTagOption.md) 
+  [DescribeConstraint](API_DescribeConstraint.md) 
+  [DescribeCopyProductStatus](API_DescribeCopyProductStatus.md) 
+  [DescribePortfolio](API_DescribePortfolio.md) 
+  [DescribePortfolioShares](API_DescribePortfolioShares.md) 
+  [DescribePortfolioShareStatus](API_DescribePortfolioShareStatus.md) 
+  [DescribeProduct](API_DescribeProduct.md) 
+  [DescribeProductAsAdmin](API_DescribeProductAsAdmin.md) 
+  [DescribeProductView](API_DescribeProductView.md) 
+  [DescribeProvisionedProduct](API_DescribeProvisionedProduct.md) 
+  [DescribeProvisionedProductPlan](API_DescribeProvisionedProductPlan.md) 
+  [DescribeProvisioningArtifact](API_DescribeProvisioningArtifact.md) 
+  [DescribeProvisioningParameters](API_DescribeProvisioningParameters.md) 
+  [DescribeRecord](API_DescribeRecord.md) 
+  [DescribeServiceAction](API_DescribeServiceAction.md) 
+  [DescribeServiceActionExecutionParameters](API_DescribeServiceActionExecutionParameters.md) 
+  [DescribeTagOption](API_DescribeTagOption.md) 
+  [DisableAWSOrganizationsAccess](API_DisableAWSOrganizationsAccess.md) 
+  [DisassociateBudgetFromResource](API_DisassociateBudgetFromResource.md) 
+  [DisassociatePrincipalFromPortfolio](API_DisassociatePrincipalFromPortfolio.md) 
+  [DisassociateProductFromPortfolio](API_DisassociateProductFromPortfolio.md) 
+  [DisassociateServiceActionFromProvisioningArtifact](API_DisassociateServiceActionFromProvisioningArtifact.md) 
+  [DisassociateTagOptionFromResource](API_DisassociateTagOptionFromResource.md) 
+  [EnableAWSOrganizationsAccess](API_EnableAWSOrganizationsAccess.md) 
+  [ExecuteProvisionedProductPlan](API_ExecuteProvisionedProductPlan.md) 
+  [ExecuteProvisionedProductServiceAction](API_ExecuteProvisionedProductServiceAction.md) 
+  [GetAWSOrganizationsAccessStatus](API_GetAWSOrganizationsAccessStatus.md) 
+  [GetProvisionedProductOutputs](API_GetProvisionedProductOutputs.md) 
+  [ImportAsProvisionedProduct](API_ImportAsProvisionedProduct.md) 
+  [ListAcceptedPortfolioShares](API_ListAcceptedPortfolioShares.md) 
+  [ListBudgetsForResource](API_ListBudgetsForResource.md) 
+  [ListConstraintsForPortfolio](API_ListConstraintsForPortfolio.md) 
+  [ListLaunchPaths](API_ListLaunchPaths.md) 
+  [ListOrganizationPortfolioAccess](API_ListOrganizationPortfolioAccess.md) 
+  [ListPortfolioAccess](API_ListPortfolioAccess.md) 
+  [ListPortfolios](API_ListPortfolios.md) 
+  [ListPortfoliosForProduct](API_ListPortfoliosForProduct.md) 
+  [ListPrincipalsForPortfolio](API_ListPrincipalsForPortfolio.md) 
+  [ListProvisionedProductPlans](API_ListProvisionedProductPlans.md) 
+  [ListProvisioningArtifacts](API_ListProvisioningArtifacts.md) 
+  [ListProvisioningArtifactsForServiceAction](API_ListProvisioningArtifactsForServiceAction.md) 
+  [ListRecordHistory](API_ListRecordHistory.md) 
+  [ListResourcesForTagOption](API_ListResourcesForTagOption.md) 
+  [ListServiceActions](API_ListServiceActions.md) 
+  [ListServiceActionsForProvisioningArtifact](API_ListServiceActionsForProvisioningArtifact.md) 
+  [ListStackInstancesForProvisionedProduct](API_ListStackInstancesForProvisionedProduct.md) 
+  [ListTagOptions](API_ListTagOptions.md) 
+  [NotifyProvisionProductEngineWorkflowResult](API_NotifyProvisionProductEngineWorkflowResult.md) 
+  [NotifyTerminateProvisionedProductEngineWorkflowResult](API_NotifyTerminateProvisionedProductEngineWorkflowResult.md) 
+  [NotifyUpdateProvisionedProductEngineWorkflowResult](API_NotifyUpdateProvisionedProductEngineWorkflowResult.md) 
+  [ProvisionProduct](API_ProvisionProduct.md) 
+  [RejectPortfolioShare](API_RejectPortfolioShare.md) 
+  [ScanProvisionedProducts](API_ScanProvisionedProducts.md) 
+  [SearchProducts](API_SearchProducts.md) 
+  [SearchProductsAsAdmin](API_SearchProductsAsAdmin.md) 
+  [SearchProvisionedProducts](API_SearchProvisionedProducts.md) 
+  [TerminateProvisionedProduct](API_TerminateProvisionedProduct.md) 
+  [UpdateConstraint](API_UpdateConstraint.md) 
+  [UpdatePortfolio](API_UpdatePortfolio.md) 
+  [UpdatePortfolioShare](API_UpdatePortfolioShare.md) 
+  [UpdateProduct](API_UpdateProduct.md) 
+  [UpdateProvisionedProduct](API_UpdateProvisionedProduct.md) 
+  [UpdateProvisionedProductProperties](API_UpdateProvisionedProductProperties.md) 
+  [UpdateProvisioningArtifact](API_UpdateProvisioningArtifact.md) 
+  [UpdateServiceAction](API_UpdateServiceAction.md) 
+  [UpdateTagOption](API_UpdateTagOption.md) 

# AcceptPortfolioShare
<a name="API_AcceptPortfolioShare"></a>

Accepts an offer to share the specified portfolio.

## Request Syntax
<a name="API_AcceptPortfolioShare_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "PortfolioShareType": "string"
}
```

## Request Parameters
<a name="API_AcceptPortfolioShare_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_AcceptPortfolioShare_RequestSyntax) **   <a name="servicecatalog-AcceptPortfolioShare-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_AcceptPortfolioShare_RequestSyntax) **   <a name="servicecatalog-AcceptPortfolioShare-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [PortfolioShareType](#API_AcceptPortfolioShare_RequestSyntax) **   <a name="servicecatalog-AcceptPortfolioShare-request-PortfolioShareType"></a>
The type of shared portfolios to accept. The default is to accept imported portfolios.  
+  `AWS_ORGANIZATIONS` - Accept portfolios shared by the management account of your organization.
+  `IMPORTED` - Accept imported portfolios.
+  `AWS_SERVICECATALOG` - Not supported. (Throws ResourceNotFoundException.)
For example, `aws servicecatalog accept-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS`   
Type: String  
Valid Values: `IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS`   
Required: No

## Response Elements
<a name="API_AcceptPortfolioShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AcceptPortfolioShare_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_AcceptPortfolioShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AcceptPortfolioShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AcceptPortfolioShare) 

# AssociateBudgetWithResource
<a name="API_AssociateBudgetWithResource"></a>

Associates the specified budget with the specified resource.

## Request Syntax
<a name="API_AssociateBudgetWithResource_RequestSyntax"></a>

```
{
   "BudgetName": "string",
   "ResourceId": "string"
}
```

## Request Parameters
<a name="API_AssociateBudgetWithResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [BudgetName](#API_AssociateBudgetWithResource_RequestSyntax) **   <a name="servicecatalog-AssociateBudgetWithResource-request-BudgetName"></a>
The name of the budget you want to associate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceId](#API_AssociateBudgetWithResource_RequestSyntax) **   <a name="servicecatalog-AssociateBudgetWithResource-request-ResourceId"></a>
 The resource identifier. Either a portfolio-id or a product-id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_AssociateBudgetWithResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateBudgetWithResource_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateBudgetWithResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AssociateBudgetWithResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AssociateBudgetWithResource) 

# AssociatePrincipalWithPortfolio
<a name="API_AssociatePrincipalWithPortfolio"></a>

Associates the specified principal ARN with the specified portfolio.

If you share the portfolio with principal name sharing enabled, the `PrincipalARN` association is included in the share. 

The `PortfolioID`, `PrincipalARN`, and `PrincipalType` parameters are required. 

You can associate a maximum of 10 Principals with a portfolio using `PrincipalType` as `IAM_PATTERN`. 

**Note**  
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is *not* an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using `PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated. 

## Request Syntax
<a name="API_AssociatePrincipalWithPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "PrincipalARN": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_AssociatePrincipalWithPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_AssociatePrincipalWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociatePrincipalWithPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_AssociatePrincipalWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociatePrincipalWithPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [PrincipalARN](#API_AssociatePrincipalWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociatePrincipalWithPortfolio-request-PrincipalARN"></a>
The ARN of the principal (user, role, or group). If the `PrincipalType` is `IAM`, the supported value is a fully defined [IAM Amazon Resource Name (ARN)](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). If the `PrincipalType` is `IAM_PATTERN`, the supported value is an `IAM` ARN *without an AccountID* in the following format:  
 *arn:partition:iam:::resource-type/resource-id*   
The ARN resource-id can be either:  
+ A fully formed resource-id. For example, *arn:aws:iam:::role/resource-name* or *arn:aws:iam:::role/resource-path/resource-name* 
+ A wildcard ARN. The wildcard ARN accepts `IAM_PATTERN` values with a "\$1" or "?" in the resource-id segment of the ARN. For example *arn:partition:service:::resource-type/resource-path/resource-name*. The new symbols are exclusive to the **resource-path** and **resource-name** and cannot replace the **resource-type** or other ARN values. 

  The ARN path and principal name allow unlimited wildcard characters.
Examples of an **acceptable** wildcard ARN:  
+ arn:aws:iam:::role/ResourceName\$1\$1
+ arn:aws:iam:::role/\$1/ResourceName\$1?
Examples of an **unacceptable** wildcard ARN:  
+ arn:aws:iam:::\$1/ResourceName
You can associate multiple `IAM_PATTERN`s even if the account has no principal with that name.   
The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular regex context. The "\$1" wildcard character matches any number of any characters. This is similar to ".\$1" in regular regex context.  
In the IAM Principal ARN format (*arn:partition:iam:::resource-type/resource-path/resource-name*), valid resource-type values include **user/**, **group/**, or **role/**. The "?" and "\$1" characters are allowed only after the resource-type in the resource-id segment. You can use special characters anywhere within the resource-id.   
The "\$1" character also matches the "/" character, allowing paths to be formed *within* the resource-id. For example, *arn:aws:iam:::role/**\$1**/ResourceName\$1?* matches both *arn:aws:iam:::role/pathA/pathB/ResourceName\$11* and *arn:aws:iam:::role/pathA/ResourceName\$11*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [PrincipalType](#API_AssociatePrincipalWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociatePrincipalWithPortfolio-request-PrincipalType"></a>
The principal type. The supported value is `IAM` if you use a fully defined Amazon Resource Name (ARN), or `IAM_PATTERN` if you use an ARN with no `accountID`, with or without wildcard characters.   
Type: String  
Valid Values: `IAM | IAM_PATTERN`   
Required: Yes

## Response Elements
<a name="API_AssociatePrincipalWithPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociatePrincipalWithPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_AssociatePrincipalWithPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AssociatePrincipalWithPortfolio) 

# AssociateProductWithPortfolio
<a name="API_AssociateProductWithPortfolio"></a>

Associates the specified product with the specified portfolio.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_AssociateProductWithPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "ProductId": "string",
   "SourcePortfolioId": "string"
}
```

## Request Parameters
<a name="API_AssociateProductWithPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_AssociateProductWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociateProductWithPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_AssociateProductWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociateProductWithPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProductId](#API_AssociateProductWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociateProductWithPortfolio-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [SourcePortfolioId](#API_AssociateProductWithPortfolio_RequestSyntax) **   <a name="servicecatalog-AssociateProductWithPortfolio-request-SourcePortfolioId"></a>
The identifier of the source portfolio.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

## Response Elements
<a name="API_AssociateProductWithPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateProductWithPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateProductWithPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AssociateProductWithPortfolio) 

# AssociateServiceActionWithProvisioningArtifact
<a name="API_AssociateServiceActionWithProvisioningArtifact"></a>

Associates a self-service action with a provisioning artifact.

## Request Syntax
<a name="API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string",
   "ServiceActionId": "string"
}
```

## Request Parameters
<a name="API_AssociateServiceActionWithProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-AssociateServiceActionWithProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-AssociateServiceActionWithProvisioningArtifact-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests from the same AWS account use the same idempotency token, the same response is returned for each repeated request.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [ProductId](#API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-AssociateServiceActionWithProvisioningArtifact-request-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-AssociateServiceActionWithProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ServiceActionId](#API_AssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-AssociateServiceActionWithProvisioningArtifact-request-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_AssociateServiceActionWithProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateServiceActionWithProvisioningArtifact_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateServiceActionWithProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AssociateServiceActionWithProvisioningArtifact) 

# AssociateTagOptionWithResource
<a name="API_AssociateTagOptionWithResource"></a>

Associate the specified TagOption with the specified portfolio or product.

## Request Syntax
<a name="API_AssociateTagOptionWithResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "TagOptionId": "string"
}
```

## Request Parameters
<a name="API_AssociateTagOptionWithResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceId](#API_AssociateTagOptionWithResource_RequestSyntax) **   <a name="servicecatalog-AssociateTagOptionWithResource-request-ResourceId"></a>
The resource identifier.  
Type: String  
Required: Yes

 ** [TagOptionId](#API_AssociateTagOptionWithResource_RequestSyntax) **   <a name="servicecatalog-AssociateTagOptionWithResource-request-TagOptionId"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_AssociateTagOptionWithResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateTagOptionWithResource_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_AssociateTagOptionWithResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AssociateTagOptionWithResource) 

# BatchAssociateServiceActionWithProvisioningArtifact
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact"></a>

Associates multiple self-service actions with provisioning artifacts.

## Request Syntax
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ServiceActionAssociations": [ 
      { 
         "ProductId": "string",
         "ProvisioningArtifactId": "string",
         "ServiceActionId": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_BatchAssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-BatchAssociateServiceActionWithProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ServiceActionAssociations](#API_BatchAssociateServiceActionWithProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-BatchAssociateServiceActionWithProvisioningArtifact-request-ServiceActionAssociations"></a>
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.  
Type: Array of [ServiceActionAssociation](API_ServiceActionAssociation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_ResponseSyntax"></a>

```
{
   "FailedServiceActionAssociations": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "ProductId": "string",
         "ProvisioningArtifactId": "string",
         "ServiceActionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedServiceActionAssociations](#API_BatchAssociateServiceActionWithProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-BatchAssociateServiceActionWithProvisioningArtifact-response-FailedServiceActionAssociations"></a>
An object that contains a list of errors, along with information to help you identify the self-service action.  
Type: Array of [FailedServiceActionAssociation](API_FailedServiceActionAssociation.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_BatchAssociateServiceActionWithProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/BatchAssociateServiceActionWithProvisioningArtifact) 

# BatchDisassociateServiceActionFromProvisioningArtifact
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact"></a>

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

## Request Syntax
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ServiceActionAssociations": [ 
      { 
         "ProductId": "string",
         "ProvisioningArtifactId": "string",
         "ServiceActionId": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_BatchDisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-BatchDisassociateServiceActionFromProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ServiceActionAssociations](#API_BatchDisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-BatchDisassociateServiceActionFromProvisioningArtifact-request-ServiceActionAssociations"></a>
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.  
Type: Array of [ServiceActionAssociation](API_ServiceActionAssociation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_ResponseSyntax"></a>

```
{
   "FailedServiceActionAssociations": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "ProductId": "string",
         "ProvisioningArtifactId": "string",
         "ServiceActionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedServiceActionAssociations](#API_BatchDisassociateServiceActionFromProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-BatchDisassociateServiceActionFromProvisioningArtifact-response-FailedServiceActionAssociations"></a>
An object that contains a list of errors, along with information to help you identify the self-service action.  
Type: Array of [FailedServiceActionAssociation](API_FailedServiceActionAssociation.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_BatchDisassociateServiceActionFromProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/BatchDisassociateServiceActionFromProvisioningArtifact) 

# CopyProduct
<a name="API_CopyProduct"></a>

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. If you copy a product to another account, you must first share the product in a portfolio using [CreatePortfolioShare](API_CreatePortfolioShare.md).

This operation is performed asynchronously. To track the progress of the operation, use [DescribeCopyProductStatus](API_DescribeCopyProductStatus.md).

## Request Syntax
<a name="API_CopyProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "CopyOptions": [ "string" ],
   "IdempotencyToken": "string",
   "SourceProductArn": "string",
   "SourceProvisioningArtifactIdentifiers": [ 
      { 
         "string" : "string" 
      }
   ],
   "TargetProductId": "string",
   "TargetProductName": "string"
}
```

## Request Parameters
<a name="API_CopyProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [CopyOptions](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-CopyOptions"></a>
The copy options. If the value is `CopyTags`, the tags from the source product are copied to the target product.  
Type: Array of strings  
Valid Values: `CopyTags`   
Required: No

 ** [IdempotencyToken](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-IdempotencyToken"></a>
 A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [SourceProductArn](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-SourceProductArn"></a>
The Amazon Resource Name (ARN) of the source product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: Yes

 ** [SourceProvisioningArtifactIdentifiers](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-SourceProvisioningArtifactIdentifiers"></a>
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.  
Type: Array of string to string maps  
Valid Keys: `Id`   
Required: No

 ** [TargetProductId](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-TargetProductId"></a>
The identifier of the target product. By default, a new product is created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [TargetProductName](#API_CopyProduct_RequestSyntax) **   <a name="servicecatalog-CopyProduct-request-TargetProductName"></a>
A name for the target product. The default is the name of the source product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

## Response Syntax
<a name="API_CopyProduct_ResponseSyntax"></a>

```
{
   "CopyProductToken": "string"
}
```

## Response Elements
<a name="API_CopyProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CopyProductToken](#API_CopyProduct_ResponseSyntax) **   <a name="servicecatalog-CopyProduct-response-CopyProductToken"></a>
The token to use to track the progress of the operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_CopyProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CopyProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CopyProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CopyProduct) 

# CreateConstraint
<a name="API_CreateConstraint"></a>

Creates a constraint.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_CreateConstraint_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Description": "string",
   "IdempotencyToken": "string",
   "Parameters": "string",
   "PortfolioId": "string",
   "ProductId": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_CreateConstraint_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Description](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-Description"></a>
The description of the constraint.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** [IdempotencyToken](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Parameters](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-Parameters"></a>
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:    
LAUNCH  
You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.  
Specify the `RoleArn` property as follows:  
 `{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}`   
Specify the `LocalRoleName` property as follows:  
 `{"LocalRoleName": "SCBasicLaunchRole"}`   
If you specify the `LocalRoleName` property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.  
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
You cannot have both a `LAUNCH` and a `STACKSET` constraint.  
You also cannot have more than one `LAUNCH` constraint on a product and portfolio.  
NOTIFICATION  
Specify the `NotificationArns` property as follows:  
 `{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}`   
RESOURCE\$1UPDATE  
Specify the `TagUpdatesOnProvisionedProduct` property as follows:  
 `{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}`   
The `TagUpdatesOnProvisionedProduct` property accepts a string value of `ALLOWED` or `NOT_ALLOWED`.  
STACKSET  
Specify the `Parameters` property as follows:  
 `{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}`   
You cannot have both a `LAUNCH` and a `STACKSET` constraint.  
You also cannot have more than one `STACKSET` constraint on a product and portfolio.  
Products with a `STACKSET` constraint will launch an AWS CloudFormation stack set.  
TEMPLATE  
Specify the `Rules` property. For more information, see [Template Constraint Rules](http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html).
Type: String  
Required: Yes

 ** [PortfolioId](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProductId](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Type](#API_CreateConstraint_RequestSyntax) **   <a name="servicecatalog-CreateConstraint-request-Type"></a>
The type of constraint.  
+  `LAUNCH` 
+  `NOTIFICATION` 
+  `RESOURCE_UPDATE` 
+  `STACKSET` 
+  `TEMPLATE` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## Response Syntax
<a name="API_CreateConstraint_ResponseSyntax"></a>

```
{
   "ConstraintDetail": { 
      "ConstraintId": "string",
      "Description": "string",
      "Owner": "string",
      "PortfolioId": "string",
      "ProductId": "string",
      "Type": "string"
   },
   "ConstraintParameters": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateConstraint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConstraintDetail](#API_CreateConstraint_ResponseSyntax) **   <a name="servicecatalog-CreateConstraint-response-ConstraintDetail"></a>
Information about the constraint.  
Type: [ConstraintDetail](API_ConstraintDetail.md) object

 ** [ConstraintParameters](#API_CreateConstraint_ResponseSyntax) **   <a name="servicecatalog-CreateConstraint-response-ConstraintParameters"></a>
The constraint parameters.  
Type: String

 ** [Status](#API_CreateConstraint_ResponseSyntax) **   <a name="servicecatalog-CreateConstraint-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_CreateConstraint_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CreateConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateConstraint) 

# CreatePortfolio
<a name="API_CreatePortfolio"></a>

Creates a portfolio.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_CreatePortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Description": "string",
   "DisplayName": "string",
   "IdempotencyToken": "string",
   "ProviderName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreatePortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Description](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-Description"></a>
The description of the portfolio.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** [DisplayName](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-DisplayName"></a>
The name to use for display purposes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IdempotencyToken](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ProviderName](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-ProviderName"></a>
The name of the portfolio provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: Yes

 ** [Tags](#API_CreatePortfolio_RequestSyntax) **   <a name="servicecatalog-CreatePortfolio-request-Tags"></a>
One or more tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 20 items.  
Required: No

## Response Syntax
<a name="API_CreatePortfolio_ResponseSyntax"></a>

```
{
   "PortfolioDetail": { 
      "ARN": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "Id": "string",
      "ProviderName": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreatePortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PortfolioDetail](#API_CreatePortfolio_ResponseSyntax) **   <a name="servicecatalog-CreatePortfolio-response-PortfolioDetail"></a>
Information about the portfolio.  
Type: [PortfolioDetail](API_PortfolioDetail.md) object

 ** [Tags](#API_CreatePortfolio_ResponseSyntax) **   <a name="servicecatalog-CreatePortfolio-response-Tags"></a>
Information about the tags associated with the portfolio.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_CreatePortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_CreatePortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreatePortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreatePortfolio) 

# CreatePortfolioShare
<a name="API_CreatePortfolioShare"></a>

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.

Note that if a delegated admin is de-registered, they can no longer create portfolio shares.

 `AWSOrganizationsAccess` must be enabled in order to create a portfolio share to an organization node.

You can't share a shared resource, including portfolios that contain a shared product.

If the portfolio share with the specified account or organization node already exists, this action will have no effect and will not return an error. To update an existing share, you must use the ` UpdatePortfolioShare` API instead. 

**Note**  
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is *not* an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using `PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated. 

## Request Syntax
<a name="API_CreatePortfolioShare_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccountId": "string",
   "OrganizationNode": { 
      "Type": "string",
      "Value": "string"
   },
   "PortfolioId": "string",
   "SharePrincipals": boolean,
   "ShareTagOptions": boolean
}
```

## Request Parameters
<a name="API_CreatePortfolioShare_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccountId](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-AccountId"></a>
The AWS account ID. For example, `123456789012`.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** [OrganizationNode](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-OrganizationNode"></a>
The organization node to whom you are going to share. When you pass `OrganizationNode`, it creates `PortfolioShare` for all of the AWS accounts that are associated to the `OrganizationNode`. The output returns a `PortfolioShareToken`, which enables the administrator to monitor the status of the `PortfolioShare` creation process.  
Type: [OrganizationNode](API_OrganizationNode.md) object  
Required: No

 ** [PortfolioId](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [SharePrincipals](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-SharePrincipals"></a>
This parameter is only supported for portfolios with an **OrganizationalNode** Type of `ORGANIZATION` or `ORGANIZATIONAL_UNIT`.   
Enables or disables `Principal` sharing when creating the portfolio share. If you do **not** provide this flag, principal sharing is disabled.   
When you enable Principal Name Sharing for a portfolio share, the share recipient account end users with a principal that matches any of the associated IAM patterns can provision products from the portfolio. Once shared, the share recipient can view associations of `PrincipalType`: `IAM_PATTERN` on their portfolio. You can create the principals in the recipient account before or after creating the share.   
Type: Boolean  
Required: No

 ** [ShareTagOptions](#API_CreatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-CreatePortfolioShare-request-ShareTagOptions"></a>
Enables or disables `TagOptions ` sharing when creating the portfolio share. If this flag is not provided, TagOptions sharing is disabled.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_CreatePortfolioShare_ResponseSyntax"></a>

```
{
   "PortfolioShareToken": "string"
}
```

## Response Elements
<a name="API_CreatePortfolioShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PortfolioShareToken](#API_CreatePortfolioShare_ResponseSyntax) **   <a name="servicecatalog-CreatePortfolioShare-response-PortfolioShareToken"></a>
The portfolio shares a unique identifier that only returns if the portfolio is shared to an organization node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_CreatePortfolioShare_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CreatePortfolioShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreatePortfolioShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreatePortfolioShare) 

# CreateProduct
<a name="API_CreateProduct"></a>

Creates a product.

A delegated admin is authorized to invoke this command.

The user or role that performs this operation must have the `cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `ImportFromPhysicalId` template source in the information data section.

## Request Syntax
<a name="API_CreateProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Description": "string",
   "Distributor": "string",
   "IdempotencyToken": "string",
   "Name": "string",
   "Owner": "string",
   "ProductType": "string",
   "ProvisioningArtifactParameters": { 
      "Description": "string",
      "DisableTemplateValidation": boolean,
      "Info": { 
         "string" : "string" 
      },
      "Name": "string",
      "Type": "string"
   },
   "SourceConnection": { 
      "ConnectionParameters": { 
         "CodeStar": { 
            "ArtifactPath": "string",
            "Branch": "string",
            "ConnectionArn": "string",
            "Repository": "string"
         }
      },
      "Type": "string"
   },
   "SupportDescription": "string",
   "SupportEmail": "string",
   "SupportUrl": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Description](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-Description"></a>
The description of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [Distributor](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-Distributor"></a>
The distributor of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [IdempotencyToken](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Name](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-Name"></a>
The name of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: Yes

 ** [Owner](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-Owner"></a>
The owner of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: Yes

 ** [ProductType](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-ProductType"></a>
The type of product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Valid Values: `CLOUD_FORMATION_TEMPLATE | MARKETPLACE | TERRAFORM_OPEN_SOURCE | EXTERNAL | TERRAFORM_CLOUD`   
Required: Yes

 ** [ProvisioningArtifactParameters](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-ProvisioningArtifactParameters"></a>
The configuration of the provisioning artifact.   
Type: [ProvisioningArtifactProperties](API_ProvisioningArtifactProperties.md) object  
Required: No

 ** [SourceConnection](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-SourceConnection"></a>
Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The `SourceConnection` parameter consists of the following sub-fields.  
+  `Type` 
+  `ConnectionParamters` 
Type: [SourceConnection](API_SourceConnection.md) object  
Required: No

 ** [SupportDescription](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-SupportDescription"></a>
The support information about the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [SupportEmail](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-SupportEmail"></a>
The contact email for product support.  
Type: String  
Length Constraints: Maximum length of 254.  
Required: No

 ** [SupportUrl](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-SupportUrl"></a>
The contact URL for product support.  
 `^https?:\/\// `/ is the pattern used to validate SupportUrl.  
Type: String  
Length Constraints: Maximum length of 2083.  
Required: No

 ** [Tags](#API_CreateProduct_RequestSyntax) **   <a name="servicecatalog-CreateProduct-request-Tags"></a>
One or more tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 20 items.  
Required: No

## Response Syntax
<a name="API_CreateProduct_ResponseSyntax"></a>

```
{
   "ProductViewDetail": { 
      "CreatedTime": number,
      "ProductARN": "string",
      "ProductViewSummary": { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      },
      "SourceConnection": { 
         "ConnectionParameters": { 
            "CodeStar": { 
               "ArtifactPath": "string",
               "Branch": "string",
               "ConnectionArn": "string",
               "Repository": "string"
            }
         },
         "LastSync": { 
            "LastSuccessfulSyncProvisioningArtifactId": "string",
            "LastSuccessfulSyncTime": number,
            "LastSyncStatus": "string",
            "LastSyncStatusMessage": "string",
            "LastSyncTime": number
         },
         "Type": "string"
      },
      "Status": "string"
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_CreateProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProductViewDetail](#API_CreateProduct_ResponseSyntax) **   <a name="servicecatalog-CreateProduct-response-ProductViewDetail"></a>
Information about the product view.  
Type: [ProductViewDetail](API_ProductViewDetail.md) object

 ** [ProvisioningArtifactDetail](#API_CreateProduct_ResponseSyntax) **   <a name="servicecatalog-CreateProduct-response-ProvisioningArtifactDetail"></a>
Information about the provisioning artifact.   
Type: [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) object

 ** [Tags](#API_CreateProduct_ResponseSyntax) **   <a name="servicecatalog-CreateProduct-response-Tags"></a>
Information about the tags associated with the product.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_CreateProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateProduct) 

# CreateProvisionedProductPlan
<a name="API_CreateProvisionedProductPlan"></a>

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 for each provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILABLE or TAINTED.

To view the resource changes in the change set, use [DescribeProvisionedProductPlan](API_DescribeProvisionedProductPlan.md). To create or modify the provisioned product, use [ExecuteProvisionedProductPlan](API_ExecuteProvisionedProductPlan.md).

## Request Syntax
<a name="API_CreateProvisionedProductPlan_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "NotificationArns": [ "string" ],
   "PathId": "string",
   "PlanName": "string",
   "PlanType": "string",
   "ProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "UsePreviousValue": boolean,
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateProvisionedProductPlan_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [NotificationArns](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-NotificationArns"></a>
Passed to AWS CloudFormation. The SNS topic ARNs to which to publish stack-related events.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [PathId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PathId"></a>
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](API_ListLaunchPaths.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PlanName](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PlanName"></a>
The name of the plan.  
Type: String  
Required: Yes

 ** [PlanType](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-PlanType"></a>
The plan type.  
Type: String  
Valid Values: `CLOUDFORMATION`   
Required: Yes

 ** [ProductId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisionedProductName](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisionedProductName"></a>
A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningParameters](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-ProvisioningParameters"></a>
Parameters specified by the administrator that are required for provisioning the product.  
Type: Array of [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) objects  
Required: No

 ** [Tags](#API_CreateProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-request-Tags"></a>
One or more tags.  
If the plan is for an existing provisioned product, the product must have a `RESOURCE_UPDATE` constraint with `TagUpdatesOnProvisionedProduct` set to `ALLOWED` to allow tag updates.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_CreateProvisionedProductPlan_ResponseSyntax"></a>

```
{
   "PlanId": "string",
   "PlanName": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisionProductId": "string"
}
```

## Response Elements
<a name="API_CreateProvisionedProductPlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PlanId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [PlanName](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-PlanName"></a>
The name of the plan.  
Type: String

 ** [ProvisionedProductName](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisionedProductName"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*` 

 ** [ProvisioningArtifactId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [ProvisionProductId](#API_CreateProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-CreateProvisionedProductPlan-response-ProvisionProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_CreateProvisionedProductPlan_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_CreateProvisionedProductPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateProvisionedProductPlan) 

# CreateProvisioningArtifact
<a name="API_CreateProvisioningArtifact"></a>

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.

The user or role that performs this operation must have the `cloudformation:GetTemplate` IAM policy permission. This policy permission is required when using the `ImportFromPhysicalId` template source in the information data section.

## Request Syntax
<a name="API_CreateProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "Parameters": { 
      "Description": "string",
      "DisableTemplateValidation": boolean,
      "Info": { 
         "string" : "string" 
      },
      "Name": "string",
      "Type": "string"
   },
   "ProductId": "string"
}
```

## Request Parameters
<a name="API_CreateProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_CreateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Parameters](#API_CreateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-request-Parameters"></a>
The configuration for the provisioning artifact.  
Type: [ProvisioningArtifactProperties](API_ProvisioningArtifactProperties.md) object  
Required: Yes

 ** [ProductId](#API_CreateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_CreateProvisioningArtifact_ResponseSyntax"></a>

```
{
   "Info": { 
      "string" : "string" 
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Status": "string"
}
```

## Response Elements
<a name="API_CreateProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Info](#API_CreateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-response-Info"></a>
Specify the template source with one of the following options, but not both. Keys accepted: [ `LoadTemplateFromURL`, `ImportFromPhysicalId` ].  
Use the URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.   
 `LoadTemplateFromURL`   
Use the URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.  
 `ImportFromPhysicalId`   
Use the physical id of the resource that contains the template; currently supports AWS CloudFormation stack ARN.  
Type: String to string map  
Map Entries: Maximum number of 100 items.

 ** [ProvisioningArtifactDetail](#API_CreateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-response-ProvisioningArtifactDetail"></a>
Information about the provisioning artifact.  
Type: [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) object

 ** [Status](#API_CreateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-CreateProvisioningArtifact-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_CreateProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## Examples
<a name="API_CreateProvisioningArtifact_Examples"></a>

### To create a provisioning artifact
<a name="API_CreateProvisioningArtifact_Example_1"></a>

The following shows an example JSON request.

#### Sample Request
<a name="API_CreateProvisioningArtifact_Example_1_Request"></a>

```
{
   "AcceptLanguage": "en",
   "ProductId": "prod-mjpjbit3pzuqi",
   "Parameters":
   {
      "Name": "Version-2",
      "Description": "my-test-2",
      "Info":
      {
         "LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..." ,
      },
      "Type": "CLOUD_FORMATION_TEMPLATE"
      "IdempotencyToken": "my-test-token-2"
   }
}
```

## See Also
<a name="API_CreateProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateProvisioningArtifact) 

# CreateServiceAction
<a name="API_CreateServiceAction"></a>

Creates a self-service action.

## Request Syntax
<a name="API_CreateServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Definition": { 
      "string" : "string" 
   },
   "DefinitionType": "string",
   "Description": "string",
   "IdempotencyToken": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_CreateServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Definition](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-Definition"></a>
The self-service action definition. Can be one of the following:    
Name  
The name of the AWS Systems Manager document (SSM document). For example, `AWS-RestartEC2Instance`.  
If you are using a shared SSM document, you must provide the ARN instead of the name.  
Version  
The AWS Systems Manager automation document version. For example, `"Version": "1"`   
AssumeRole  
The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, `"AssumeRole": "arn:aws:iam::12345678910:role/ActionRole"`.  
To reuse the provisioned product launch role, set to `"AssumeRole": "LAUNCH_ROLE"`.  
Parameters  
The list of parameters in JSON format.  
For example: `[{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}]` or `[{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}]`.
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Valid Keys: `Name | Version | AssumeRole | Parameters`   
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [DefinitionType](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-DefinitionType"></a>
The service action definition type. For example, `SSM_AUTOMATION`.  
Type: String  
Valid Values: `SSM_AUTOMATION`   
Required: Yes

 ** [Description](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-Description"></a>
The self-service action description.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [IdempotencyToken](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Name](#API_CreateServiceAction_RequestSyntax) **   <a name="servicecatalog-CreateServiceAction-request-Name"></a>
The self-service action name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9_\-.]*`   
Required: Yes

## Response Syntax
<a name="API_CreateServiceAction_ResponseSyntax"></a>

```
{
   "ServiceActionDetail": { 
      "Definition": { 
         "string" : "string" 
      },
      "ServiceActionSummary": { 
         "DefinitionType": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   }
}
```

## Response Elements
<a name="API_CreateServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceActionDetail](#API_CreateServiceAction_ResponseSyntax) **   <a name="servicecatalog-CreateServiceAction-response-ServiceActionDetail"></a>
An object containing information about the self-service action.  
Type: [ServiceActionDetail](API_ServiceActionDetail.md) object

## Errors
<a name="API_CreateServiceAction_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

## See Also
<a name="API_CreateServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateServiceAction) 

# CreateTagOption
<a name="API_CreateTagOption"></a>

Creates a TagOption.

## Request Syntax
<a name="API_CreateTagOption_RequestSyntax"></a>

```
{
   "Key": "string",
   "Value": "string"
}
```

## Request Parameters
<a name="API_CreateTagOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Key](#API_CreateTagOption_RequestSyntax) **   <a name="servicecatalog-CreateTagOption-request-Key"></a>
The TagOption key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** [Value](#API_CreateTagOption_RequestSyntax) **   <a name="servicecatalog-CreateTagOption-request-Value"></a>
The TagOption value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## Response Syntax
<a name="API_CreateTagOption_ResponseSyntax"></a>

```
{
   "TagOptionDetail": { 
      "Active": boolean,
      "Id": "string",
      "Key": "string",
      "Owner": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_CreateTagOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TagOptionDetail](#API_CreateTagOption_ResponseSyntax) **   <a name="servicecatalog-CreateTagOption-response-TagOptionDetail"></a>
Information about the TagOption.  
Type: [TagOptionDetail](API_TagOptionDetail.md) object

## Errors
<a name="API_CreateTagOption_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_CreateTagOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/CreateTagOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CreateTagOption) 

# DeleteConstraint
<a name="API_DeleteConstraint"></a>

Deletes the specified constraint.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_DeleteConstraint_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DeleteConstraint_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeleteConstraint_RequestSyntax) **   <a name="servicecatalog-DeleteConstraint-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DeleteConstraint_RequestSyntax) **   <a name="servicecatalog-DeleteConstraint-request-Id"></a>
The identifier of the constraint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DeleteConstraint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteConstraint_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteConstraint) 

# DeletePortfolio
<a name="API_DeletePortfolio"></a>

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.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_DeletePortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DeletePortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeletePortfolio_RequestSyntax) **   <a name="servicecatalog-DeletePortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DeletePortfolio_RequestSyntax) **   <a name="servicecatalog-DeletePortfolio-request-Id"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DeletePortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_DeletePortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeletePortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeletePortfolio) 

# DeletePortfolioShare
<a name="API_DeletePortfolioShare"></a>

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.

Note that if a delegated admin is de-registered, portfolio shares created from that account are removed.

## Request Syntax
<a name="API_DeletePortfolioShare_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccountId": "string",
   "OrganizationNode": { 
      "Type": "string",
      "Value": "string"
   },
   "PortfolioId": "string"
}
```

## Request Parameters
<a name="API_DeletePortfolioShare_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeletePortfolioShare_RequestSyntax) **   <a name="servicecatalog-DeletePortfolioShare-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccountId](#API_DeletePortfolioShare_RequestSyntax) **   <a name="servicecatalog-DeletePortfolioShare-request-AccountId"></a>
The AWS account ID.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** [OrganizationNode](#API_DeletePortfolioShare_RequestSyntax) **   <a name="servicecatalog-DeletePortfolioShare-request-OrganizationNode"></a>
The organization node to whom you are going to stop sharing.  
Type: [OrganizationNode](API_OrganizationNode.md) object  
Required: No

 ** [PortfolioId](#API_DeletePortfolioShare_RequestSyntax) **   <a name="servicecatalog-DeletePortfolioShare-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DeletePortfolioShare_ResponseSyntax"></a>

```
{
   "PortfolioShareToken": "string"
}
```

## Response Elements
<a name="API_DeletePortfolioShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PortfolioShareToken](#API_DeletePortfolioShare_ResponseSyntax) **   <a name="servicecatalog-DeletePortfolioShare-response-PortfolioShareToken"></a>
The portfolio share unique identifier. This will only be returned if delete is made to an organization node.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_DeletePortfolioShare_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeletePortfolioShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeletePortfolioShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeletePortfolioShare) 

# DeleteProduct
<a name="API_DeleteProduct"></a>

Deletes the specified product.

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

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_DeleteProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DeleteProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeleteProduct_RequestSyntax) **   <a name="servicecatalog-DeleteProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DeleteProduct_RequestSyntax) **   <a name="servicecatalog-DeleteProduct-request-Id"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DeleteProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteProduct) 

# DeleteProvisionedProductPlan
<a name="API_DeleteProvisionedProductPlan"></a>

Deletes the specified plan.

## Request Syntax
<a name="API_DeleteProvisionedProductPlan_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IgnoreErrors": boolean,
   "PlanId": "string"
}
```

## Request Parameters
<a name="API_DeleteProvisionedProductPlan_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeleteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DeleteProvisionedProductPlan-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IgnoreErrors](#API_DeleteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DeleteProvisionedProductPlan-request-IgnoreErrors"></a>
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.  
Type: Boolean  
Required: No

 ** [PlanId](#API_DeleteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DeleteProvisionedProductPlan-request-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DeleteProvisionedProductPlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProvisionedProductPlan_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProvisionedProductPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteProvisionedProductPlan) 

# DeleteProvisioningArtifact
<a name="API_DeleteProvisioningArtifact"></a>

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.

## Request Syntax
<a name="API_DeleteProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string"
}
```

## Request Parameters
<a name="API_DeleteProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeleteProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DeleteProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ProductId](#API_DeleteProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DeleteProvisioningArtifact-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_DeleteProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DeleteProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DeleteProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteProvisioningArtifact) 

# DeleteServiceAction
<a name="API_DeleteServiceAction"></a>

Deletes a self-service action.

## Request Syntax
<a name="API_DeleteServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string",
   "IdempotencyToken": "string"
}
```

## Request Parameters
<a name="API_DeleteServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DeleteServiceAction_RequestSyntax) **   <a name="servicecatalog-DeleteServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DeleteServiceAction_RequestSyntax) **   <a name="servicecatalog-DeleteServiceAction-request-Id"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [IdempotencyToken](#API_DeleteServiceAction_RequestSyntax) **   <a name="servicecatalog-DeleteServiceAction-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests from the same AWS account use the same idempotency token, the same response is returned for each repeated request.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

## Response Elements
<a name="API_DeleteServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteServiceAction_Errors"></a>

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteServiceAction) 

# DeleteTagOption
<a name="API_DeleteTagOption"></a>

Deletes the specified TagOption.

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

## Request Syntax
<a name="API_DeleteTagOption_RequestSyntax"></a>

```
{
   "Id": "string"
}
```

## Request Parameters
<a name="API_DeleteTagOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Id](#API_DeleteTagOption_RequestSyntax) **   <a name="servicecatalog-DeleteTagOption-request-Id"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_DeleteTagOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTagOption_Errors"></a>

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteTagOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DeleteTagOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DeleteTagOption) 

# DescribeConstraint
<a name="API_DescribeConstraint"></a>

Gets information about the specified constraint.

## Request Syntax
<a name="API_DescribeConstraint_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DescribeConstraint_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeConstraint_RequestSyntax) **   <a name="servicecatalog-DescribeConstraint-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeConstraint_RequestSyntax) **   <a name="servicecatalog-DescribeConstraint-request-Id"></a>
The identifier of the constraint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeConstraint_ResponseSyntax"></a>

```
{
   "ConstraintDetail": { 
      "ConstraintId": "string",
      "Description": "string",
      "Owner": "string",
      "PortfolioId": "string",
      "ProductId": "string",
      "Type": "string"
   },
   "ConstraintParameters": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeConstraint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConstraintDetail](#API_DescribeConstraint_ResponseSyntax) **   <a name="servicecatalog-DescribeConstraint-response-ConstraintDetail"></a>
Information about the constraint.  
Type: [ConstraintDetail](API_ConstraintDetail.md) object

 ** [ConstraintParameters](#API_DescribeConstraint_ResponseSyntax) **   <a name="servicecatalog-DescribeConstraint-response-ConstraintParameters"></a>
The constraint parameters.  
Type: String

 ** [Status](#API_DescribeConstraint_ResponseSyntax) **   <a name="servicecatalog-DescribeConstraint-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_DescribeConstraint_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeConstraint) 

# DescribeCopyProductStatus
<a name="API_DescribeCopyProductStatus"></a>

Gets the status of the specified copy product operation.

## Request Syntax
<a name="API_DescribeCopyProductStatus_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "CopyProductToken": "string"
}
```

## Request Parameters
<a name="API_DescribeCopyProductStatus_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeCopyProductStatus_RequestSyntax) **   <a name="servicecatalog-DescribeCopyProductStatus-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [CopyProductToken](#API_DescribeCopyProductStatus_RequestSyntax) **   <a name="servicecatalog-DescribeCopyProductStatus-request-CopyProductToken"></a>
The token for the copy product operation. This token is returned by [CopyProduct](API_CopyProduct.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeCopyProductStatus_ResponseSyntax"></a>

```
{
   "CopyProductStatus": "string",
   "StatusDetail": "string",
   "TargetProductId": "string"
}
```

## Response Elements
<a name="API_DescribeCopyProductStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CopyProductStatus](#API_DescribeCopyProductStatus_ResponseSyntax) **   <a name="servicecatalog-DescribeCopyProductStatus-response-CopyProductStatus"></a>
The status of the copy product operation.  
Type: String  
Valid Values: `SUCCEEDED | IN_PROGRESS | FAILED` 

 ** [StatusDetail](#API_DescribeCopyProductStatus_ResponseSyntax) **   <a name="servicecatalog-DescribeCopyProductStatus-response-StatusDetail"></a>
The status message.  
Type: String

 ** [TargetProductId](#API_DescribeCopyProductStatus_ResponseSyntax) **   <a name="servicecatalog-DescribeCopyProductStatus-response-TargetProductId"></a>
The identifier of the copied product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

## Errors
<a name="API_DescribeCopyProductStatus_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeCopyProductStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeCopyProductStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeCopyProductStatus) 

# DescribePortfolio
<a name="API_DescribePortfolio"></a>

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_DescribePortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DescribePortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribePortfolio_RequestSyntax) **   <a name="servicecatalog-DescribePortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribePortfolio_RequestSyntax) **   <a name="servicecatalog-DescribePortfolio-request-Id"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribePortfolio_ResponseSyntax"></a>

```
{
   "Budgets": [ 
      { 
         "BudgetName": "string"
      }
   ],
   "PortfolioDetail": { 
      "ARN": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "Id": "string",
      "ProviderName": "string"
   },
   "TagOptions": [ 
      { 
         "Active": boolean,
         "Id": "string",
         "Key": "string",
         "Owner": "string",
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribePortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Budgets](#API_DescribePortfolio_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolio-response-Budgets"></a>
Information about the associated budgets.  
Type: Array of [BudgetDetail](API_BudgetDetail.md) objects

 ** [PortfolioDetail](#API_DescribePortfolio_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolio-response-PortfolioDetail"></a>
Information about the portfolio.  
Type: [PortfolioDetail](API_PortfolioDetail.md) object

 ** [TagOptions](#API_DescribePortfolio_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolio-response-TagOptions"></a>
Information about the TagOptions associated with the portfolio.  
Type: Array of [TagOptionDetail](API_TagOptionDetail.md) objects

 ** [Tags](#API_DescribePortfolio_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolio-response-Tags"></a>
Information about the tags associated with the portfolio.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_DescribePortfolio_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribePortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribePortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribePortfolio) 

# DescribePortfolioShares
<a name="API_DescribePortfolioShares"></a>

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

You can use this API to determine which accounts or organizational nodes this portfolio have been shared, whether the recipient entity has imported the share, and whether TagOptions are included with the share.

The `PortfolioId` and `Type` parameters are both required.

## Request Syntax
<a name="API_DescribePortfolioShares_RequestSyntax"></a>

```
{
   "DeduplicateShares": boolean,
   "IncludeAllMemberAccounts": boolean,
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string",
   "Status": "string",
   "Type": "string"
}
```

## Request Parameters
<a name="API_DescribePortfolioShares_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [DeduplicateShares](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-DeduplicateShares"></a>
  
Type: Boolean  
Required: No

 ** [IncludeAllMemberAccounts](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-IncludeAllMemberAccounts"></a>
>  
Type: Boolean  
Required: No

 ** [PageSize](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-PortfolioId"></a>
The unique identifier of the portfolio for which shares will be retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Status](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-Status"></a>
Status of the portfolio share operation.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | ERROR`   
Required: No

 ** [Type](#API_DescribePortfolioShares_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShares-request-Type"></a>
The type of portfolio share to summarize. This field acts as a filter on the type of portfolio share, which can be one of the following:  
1. `ACCOUNT` - Represents an external account to account share.  
2. `ORGANIZATION` - Represents a share to an organization. This share is available to every account in the organization.  
3. `ORGANIZATIONAL_UNIT` - Represents a share to an organizational unit.  
4. `ORGANIZATION_MEMBER_ACCOUNT` - Represents a share to an account in the organization.  
Type: String  
Valid Values: `ACCOUNT | ORGANIZATION | ORGANIZATIONAL_UNIT | ORGANIZATION_MEMBER_ACCOUNT`   
Required: No

## Response Syntax
<a name="API_DescribePortfolioShares_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "PortfolioShareDetails": [ 
      { 
         "Accepted": boolean,
         "PrincipalARN": "string",
         "PrincipalId": "string",
         "SharePrincipals": boolean,
         "ShareTagOptions": boolean,
         "Status": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribePortfolioShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_DescribePortfolioShares_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShares-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [PortfolioShareDetails](#API_DescribePortfolioShares_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShares-response-PortfolioShareDetails"></a>
Summaries about each of the portfolio shares.  
Type: Array of [PortfolioShareDetail](API_PortfolioShareDetail.md) objects

## Errors
<a name="API_DescribePortfolioShares_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribePortfolioShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribePortfolioShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribePortfolioShares) 

# DescribePortfolioShareStatus
<a name="API_DescribePortfolioShareStatus"></a>

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.

## Request Syntax
<a name="API_DescribePortfolioShareStatus_RequestSyntax"></a>

```
{
   "PortfolioShareToken": "string"
}
```

## Request Parameters
<a name="API_DescribePortfolioShareStatus_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [PortfolioShareToken](#API_DescribePortfolioShareStatus_RequestSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-request-PortfolioShareToken"></a>
The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribePortfolioShareStatus_ResponseSyntax"></a>

```
{
   "OrganizationNodeValue": "string",
   "PortfolioId": "string",
   "PortfolioShareToken": "string",
   "ShareDetails": { 
      "ShareErrors": [ 
         { 
            "Accounts": [ "string" ],
            "Error": "string",
            "Message": "string"
         }
      ],
      "SuccessfulShares": [ "string" ]
   },
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribePortfolioShareStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [OrganizationNodeValue](#API_DescribePortfolioShareStatus_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-response-OrganizationNodeValue"></a>
Organization node identifier. It can be either account id, organizational unit id or organization id.  
Type: String  
Pattern: `(^[0-9]{12}$)|(^arn:aws:organizations::\d{12}:organization\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\d{12}:ou\/o-[a-z0-9]{10,32}\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)` 

 ** [PortfolioId](#API_DescribePortfolioShareStatus_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-response-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [PortfolioShareToken](#API_DescribePortfolioShareStatus_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-response-PortfolioShareToken"></a>
The token for the portfolio share operation. For example, `share-6v24abcdefghi`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [ShareDetails](#API_DescribePortfolioShareStatus_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-response-ShareDetails"></a>
Information about the portfolio share operation.  
Type: [ShareDetails](API_ShareDetails.md) object

 ** [Status](#API_DescribePortfolioShareStatus_ResponseSyntax) **   <a name="servicecatalog-DescribePortfolioShareStatus-response-Status"></a>
Status of the portfolio share operation.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | ERROR` 

## Errors
<a name="API_DescribePortfolioShareStatus_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribePortfolioShareStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribePortfolioShareStatus) 

# DescribeProduct
<a name="API_DescribeProduct"></a>

Gets information about the specified product.

**Note**  
 Running this operation with administrator access results in a failure. [DescribeProductAsAdmin](API_DescribeProductAsAdmin.md) should be used instead. 

## Request Syntax
<a name="API_DescribeProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProduct-request-Id"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [Name](#API_DescribeProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProduct-request-Name"></a>
The product name.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

## Response Syntax
<a name="API_DescribeProduct_ResponseSyntax"></a>

```
{
   "Budgets": [ 
      { 
         "BudgetName": "string"
      }
   ],
   "LaunchPaths": [ 
      { 
         "Id": "string",
         "Name": "string"
      }
   ],
   "ProductViewSummary": { 
      "Distributor": "string",
      "HasDefaultPath": boolean,
      "Id": "string",
      "Name": "string",
      "Owner": "string",
      "ProductId": "string",
      "ShortDescription": "string",
      "SupportDescription": "string",
      "SupportEmail": "string",
      "SupportUrl": "string",
      "Type": "string"
   },
   "ProvisioningArtifacts": [ 
      { 
         "CreatedTime": number,
         "Description": "string",
         "Guidance": "string",
         "Id": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Budgets](#API_DescribeProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProduct-response-Budgets"></a>
Information about the associated budgets.  
Type: Array of [BudgetDetail](API_BudgetDetail.md) objects

 ** [LaunchPaths](#API_DescribeProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProduct-response-LaunchPaths"></a>
Information about the associated launch paths.  
Type: Array of [LaunchPath](API_LaunchPath.md) objects

 ** [ProductViewSummary](#API_DescribeProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProduct-response-ProductViewSummary"></a>
Summary information about the product view.  
Type: [ProductViewSummary](API_ProductViewSummary.md) object

 ** [ProvisioningArtifacts](#API_DescribeProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProduct-response-ProvisioningArtifacts"></a>
Information about the provisioning artifacts for the specified product.  
Type: Array of [ProvisioningArtifact](API_ProvisioningArtifact.md) objects

## Errors
<a name="API_DescribeProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProduct) 

# DescribeProductAsAdmin
<a name="API_DescribeProductAsAdmin"></a>

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

## Request Syntax
<a name="API_DescribeProductAsAdmin_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string",
   "Name": "string",
   "SourcePortfolioId": "string"
}
```

## Request Parameters
<a name="API_DescribeProductAsAdmin_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProductAsAdmin_RequestSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeProductAsAdmin_RequestSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-request-Id"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [Name](#API_DescribeProductAsAdmin_RequestSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-request-Name"></a>
The product name.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [SourcePortfolioId](#API_DescribeProductAsAdmin_RequestSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-request-SourcePortfolioId"></a>
The unique identifier of the shared portfolio that the specified product is associated with.  
You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

## Response Syntax
<a name="API_DescribeProductAsAdmin_ResponseSyntax"></a>

```
{
   "Budgets": [ 
      { 
         "BudgetName": "string"
      }
   ],
   "ProductViewDetail": { 
      "CreatedTime": number,
      "ProductARN": "string",
      "ProductViewSummary": { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      },
      "SourceConnection": { 
         "ConnectionParameters": { 
            "CodeStar": { 
               "ArtifactPath": "string",
               "Branch": "string",
               "ConnectionArn": "string",
               "Repository": "string"
            }
         },
         "LastSync": { 
            "LastSuccessfulSyncProvisioningArtifactId": "string",
            "LastSuccessfulSyncTime": number,
            "LastSyncStatus": "string",
            "LastSyncStatusMessage": "string",
            "LastSyncTime": number
         },
         "Type": "string"
      },
      "Status": "string"
   },
   "ProvisioningArtifactSummaries": [ 
      { 
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "ProvisioningArtifactMetadata": { 
            "string" : "string" 
         }
      }
   ],
   "TagOptions": [ 
      { 
         "Active": boolean,
         "Id": "string",
         "Key": "string",
         "Owner": "string",
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeProductAsAdmin_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Budgets](#API_DescribeProductAsAdmin_ResponseSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-response-Budgets"></a>
Information about the associated budgets.  
Type: Array of [BudgetDetail](API_BudgetDetail.md) objects

 ** [ProductViewDetail](#API_DescribeProductAsAdmin_ResponseSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-response-ProductViewDetail"></a>
Information about the product view.  
Type: [ProductViewDetail](API_ProductViewDetail.md) object

 ** [ProvisioningArtifactSummaries](#API_DescribeProductAsAdmin_ResponseSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-response-ProvisioningArtifactSummaries"></a>
Information about the provisioning artifacts (also known as versions) for the specified product.  
Type: Array of [ProvisioningArtifactSummary](API_ProvisioningArtifactSummary.md) objects

 ** [TagOptions](#API_DescribeProductAsAdmin_ResponseSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-response-TagOptions"></a>
Information about the TagOptions associated with the product.  
Type: Array of [TagOptionDetail](API_TagOptionDetail.md) objects

 ** [Tags](#API_DescribeProductAsAdmin_ResponseSyntax) **   <a name="servicecatalog-DescribeProductAsAdmin-response-Tags"></a>
Information about the tags associated with the product.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_DescribeProductAsAdmin_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProductAsAdmin_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProductAsAdmin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProductAsAdmin) 

# DescribeProductView
<a name="API_DescribeProductView"></a>

Gets information about the specified product.

## Request Syntax
<a name="API_DescribeProductView_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DescribeProductView_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProductView_RequestSyntax) **   <a name="servicecatalog-DescribeProductView-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeProductView_RequestSyntax) **   <a name="servicecatalog-DescribeProductView-request-Id"></a>
The product view identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeProductView_ResponseSyntax"></a>

```
{
   "ProductViewSummary": { 
      "Distributor": "string",
      "HasDefaultPath": boolean,
      "Id": "string",
      "Name": "string",
      "Owner": "string",
      "ProductId": "string",
      "ShortDescription": "string",
      "SupportDescription": "string",
      "SupportEmail": "string",
      "SupportUrl": "string",
      "Type": "string"
   },
   "ProvisioningArtifacts": [ 
      { 
         "CreatedTime": number,
         "Description": "string",
         "Guidance": "string",
         "Id": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeProductView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProductViewSummary](#API_DescribeProductView_ResponseSyntax) **   <a name="servicecatalog-DescribeProductView-response-ProductViewSummary"></a>
Summary information about the product.  
Type: [ProductViewSummary](API_ProductViewSummary.md) object

 ** [ProvisioningArtifacts](#API_DescribeProductView_ResponseSyntax) **   <a name="servicecatalog-DescribeProductView-response-ProvisioningArtifacts"></a>
Information about the provisioning artifacts for the product.  
Type: Array of [ProvisioningArtifact](API_ProvisioningArtifact.md) objects

## Errors
<a name="API_DescribeProductView_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProductView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProductView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProductView) 

# DescribeProvisionedProduct
<a name="API_DescribeProvisionedProduct"></a>

Gets information about the specified provisioned product.

## Request Syntax
<a name="API_DescribeProvisionedProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeProvisionedProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProduct-request-Id"></a>
The provisioned product identifier. You must provide the name or ID, but not both.  
If you do not provide a name or ID, or you provide both name and ID, an `InvalidParametersException` will occur.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [Name](#API_DescribeProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProduct-request-Name"></a>
The name of the provisioned product. You must provide the name or ID, but not both.  
If you do not provide a name or ID, or you provide both name and ID, an `InvalidParametersException` will occur.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: No

## Response Syntax
<a name="API_DescribeProvisionedProduct_ResponseSyntax"></a>

```
{
   "CloudWatchDashboards": [ 
      { 
         "Name": "string"
      }
   ],
   "ProvisionedProductDetail": { 
      "Arn": "string",
      "CreatedTime": number,
      "Id": "string",
      "IdempotencyToken": "string",
      "LastProvisioningRecordId": "string",
      "LastRecordId": "string",
      "LastSuccessfulProvisioningRecordId": "string",
      "LaunchRoleArn": "string",
      "Name": "string",
      "ProductId": "string",
      "ProvisioningArtifactId": "string",
      "Status": "string",
      "StatusMessage": "string",
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_DescribeProvisionedProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CloudWatchDashboards](#API_DescribeProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisionedProduct-response-CloudWatchDashboards"></a>
Any CloudWatch dashboards that were created when provisioning the product.  
Type: Array of [CloudWatchDashboard](API_CloudWatchDashboard.md) objects

 ** [ProvisionedProductDetail](#API_DescribeProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisionedProduct-response-ProvisionedProductDetail"></a>
Information about the provisioned product.  
Type: [ProvisionedProductDetail](API_ProvisionedProductDetail.md) object

## Errors
<a name="API_DescribeProvisionedProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProvisionedProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProvisionedProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProvisionedProduct) 

# DescribeProvisionedProductPlan
<a name="API_DescribeProvisionedProductPlan"></a>

Gets information about the resource changes for the specified plan.

## Request Syntax
<a name="API_DescribeProvisionedProductPlan_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "PlanId": "string"
}
```

## Request Parameters
<a name="API_DescribeProvisionedProductPlan_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_DescribeProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_DescribeProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PlanId](#API_DescribeProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-request-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeProvisionedProductPlan_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisionedProductPlanDetails": { 
      "CreatedTime": number,
      "NotificationArns": [ "string" ],
      "PathId": "string",
      "PlanId": "string",
      "PlanName": "string",
      "PlanType": "string",
      "ProductId": "string",
      "ProvisioningArtifactId": "string",
      "ProvisioningParameters": [ 
         { 
            "Key": "string",
            "UsePreviousValue": boolean,
            "Value": "string"
         }
      ],
      "ProvisionProductId": "string",
      "ProvisionProductName": "string",
      "Status": "string",
      "StatusMessage": "string",
      "Tags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "UpdatedTime": number
   },
   "ResourceChanges": [ 
      { 
         "Action": "string",
         "Details": [ 
            { 
               "CausingEntity": "string",
               "Evaluation": "string",
               "Target": { 
                  "Attribute": "string",
                  "Name": "string",
                  "RequiresRecreation": "string"
               }
            }
         ],
         "LogicalResourceId": "string",
         "PhysicalResourceId": "string",
         "Replacement": "string",
         "ResourceType": "string",
         "Scope": [ "string" ]
      }
   ]
}
```

## Response Elements
<a name="API_DescribeProvisionedProductPlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_DescribeProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisionedProductPlanDetails](#API_DescribeProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-response-ProvisionedProductPlanDetails"></a>
Information about the plan.  
Type: [ProvisionedProductPlanDetails](API_ProvisionedProductPlanDetails.md) object

 ** [ResourceChanges](#API_DescribeProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisionedProductPlan-response-ResourceChanges"></a>
Information about the resource changes that will occur when the plan is executed.  
Type: Array of [ResourceChange](API_ResourceChange.md) objects

## Errors
<a name="API_DescribeProvisionedProductPlan_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProvisionedProductPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProvisionedProductPlan) 

# DescribeProvisioningArtifact
<a name="API_DescribeProvisioningArtifact"></a>

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

## Request Syntax
<a name="API_DescribeProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IncludeProvisioningArtifactParameters": boolean,
   "ProductId": "string",
   "ProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "string",
   "Verbose": boolean
}
```

## Request Parameters
<a name="API_DescribeProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IncludeProvisioningArtifactParameters](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-IncludeProvisioningArtifactParameters"></a>
Indicates if the API call response does or does not include additional details about the provisioning parameters.   
Type: Boolean  
Required: No

 ** [ProductId](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductName](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-ProductName"></a>
The product name.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [ProvisioningArtifactId](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisioningArtifactName](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-ProvisioningArtifactName"></a>
The provisioning artifact name.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** [Verbose](#API_DescribeProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-request-Verbose"></a>
Indicates whether a verbose level of detail is enabled.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_DescribeProvisioningArtifact_ResponseSyntax"></a>

```
{
   "Info": { 
      "string" : "string" 
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "ProvisioningArtifactParameters": [ 
      { 
         "DefaultValue": "string",
         "Description": "string",
         "IsNoEcho": boolean,
         "ParameterConstraints": { 
            "AllowedPattern": "string",
            "AllowedValues": [ "string" ],
            "ConstraintDescription": "string",
            "MaxLength": "string",
            "MaxValue": "string",
            "MinLength": "string",
            "MinValue": "string"
         },
         "ParameterKey": "string",
         "ParameterType": "string"
      }
   ],
   "Status": "string"
}
```

## Response Elements
<a name="API_DescribeProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Info](#API_DescribeProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-response-Info"></a>
The URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.  
Type: String to string map  
Map Entries: Maximum number of 100 items.

 ** [ProvisioningArtifactDetail](#API_DescribeProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-response-ProvisioningArtifactDetail"></a>
Information about the provisioning artifact.  
Type: [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) object

 ** [ProvisioningArtifactParameters](#API_DescribeProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-response-ProvisioningArtifactParameters"></a>
Information about the parameters used to provision the product.   
Type: Array of [ProvisioningArtifactParameter](API_ProvisioningArtifactParameter.md) objects

 ** [Status](#API_DescribeProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningArtifact-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_DescribeProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProvisioningArtifact) 

# DescribeProvisioningParameters
<a name="API_DescribeProvisioningParameters"></a>

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](API_ProvisionProduct.md), 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`.

## Request Syntax
<a name="API_DescribeProvisioningParameters_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PathId": "string",
   "PathName": "string",
   "ProductId": "string",
   "ProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "string"
}
```

## Request Parameters
<a name="API_DescribeProvisioningParameters_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PathId](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-PathId"></a>
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](API_ListLaunchPaths.md). You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PathName](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-PathName"></a>
The name of the path. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ProductId](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-ProductId"></a>
The product identifier. You must provide the product name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductName](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-ProductName"></a>
The name of the product. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [ProvisioningArtifactId](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisioningArtifactName](#API_DescribeProvisioningParameters_RequestSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-request-ProvisioningArtifactName"></a>
The name of the provisioning artifact. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

## Response Syntax
<a name="API_DescribeProvisioningParameters_ResponseSyntax"></a>

```
{
   "ConstraintSummaries": [ 
      { 
         "Description": "string",
         "Type": "string"
      }
   ],
   "ProvisioningArtifactOutputKeys": [ 
      { 
         "Description": "string",
         "Key": "string"
      }
   ],
   "ProvisioningArtifactOutputs": [ 
      { 
         "Description": "string",
         "Key": "string"
      }
   ],
   "ProvisioningArtifactParameters": [ 
      { 
         "DefaultValue": "string",
         "Description": "string",
         "IsNoEcho": boolean,
         "ParameterConstraints": { 
            "AllowedPattern": "string",
            "AllowedValues": [ "string" ],
            "ConstraintDescription": "string",
            "MaxLength": "string",
            "MaxValue": "string",
            "MinLength": "string",
            "MinValue": "string"
         },
         "ParameterKey": "string",
         "ParameterType": "string"
      }
   ],
   "ProvisioningArtifactPreferences": { 
      "StackSetAccounts": [ "string" ],
      "StackSetRegions": [ "string" ]
   },
   "TagOptions": [ 
      { 
         "Key": "string",
         "Values": [ "string" ]
      }
   ],
   "UsageInstructions": [ 
      { 
         "Type": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeProvisioningParameters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConstraintSummaries](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-ConstraintSummaries"></a>
Information about the constraints used to provision the product.  
Type: Array of [ConstraintSummary](API_ConstraintSummary.md) objects

 ** [ProvisioningArtifactOutputKeys](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-ProvisioningArtifactOutputKeys"></a>
A list of the keys and descriptions of the outputs. These outputs can be referenced from a provisioned product launched from this provisioning artifact.  
Type: Array of [ProvisioningArtifactOutput](API_ProvisioningArtifactOutput.md) objects  
Array Members: Maximum number of 60 items.

 ** [ProvisioningArtifactOutputs](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-ProvisioningArtifactOutputs"></a>
 *This parameter has been deprecated.*   
The output of the provisioning artifact.  
Type: Array of [ProvisioningArtifactOutput](API_ProvisioningArtifactOutput.md) objects  
Array Members: Maximum number of 60 items.

 ** [ProvisioningArtifactParameters](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-ProvisioningArtifactParameters"></a>
Information about the parameters used to provision the product.  
Type: Array of [ProvisioningArtifactParameter](API_ProvisioningArtifactParameter.md) objects

 ** [ProvisioningArtifactPreferences](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-ProvisioningArtifactPreferences"></a>
An object that contains information about preferences, such as Regions and accounts, for the provisioning artifact.  
Type: [ProvisioningArtifactPreferences](API_ProvisioningArtifactPreferences.md) object

 ** [TagOptions](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-TagOptions"></a>
Information about the TagOptions associated with the resource.  
Type: Array of [TagOptionSummary](API_TagOptionSummary.md) objects

 ** [UsageInstructions](#API_DescribeProvisioningParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeProvisioningParameters-response-UsageInstructions"></a>
Any additional metadata specifically related to the provisioning of the product. For example, see the `Version` field of the AWS CloudFormation template.  
Type: Array of [UsageInstruction](API_UsageInstruction.md) objects

## Errors
<a name="API_DescribeProvisioningParameters_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeProvisioningParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeProvisioningParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeProvisioningParameters) 

# DescribeRecord
<a name="API_DescribeRecord"></a>

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, [ProvisionProduct](API_ProvisionProduct.md), [TerminateProvisionedProduct](API_TerminateProvisionedProduct.md), or [UpdateProvisionedProduct](API_UpdateProvisionedProduct.md)). 

**Note**  
If a provisioned product was transferred to a new owner using [UpdateProvisionedProductProperties](API_UpdateProvisionedProductProperties.md), the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use [ListRecordHistory](API_ListRecordHistory.md) to see the product's history from when he was the owner.

## Request Syntax
<a name="API_DescribeRecord_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string",
   "PageSize": number,
   "PageToken": "string"
}
```

## Request Parameters
<a name="API_DescribeRecord_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeRecord_RequestSyntax) **   <a name="servicecatalog-DescribeRecord-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeRecord_RequestSyntax) **   <a name="servicecatalog-DescribeRecord-request-Id"></a>
The record identifier of the provisioned product. This identifier is returned by the request operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [PageSize](#API_DescribeRecord_RequestSyntax) **   <a name="servicecatalog-DescribeRecord-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_DescribeRecord_RequestSyntax) **   <a name="servicecatalog-DescribeRecord-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

## Response Syntax
<a name="API_DescribeRecord_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   },
   "RecordOutputs": [ 
      { 
         "Description": "string",
         "OutputKey": "string",
         "OutputValue": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeRecord_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_DescribeRecord_ResponseSyntax) **   <a name="servicecatalog-DescribeRecord-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [RecordDetail](#API_DescribeRecord_ResponseSyntax) **   <a name="servicecatalog-DescribeRecord-response-RecordDetail"></a>
Information about the product.  
Type: [RecordDetail](API_RecordDetail.md) object

 ** [RecordOutputs](#API_DescribeRecord_ResponseSyntax) **   <a name="servicecatalog-DescribeRecord-response-RecordOutputs"></a>
Information about 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.  
Type: Array of [RecordOutput](API_RecordOutput.md) objects

## Errors
<a name="API_DescribeRecord_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeRecord) 

# DescribeServiceAction
<a name="API_DescribeServiceAction"></a>

Describes a self-service action.

## Request Syntax
<a name="API_DescribeServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Id": "string"
}
```

## Request Parameters
<a name="API_DescribeServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeServiceAction_RequestSyntax) **   <a name="servicecatalog-DescribeServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Id](#API_DescribeServiceAction_RequestSyntax) **   <a name="servicecatalog-DescribeServiceAction-request-Id"></a>
The self-service action identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeServiceAction_ResponseSyntax"></a>

```
{
   "ServiceActionDetail": { 
      "Definition": { 
         "string" : "string" 
      },
      "ServiceActionSummary": { 
         "DefinitionType": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceActionDetail](#API_DescribeServiceAction_ResponseSyntax) **   <a name="servicecatalog-DescribeServiceAction-response-ServiceActionDetail"></a>
Detailed information about the self-service action.  
Type: [ServiceActionDetail](API_ServiceActionDetail.md) object

## Errors
<a name="API_DescribeServiceAction_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeServiceAction) 

# DescribeServiceActionExecutionParameters
<a name="API_DescribeServiceActionExecutionParameters"></a>

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.

## Request Syntax
<a name="API_DescribeServiceActionExecutionParameters_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ProvisionedProductId": "string",
   "ServiceActionId": "string"
}
```

## Request Parameters
<a name="API_DescribeServiceActionExecutionParameters_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DescribeServiceActionExecutionParameters_RequestSyntax) **   <a name="servicecatalog-DescribeServiceActionExecutionParameters-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ProvisionedProductId](#API_DescribeServiceActionExecutionParameters_RequestSyntax) **   <a name="servicecatalog-DescribeServiceActionExecutionParameters-request-ProvisionedProductId"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ServiceActionId](#API_DescribeServiceActionExecutionParameters_RequestSyntax) **   <a name="servicecatalog-DescribeServiceActionExecutionParameters-request-ServiceActionId"></a>
The self-service action identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_DescribeServiceActionExecutionParameters_ResponseSyntax"></a>

```
{
   "ServiceActionParameters": [ 
      { 
         "DefaultValues": [ "string" ],
         "Name": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DescribeServiceActionExecutionParameters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceActionParameters](#API_DescribeServiceActionExecutionParameters_ResponseSyntax) **   <a name="servicecatalog-DescribeServiceActionExecutionParameters-response-ServiceActionParameters"></a>
The parameters of the self-service action.  
Type: Array of [ExecutionParameter](API_ExecutionParameter.md) objects

## Errors
<a name="API_DescribeServiceActionExecutionParameters_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeServiceActionExecutionParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeServiceActionExecutionParameters) 

# DescribeTagOption
<a name="API_DescribeTagOption"></a>

Gets information about the specified TagOption.

## Request Syntax
<a name="API_DescribeTagOption_RequestSyntax"></a>

```
{
   "Id": "string"
}
```

## Request Parameters
<a name="API_DescribeTagOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Id](#API_DescribeTagOption_RequestSyntax) **   <a name="servicecatalog-DescribeTagOption-request-Id"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_DescribeTagOption_ResponseSyntax"></a>

```
{
   "TagOptionDetail": { 
      "Active": boolean,
      "Id": "string",
      "Key": "string",
      "Owner": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_DescribeTagOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TagOptionDetail](#API_DescribeTagOption_ResponseSyntax) **   <a name="servicecatalog-DescribeTagOption-response-TagOptionDetail"></a>
Information about the TagOption.  
Type: [TagOptionDetail](API_TagOptionDetail.md) object

## Errors
<a name="API_DescribeTagOption_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeTagOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DescribeTagOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DescribeTagOption) 

# DisableAWSOrganizationsAccess
<a name="API_DisableAWSOrganizationsAccess"></a>

Disable portfolio sharing through the AWS 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.

You cannot call this API if there are active delegated administrators in the organization.

Note that a delegated administrator is not authorized to invoke `DisableAWSOrganizationsAccess`.

**Important**  
If you share an Service Catalog portfolio in an organization within AWS Organizations, and then disable Organizations access for Service Catalog, the portfolio access permissions will not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access will retain access to the previously shared portfolio.

## Response Elements
<a name="API_DisableAWSOrganizationsAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisableAWSOrganizationsAccess_Errors"></a>

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DisableAWSOrganizationsAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisableAWSOrganizationsAccess) 

# DisassociateBudgetFromResource
<a name="API_DisassociateBudgetFromResource"></a>

Disassociates the specified budget from the specified resource.

## Request Syntax
<a name="API_DisassociateBudgetFromResource_RequestSyntax"></a>

```
{
   "BudgetName": "string",
   "ResourceId": "string"
}
```

## Request Parameters
<a name="API_DisassociateBudgetFromResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [BudgetName](#API_DisassociateBudgetFromResource_RequestSyntax) **   <a name="servicecatalog-DisassociateBudgetFromResource-request-BudgetName"></a>
The name of the budget you want to disassociate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceId](#API_DisassociateBudgetFromResource_RequestSyntax) **   <a name="servicecatalog-DisassociateBudgetFromResource-request-ResourceId"></a>
The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DisassociateBudgetFromResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateBudgetFromResource_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateBudgetFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisassociateBudgetFromResource) 

# DisassociatePrincipalFromPortfolio
<a name="API_DisassociatePrincipalFromPortfolio"></a>

Disassociates a previously associated principal ARN from a specified portfolio.

The `PrincipalType` and `PrincipalARN` must match the `AssociatePrincipalWithPortfolio` call request details. For example, to disassociate an association created with a `PrincipalARN` of `PrincipalType` IAM you must use the `PrincipalType` IAM when calling `DisassociatePrincipalFromPortfolio`. 

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal. 

For more information, review [associate-principal-with-portfolio](https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options) in the AWS CLI Command Reference. 

**Note**  
If you disassociate a principal from a portfolio, with PrincipalType as `IAM`, the same principal will still have access to the portfolio if it matches one of the associated principals of type `IAM_PATTERN`. To fully remove access for a principal, verify all the associated Principals of type `IAM_PATTERN`, and then ensure you disassociate any `IAM_PATTERN` principals that match the principal whose access you are removing.

## Request Syntax
<a name="API_DisassociatePrincipalFromPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "PrincipalARN": "string",
   "PrincipalType": "string"
}
```

## Request Parameters
<a name="API_DisassociatePrincipalFromPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DisassociatePrincipalFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociatePrincipalFromPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_DisassociatePrincipalFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociatePrincipalFromPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [PrincipalARN](#API_DisassociatePrincipalFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociatePrincipalFromPortfolio-request-PrincipalARN"></a>
The ARN of the principal (user, role, or group). This field allows an ARN with no `accountID` with or without wildcard characters if `PrincipalType` is `IAM_PATTERN`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [PrincipalType](#API_DisassociatePrincipalFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociatePrincipalFromPortfolio-request-PrincipalType"></a>
The supported value is `IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you specify an `IAM` ARN with no AccountId, with or without wildcard characters.   
Type: String  
Valid Values: `IAM | IAM_PATTERN`   
Required: No

## Response Elements
<a name="API_DisassociatePrincipalFromPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociatePrincipalFromPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociatePrincipalFromPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisassociatePrincipalFromPortfolio) 

# DisassociateProductFromPortfolio
<a name="API_DisassociateProductFromPortfolio"></a>

Disassociates the specified product from the specified portfolio. 

A delegated admin is authorized to invoke this command.

## Request Syntax
<a name="API_DisassociateProductFromPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "ProductId": "string"
}
```

## Request Parameters
<a name="API_DisassociateProductFromPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DisassociateProductFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociateProductFromPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_DisassociateProductFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociateProductFromPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProductId](#API_DisassociateProductFromPortfolio_RequestSyntax) **   <a name="servicecatalog-DisassociateProductFromPortfolio-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DisassociateProductFromPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateProductFromPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceInUseException **   
A resource that is currently in use. Ensure that the resource is not in use and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateProductFromPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisassociateProductFromPortfolio) 

# DisassociateServiceActionFromProvisioningArtifact
<a name="API_DisassociateServiceActionFromProvisioningArtifact"></a>

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

## Request Syntax
<a name="API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string",
   "ServiceActionId": "string"
}
```

## Request Parameters
<a name="API_DisassociateServiceActionFromProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DisassociateServiceActionFromProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DisassociateServiceActionFromProvisioningArtifact-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests from the same AWS account use the same idempotency token, the same response is returned for each repeated request.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [ProductId](#API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DisassociateServiceActionFromProvisioningArtifact-request-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DisassociateServiceActionFromProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ServiceActionId](#API_DisassociateServiceActionFromProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-DisassociateServiceActionFromProvisioningArtifact-request-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Elements
<a name="API_DisassociateServiceActionFromProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateServiceActionFromProvisioningArtifact_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateServiceActionFromProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisassociateServiceActionFromProvisioningArtifact) 

# DisassociateTagOptionFromResource
<a name="API_DisassociateTagOptionFromResource"></a>

Disassociates the specified TagOption from the specified resource.

## Request Syntax
<a name="API_DisassociateTagOptionFromResource_RequestSyntax"></a>

```
{
   "ResourceId": "string",
   "TagOptionId": "string"
}
```

## Request Parameters
<a name="API_DisassociateTagOptionFromResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [ResourceId](#API_DisassociateTagOptionFromResource_RequestSyntax) **   <a name="servicecatalog-DisassociateTagOptionFromResource-request-ResourceId"></a>
The resource identifier.  
Type: String  
Required: Yes

 ** [TagOptionId](#API_DisassociateTagOptionFromResource_RequestSyntax) **   <a name="servicecatalog-DisassociateTagOptionFromResource-request-TagOptionId"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Elements
<a name="API_DisassociateTagOptionFromResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateTagOptionFromResource_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_DisassociateTagOptionFromResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/DisassociateTagOptionFromResource) 

# EnableAWSOrganizationsAccess
<a name="API_EnableAWSOrganizationsAccess"></a>

Enable portfolio sharing feature through AWS Organizations. This API will allow AWS 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.

When you call this API, Service Catalog calls `organizations:EnableAWSServiceAccess` on your behalf so that your shares stay in sync with any changes in your AWS Organizations structure.

Note that a delegated administrator is not authorized to invoke `EnableAWSOrganizationsAccess`.

**Important**  
If you have previously disabled Organizations access for Service Catalog, and then enable access again, the portfolio access permissions might not sync with the latest changes to the organization structure. Specifically, accounts that you removed from the organization after disabling Service Catalog access, and before you enabled access again, can retain access to the previously shared portfolio. As a result, an account that has been removed from the organization might still be able to create or manage AWS resources when it is no longer authorized to do so. AWS is working to resolve this issue.

## Response Elements
<a name="API_EnableAWSOrganizationsAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_EnableAWSOrganizationsAccess_Errors"></a>

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_EnableAWSOrganizationsAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/EnableAWSOrganizationsAccess) 

# ExecuteProvisionedProductPlan
<a name="API_ExecuteProvisionedProductPlan"></a>

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

## Request Syntax
<a name="API_ExecuteProvisionedProductPlan_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "PlanId": "string"
}
```

## Request Parameters
<a name="API_ExecuteProvisionedProductPlan_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ExecuteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductPlan-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_ExecuteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductPlan-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [PlanId](#API_ExecuteProvisionedProductPlan_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductPlan-request-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ExecuteProvisionedProductPlan_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_ExecuteProvisionedProductPlan_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_ExecuteProvisionedProductPlan_ResponseSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductPlan-response-RecordDetail"></a>
Information about the result of provisioning the product.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_ExecuteProvisionedProductPlan_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ExecuteProvisionedProductPlan_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ExecuteProvisionedProductPlan) 

# ExecuteProvisionedProductServiceAction
<a name="API_ExecuteProvisionedProductServiceAction"></a>

Executes a self-service action against a provisioned product.

## Request Syntax
<a name="API_ExecuteProvisionedProductServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ExecuteToken": "string",
   "Parameters": { 
      "string" : [ "string" ]
   },
   "ProvisionedProductId": "string",
   "ServiceActionId": "string"
}
```

## Request Parameters
<a name="API_ExecuteProvisionedProductServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ExecuteProvisionedProductServiceAction_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ExecuteToken](#API_ExecuteProvisionedProductServiceAction_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-request-ExecuteToken"></a>
An idempotency token that uniquely identifies the execute request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Parameters](#API_ExecuteProvisionedProductServiceAction_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-request-Parameters"></a>
A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as `TARGET`, the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as `TARGET`.  
Type: String to array of strings map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 50.  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: No

 ** [ProvisionedProductId](#API_ExecuteProvisionedProductServiceAction_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-request-ProvisionedProductId"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ServiceActionId](#API_ExecuteProvisionedProductServiceAction_RequestSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-request-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ExecuteProvisionedProductServiceAction_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_ExecuteProvisionedProductServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_ExecuteProvisionedProductServiceAction_ResponseSyntax) **   <a name="servicecatalog-ExecuteProvisionedProductServiceAction-response-RecordDetail"></a>
An object containing detailed information about the result of provisioning the product.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_ExecuteProvisionedProductServiceAction_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ExecuteProvisionedProductServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ExecuteProvisionedProductServiceAction) 

# GetAWSOrganizationsAccessStatus
<a name="API_GetAWSOrganizationsAccessStatus"></a>

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

## Response Syntax
<a name="API_GetAWSOrganizationsAccessStatus_ResponseSyntax"></a>

```
{
   "AccessStatus": "string"
}
```

## Response Elements
<a name="API_GetAWSOrganizationsAccessStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccessStatus](#API_GetAWSOrganizationsAccessStatus_ResponseSyntax) **   <a name="servicecatalog-GetAWSOrganizationsAccessStatus-response-AccessStatus"></a>
The status of the portfolio share feature.  
Type: String  
Valid Values: `ENABLED | UNDER_CHANGE | DISABLED` 

## Errors
<a name="API_GetAWSOrganizationsAccessStatus_Errors"></a>

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_GetAWSOrganizationsAccessStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/GetAWSOrganizationsAccessStatus) 

# GetProvisionedProductOutputs
<a name="API_GetProvisionedProductOutputs"></a>

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.

## Request Syntax
<a name="API_GetProvisionedProductOutputs_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "OutputKeys": [ "string" ],
   "PageSize": number,
   "PageToken": "string",
   "ProvisionedProductId": "string",
   "ProvisionedProductName": "string"
}
```

## Request Parameters
<a name="API_GetProvisionedProductOutputs_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [OutputKeys](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-OutputKeys"></a>
The list of keys that the API should return with their values. If none are provided, the API will return all outputs of the provisioned product.  
Type: Array of strings  
Array Members: Maximum number of 60 items.  
Required: No

 ** [PageSize](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProvisionedProductId](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-ProvisionedProductId"></a>
The identifier of the provisioned product that you want the outputs from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisionedProductName](#API_GetProvisionedProductOutputs_RequestSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-request-ProvisionedProductName"></a>
The name of the provisioned product that you want the outputs from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: No

## Response Syntax
<a name="API_GetProvisionedProductOutputs_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "Outputs": [ 
      { 
         "Description": "string",
         "OutputKey": "string",
         "OutputValue": "string"
      }
   ]
}
```

## Response Elements
<a name="API_GetProvisionedProductOutputs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_GetProvisionedProductOutputs_ResponseSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [Outputs](#API_GetProvisionedProductOutputs_ResponseSyntax) **   <a name="servicecatalog-GetProvisionedProductOutputs-response-Outputs"></a>
Information about 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.   
Type: Array of [RecordOutput](API_RecordOutput.md) objects

## Errors
<a name="API_GetProvisionedProductOutputs_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_GetProvisionedProductOutputs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/GetProvisionedProductOutputs) 

# ImportAsProvisionedProduct
<a name="API_ImportAsProvisionedProduct"></a>

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

 Resource import only supports AWS CloudFormation stack ARNs. AWS CloudFormation StackSets, and non-root nested stacks, are not supported. 

 The AWS CloudFormation stack must have one of the following statuses to be imported: `CREATE_COMPLETE`, `UPDATE_COMPLETE`, `UPDATE_ROLLBACK_COMPLETE`, `IMPORT_COMPLETE`, and `IMPORT_ROLLBACK_COMPLETE`. 

 Import of the resource requires that the AWS CloudFormation stack template matches the associated AWS Service Catalog product provisioning artifact. 

**Note**  
 When you import an existing AWS CloudFormation stack into a portfolio, AWS Service Catalog does not apply the product's associated constraints during the import process. AWS Service Catalog applies the constraints after you call `UpdateProvisionedProduct` for the provisioned product. 

 The user or role that performs this operation must have the `cloudformation:GetTemplate` and `cloudformation:DescribeStacks` IAM policy permissions. 

You can only import one provisioned product at a time. The product's AWS CloudFormation stack must have the `IMPORT_COMPLETE` status before you import another. 

## Request Syntax
<a name="API_ImportAsProvisionedProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "PhysicalId": "string",
   "ProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string"
}
```

## Request Parameters
<a name="API_ImportAsProvisionedProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [PhysicalId](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-PhysicalId"></a>
The unique identifier of the resource to be imported. It only currently supports AWS CloudFormation stack IDs.  
Type: String  
Required: Yes

 ** [ProductId](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisionedProductName](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-ProvisionedProductName"></a>
The user-friendly name of the provisioned product. The value must be unique for the AWS account. The name cannot be updated after the product is provisioned.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_ImportAsProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ImportAsProvisionedProduct_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_ImportAsProvisionedProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_ImportAsProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-ImportAsProvisionedProduct-response-RecordDetail"></a>
Information about a request operation.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_ImportAsProvisionedProduct_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ImportAsProvisionedProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ImportAsProvisionedProduct) 

# ListAcceptedPortfolioShares
<a name="API_ListAcceptedPortfolioShares"></a>

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.

## Request Syntax
<a name="API_ListAcceptedPortfolioShares_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioShareType": "string"
}
```

## Request Parameters
<a name="API_ListAcceptedPortfolioShares_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListAcceptedPortfolioShares_RequestSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListAcceptedPortfolioShares_RequestSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_ListAcceptedPortfolioShares_RequestSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioShareType](#API_ListAcceptedPortfolioShares_RequestSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-request-PortfolioShareType"></a>
The type of shared portfolios to list. The default is to list imported portfolios.  
+  `AWS_ORGANIZATIONS` - List portfolios accepted and shared via organizational sharing by the management account or delegated administrator of your organization.
+  `AWS_SERVICECATALOG` - Deprecated type.
+  `IMPORTED` - List imported portfolios that have been accepted and shared through account-to-account sharing.
Type: String  
Valid Values: `IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS`   
Required: No

## Response Syntax
<a name="API_ListAcceptedPortfolioShares_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "PortfolioDetails": [ 
      { 
         "ARN": "string",
         "CreatedTime": number,
         "Description": "string",
         "DisplayName": "string",
         "Id": "string",
         "ProviderName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListAcceptedPortfolioShares_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListAcceptedPortfolioShares_ResponseSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [PortfolioDetails](#API_ListAcceptedPortfolioShares_ResponseSyntax) **   <a name="servicecatalog-ListAcceptedPortfolioShares-response-PortfolioDetails"></a>
Information about the portfolios.  
Type: Array of [PortfolioDetail](API_PortfolioDetail.md) objects

## Errors
<a name="API_ListAcceptedPortfolioShares_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

## See Also
<a name="API_ListAcceptedPortfolioShares_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListAcceptedPortfolioShares) 

# ListBudgetsForResource
<a name="API_ListBudgetsForResource"></a>

Lists all the budgets associated to the specified resource.

## Request Syntax
<a name="API_ListBudgetsForResource_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ResourceId": "string"
}
```

## Request Parameters
<a name="API_ListBudgetsForResource_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListBudgetsForResource_RequestSyntax) **   <a name="servicecatalog-ListBudgetsForResource-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListBudgetsForResource_RequestSyntax) **   <a name="servicecatalog-ListBudgetsForResource-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListBudgetsForResource_RequestSyntax) **   <a name="servicecatalog-ListBudgetsForResource-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ResourceId](#API_ListBudgetsForResource_RequestSyntax) **   <a name="servicecatalog-ListBudgetsForResource-request-ResourceId"></a>
The resource identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListBudgetsForResource_ResponseSyntax"></a>

```
{
   "Budgets": [ 
      { 
         "BudgetName": "string"
      }
   ],
   "NextPageToken": "string"
}
```

## Response Elements
<a name="API_ListBudgetsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Budgets](#API_ListBudgetsForResource_ResponseSyntax) **   <a name="servicecatalog-ListBudgetsForResource-response-Budgets"></a>
Information about the associated budgets.  
Type: Array of [BudgetDetail](API_BudgetDetail.md) objects

 ** [NextPageToken](#API_ListBudgetsForResource_ResponseSyntax) **   <a name="servicecatalog-ListBudgetsForResource-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

## Errors
<a name="API_ListBudgetsForResource_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListBudgetsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListBudgetsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListBudgetsForResource) 

# ListConstraintsForPortfolio
<a name="API_ListConstraintsForPortfolio"></a>

Lists the constraints for the specified portfolio and product.

## Request Syntax
<a name="API_ListConstraintsForPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string",
   "ProductId": "string",
   "ProductName": "string"
}
```

## Request Parameters
<a name="API_ListConstraintsForPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProductId](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductName](#API_ListConstraintsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-request-ProductName"></a>
  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

## Response Syntax
<a name="API_ListConstraintsForPortfolio_ResponseSyntax"></a>

```
{
   "ConstraintDetails": [ 
      { 
         "ConstraintId": "string",
         "Description": "string",
         "Owner": "string",
         "PortfolioId": "string",
         "ProductId": "string",
         "Type": "string"
      }
   ],
   "NextPageToken": "string"
}
```

## Response Elements
<a name="API_ListConstraintsForPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConstraintDetails](#API_ListConstraintsForPortfolio_ResponseSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-response-ConstraintDetails"></a>
Information about the constraints.  
Type: Array of [ConstraintDetail](API_ConstraintDetail.md) objects

 ** [NextPageToken](#API_ListConstraintsForPortfolio_ResponseSyntax) **   <a name="servicecatalog-ListConstraintsForPortfolio-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

## Errors
<a name="API_ListConstraintsForPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListConstraintsForPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListConstraintsForPortfolio) 

# ListLaunchPaths
<a name="API_ListLaunchPaths"></a>

 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. 

**Note**  
 When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see [Granting users access](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) in the *Service Catalog User Guide*. 

## Request Syntax
<a name="API_ListLaunchPaths_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ProductId": "string"
}
```

## Request Parameters
<a name="API_ListLaunchPaths_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListLaunchPaths_RequestSyntax) **   <a name="servicecatalog-ListLaunchPaths-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListLaunchPaths_RequestSyntax) **   <a name="servicecatalog-ListLaunchPaths-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListLaunchPaths_RequestSyntax) **   <a name="servicecatalog-ListLaunchPaths-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProductId](#API_ListLaunchPaths_RequestSyntax) **   <a name="servicecatalog-ListLaunchPaths-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListLaunchPaths_ResponseSyntax"></a>

```
{
   "LaunchPathSummaries": [ 
      { 
         "ConstraintSummaries": [ 
            { 
               "Description": "string",
               "Type": "string"
            }
         ],
         "Id": "string",
         "Name": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "NextPageToken": "string"
}
```

## Response Elements
<a name="API_ListLaunchPaths_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LaunchPathSummaries](#API_ListLaunchPaths_ResponseSyntax) **   <a name="servicecatalog-ListLaunchPaths-response-LaunchPathSummaries"></a>
Information about the launch path.  
Type: Array of [LaunchPathSummary](API_LaunchPathSummary.md) objects

 ** [NextPageToken](#API_ListLaunchPaths_ResponseSyntax) **   <a name="servicecatalog-ListLaunchPaths-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

## Errors
<a name="API_ListLaunchPaths_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListLaunchPaths_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListLaunchPaths) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListLaunchPaths) 

# ListOrganizationPortfolioAccess
<a name="API_ListOrganizationPortfolioAccess"></a>

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.

If a delegated admin is de-registered, they can no longer perform this operation.

## Request Syntax
<a name="API_ListOrganizationPortfolioAccess_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "OrganizationNodeType": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string"
}
```

## Request Parameters
<a name="API_ListOrganizationPortfolioAccess_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListOrganizationPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [OrganizationNodeType](#API_ListOrganizationPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-request-OrganizationNodeType"></a>
The organization node type that will be returned in the output.  
+  `ORGANIZATION` - Organization that has access to the portfolio. 
+  `ORGANIZATIONAL_UNIT` - Organizational unit that has access to the portfolio within your organization.
+  `ACCOUNT` - Account that has access to the portfolio within your organization.
Type: String  
Valid Values: `ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT`   
Required: Yes

 ** [PageSize](#API_ListOrganizationPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListOrganizationPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_ListOrganizationPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-request-PortfolioId"></a>
The portfolio identifier. For example, `port-2abcdext3y5fk`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListOrganizationPortfolioAccess_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "OrganizationNodes": [ 
      { 
         "Type": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListOrganizationPortfolioAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListOrganizationPortfolioAccess_ResponseSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [OrganizationNodes](#API_ListOrganizationPortfolioAccess_ResponseSyntax) **   <a name="servicecatalog-ListOrganizationPortfolioAccess-response-OrganizationNodes"></a>
Displays information about the organization nodes.  
Type: Array of [OrganizationNode](API_OrganizationNode.md) objects

## Errors
<a name="API_ListOrganizationPortfolioAccess_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListOrganizationPortfolioAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListOrganizationPortfolioAccess) 

# ListPortfolioAccess
<a name="API_ListPortfolioAccess"></a>

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

A delegated admin can list the accounts that have access to the shared portfolio. Note that if a delegated admin is de-registered, they can no longer perform this operation.

## Request Syntax
<a name="API_ListPortfolioAccess_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "OrganizationParentId": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string"
}
```

## Request Parameters
<a name="API_ListPortfolioAccess_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListPortfolioAccess-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [OrganizationParentId](#API_ListPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListPortfolioAccess-request-OrganizationParentId"></a>
The ID of an organization node the portfolio is shared with. All children of this node with an inherited portfolio share will be returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PageSize](#API_ListPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListPortfolioAccess-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_ListPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListPortfolioAccess-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_ListPortfolioAccess_RequestSyntax) **   <a name="servicecatalog-ListPortfolioAccess-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListPortfolioAccess_ResponseSyntax"></a>

```
{
   "AccountIds": [ "string" ],
   "NextPageToken": "string"
}
```

## Response Elements
<a name="API_ListPortfolioAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AccountIds](#API_ListPortfolioAccess_ResponseSyntax) **   <a name="servicecatalog-ListPortfolioAccess-response-AccountIds"></a>
Information about the AWS accounts with access to the portfolio.  
Type: Array of strings  
Pattern: `^[0-9]{12}$` 

 ** [NextPageToken](#API_ListPortfolioAccess_ResponseSyntax) **   <a name="servicecatalog-ListPortfolioAccess-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

## Errors
<a name="API_ListPortfolioAccess_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListPortfolioAccess_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListPortfolioAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListPortfolioAccess) 

# ListPortfolios
<a name="API_ListPortfolios"></a>

Lists all portfolios in the catalog.

## Request Syntax
<a name="API_ListPortfolios_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string"
}
```

## Request Parameters
<a name="API_ListPortfolios_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListPortfolios_RequestSyntax) **   <a name="servicecatalog-ListPortfolios-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListPortfolios_RequestSyntax) **   <a name="servicecatalog-ListPortfolios-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_ListPortfolios_RequestSyntax) **   <a name="servicecatalog-ListPortfolios-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

## Response Syntax
<a name="API_ListPortfolios_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "PortfolioDetails": [ 
      { 
         "ARN": "string",
         "CreatedTime": number,
         "Description": "string",
         "DisplayName": "string",
         "Id": "string",
         "ProviderName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPortfolios_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListPortfolios_ResponseSyntax) **   <a name="servicecatalog-ListPortfolios-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [PortfolioDetails](#API_ListPortfolios_ResponseSyntax) **   <a name="servicecatalog-ListPortfolios-response-PortfolioDetails"></a>
Information about the portfolios.  
Type: Array of [PortfolioDetail](API_PortfolioDetail.md) objects

## Errors
<a name="API_ListPortfolios_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListPortfolios_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListPortfolios) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListPortfolios) 

# ListPortfoliosForProduct
<a name="API_ListPortfoliosForProduct"></a>

Lists all portfolios that the specified product is associated with.

## Request Syntax
<a name="API_ListPortfoliosForProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ProductId": "string"
}
```

## Request Parameters
<a name="API_ListPortfoliosForProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListPortfoliosForProduct_RequestSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListPortfoliosForProduct_RequestSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_ListPortfoliosForProduct_RequestSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProductId](#API_ListPortfoliosForProduct_RequestSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListPortfoliosForProduct_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "PortfolioDetails": [ 
      { 
         "ARN": "string",
         "CreatedTime": number,
         "Description": "string",
         "DisplayName": "string",
         "Id": "string",
         "ProviderName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPortfoliosForProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListPortfoliosForProduct_ResponseSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [PortfolioDetails](#API_ListPortfoliosForProduct_ResponseSyntax) **   <a name="servicecatalog-ListPortfoliosForProduct-response-PortfolioDetails"></a>
Information about the portfolios.  
Type: Array of [PortfolioDetail](API_PortfolioDetail.md) objects

## Errors
<a name="API_ListPortfoliosForProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListPortfoliosForProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListPortfoliosForProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListPortfoliosForProduct) 

# ListPrincipalsForPortfolio
<a name="API_ListPrincipalsForPortfolio"></a>

Lists all `PrincipalARN`s and corresponding `PrincipalType`s associated with the specified portfolio.

## Request Syntax
<a name="API_ListPrincipalsForPortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string"
}
```

## Request Parameters
<a name="API_ListPrincipalsForPortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListPrincipalsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListPrincipalsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListPrincipalsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_ListPrincipalsForPortfolio_RequestSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListPrincipalsForPortfolio_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "Principals": [ 
      { 
         "PrincipalARN": "string",
         "PrincipalType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPrincipalsForPortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListPrincipalsForPortfolio_ResponseSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [Principals](#API_ListPrincipalsForPortfolio_ResponseSyntax) **   <a name="servicecatalog-ListPrincipalsForPortfolio-response-Principals"></a>
The `PrincipalARN`s and corresponding `PrincipalType`s associated with the portfolio.  
Type: Array of [Principal](API_Principal.md) objects

## Errors
<a name="API_ListPrincipalsForPortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListPrincipalsForPortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListPrincipalsForPortfolio) 

# ListProvisionedProductPlans
<a name="API_ListProvisionedProductPlans"></a>

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

## Request Syntax
<a name="API_ListProvisionedProductPlans_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccessLevelFilter": { 
      "Key": "string",
      "Value": "string"
   },
   "PageSize": number,
   "PageToken": "string",
   "ProvisionProductId": "string"
}
```

## Request Parameters
<a name="API_ListProvisionedProductPlans_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListProvisionedProductPlans_RequestSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccessLevelFilter](#API_ListProvisionedProductPlans_RequestSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-request-AccessLevelFilter"></a>
The access level to use to obtain results. The default is `User`.  
Type: [AccessLevelFilter](API_AccessLevelFilter.md) object  
Required: No

 ** [PageSize](#API_ListProvisionedProductPlans_RequestSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListProvisionedProductPlans_RequestSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProvisionProductId](#API_ListProvisionedProductPlans_RequestSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-request-ProvisionProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

## Response Syntax
<a name="API_ListProvisionedProductPlans_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisionedProductPlans": [ 
      { 
         "PlanId": "string",
         "PlanName": "string",
         "PlanType": "string",
         "ProvisioningArtifactId": "string",
         "ProvisionProductId": "string",
         "ProvisionProductName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProvisionedProductPlans_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListProvisionedProductPlans_ResponseSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisionedProductPlans](#API_ListProvisionedProductPlans_ResponseSyntax) **   <a name="servicecatalog-ListProvisionedProductPlans-response-ProvisionedProductPlans"></a>
Information about the plans.  
Type: Array of [ProvisionedProductPlanSummary](API_ProvisionedProductPlanSummary.md) objects

## Errors
<a name="API_ListProvisionedProductPlans_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListProvisionedProductPlans_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListProvisionedProductPlans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListProvisionedProductPlans) 

# ListProvisioningArtifacts
<a name="API_ListProvisioningArtifacts"></a>

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

## Request Syntax
<a name="API_ListProvisioningArtifacts_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "ProductId": "string"
}
```

## Request Parameters
<a name="API_ListProvisioningArtifacts_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListProvisioningArtifacts_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifacts-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [ProductId](#API_ListProvisioningArtifacts_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifacts-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListProvisioningArtifacts_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisioningArtifactDetails": [ 
      { 
         "Active": boolean,
         "CreatedTime": number,
         "Description": "string",
         "Guidance": "string",
         "Id": "string",
         "Name": "string",
         "SourceRevision": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListProvisioningArtifacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListProvisioningArtifacts_ResponseSyntax) **   <a name="servicecatalog-ListProvisioningArtifacts-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisioningArtifactDetails](#API_ListProvisioningArtifacts_ResponseSyntax) **   <a name="servicecatalog-ListProvisioningArtifacts-response-ProvisioningArtifactDetails"></a>
Information about the provisioning artifacts.  
Type: Array of [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) objects

## Errors
<a name="API_ListProvisioningArtifacts_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListProvisioningArtifacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListProvisioningArtifacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListProvisioningArtifacts) 

# ListProvisioningArtifactsForServiceAction
<a name="API_ListProvisioningArtifactsForServiceAction"></a>

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

## Request Syntax
<a name="API_ListProvisioningArtifactsForServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ServiceActionId": "string"
}
```

## Request Parameters
<a name="API_ListProvisioningArtifactsForServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListProvisioningArtifactsForServiceAction_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListProvisioningArtifactsForServiceAction_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListProvisioningArtifactsForServiceAction_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ServiceActionId](#API_ListProvisioningArtifactsForServiceAction_RequestSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-request-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListProvisioningArtifactsForServiceAction_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisioningArtifactViews": [ 
      { 
         "ProductViewSummary": { 
            "Distributor": "string",
            "HasDefaultPath": boolean,
            "Id": "string",
            "Name": "string",
            "Owner": "string",
            "ProductId": "string",
            "ShortDescription": "string",
            "SupportDescription": "string",
            "SupportEmail": "string",
            "SupportUrl": "string",
            "Type": "string"
         },
         "ProvisioningArtifact": { 
            "CreatedTime": number,
            "Description": "string",
            "Guidance": "string",
            "Id": "string",
            "Name": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListProvisioningArtifactsForServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListProvisioningArtifactsForServiceAction_ResponseSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisioningArtifactViews](#API_ListProvisioningArtifactsForServiceAction_ResponseSyntax) **   <a name="servicecatalog-ListProvisioningArtifactsForServiceAction-response-ProvisioningArtifactViews"></a>
An array of objects with information about product views and provisioning artifacts.  
Type: Array of [ProvisioningArtifactView](API_ProvisioningArtifactView.md) objects

## Errors
<a name="API_ListProvisioningArtifactsForServiceAction_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListProvisioningArtifactsForServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListProvisioningArtifactsForServiceAction) 

# ListRecordHistory
<a name="API_ListRecordHistory"></a>

Lists the specified requests or all performed requests.

## Request Syntax
<a name="API_ListRecordHistory_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccessLevelFilter": { 
      "Key": "string",
      "Value": "string"
   },
   "PageSize": number,
   "PageToken": "string",
   "SearchFilter": { 
      "Key": "string",
      "Value": "string"
   }
}
```

## Request Parameters
<a name="API_ListRecordHistory_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListRecordHistory_RequestSyntax) **   <a name="servicecatalog-ListRecordHistory-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccessLevelFilter](#API_ListRecordHistory_RequestSyntax) **   <a name="servicecatalog-ListRecordHistory-request-AccessLevelFilter"></a>
The access level to use to obtain results. The default is `User`.  
Type: [AccessLevelFilter](API_AccessLevelFilter.md) object  
Required: No

 ** [PageSize](#API_ListRecordHistory_RequestSyntax) **   <a name="servicecatalog-ListRecordHistory-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListRecordHistory_RequestSyntax) **   <a name="servicecatalog-ListRecordHistory-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [SearchFilter](#API_ListRecordHistory_RequestSyntax) **   <a name="servicecatalog-ListRecordHistory-request-SearchFilter"></a>
The search filter to scope the results.  
Type: [ListRecordHistorySearchFilter](API_ListRecordHistorySearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_ListRecordHistory_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "RecordDetails": [ 
      { 
         "CreatedTime": number,
         "LaunchRoleArn": "string",
         "PathId": "string",
         "ProductId": "string",
         "ProvisionedProductId": "string",
         "ProvisionedProductName": "string",
         "ProvisionedProductType": "string",
         "ProvisioningArtifactId": "string",
         "RecordErrors": [ 
            { 
               "Code": "string",
               "Description": "string"
            }
         ],
         "RecordId": "string",
         "RecordTags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "RecordType": "string",
         "Status": "string",
         "UpdatedTime": number
      }
   ]
}
```

## Response Elements
<a name="API_ListRecordHistory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListRecordHistory_ResponseSyntax) **   <a name="servicecatalog-ListRecordHistory-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [RecordDetails](#API_ListRecordHistory_ResponseSyntax) **   <a name="servicecatalog-ListRecordHistory-response-RecordDetails"></a>
The records, in reverse chronological order.  
Type: Array of [RecordDetail](API_RecordDetail.md) objects

## Errors
<a name="API_ListRecordHistory_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListRecordHistory_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListRecordHistory) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListRecordHistory) 

# ListResourcesForTagOption
<a name="API_ListResourcesForTagOption"></a>

Lists the resources associated with the specified TagOption.

## Request Syntax
<a name="API_ListResourcesForTagOption_RequestSyntax"></a>

```
{
   "PageSize": number,
   "PageToken": "string",
   "ResourceType": "string",
   "TagOptionId": "string"
}
```

## Request Parameters
<a name="API_ListResourcesForTagOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [PageSize](#API_ListResourcesForTagOption_RequestSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListResourcesForTagOption_RequestSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ResourceType](#API_ListResourcesForTagOption_RequestSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-request-ResourceType"></a>
The resource type.  
+  `Portfolio` 
+  `Product` 
Type: String  
Required: No

 ** [TagOptionId](#API_ListResourcesForTagOption_RequestSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-request-TagOptionId"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_ListResourcesForTagOption_ResponseSyntax"></a>

```
{
   "PageToken": "string",
   "ResourceDetails": [ 
      { 
         "ARN": "string",
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListResourcesForTagOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PageToken](#API_ListResourcesForTagOption_ResponseSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-response-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ResourceDetails](#API_ListResourcesForTagOption_ResponseSyntax) **   <a name="servicecatalog-ListResourcesForTagOption-response-ResourceDetails"></a>
Information about the resources.  
Type: Array of [ResourceDetail](API_ResourceDetail.md) objects

## Errors
<a name="API_ListResourcesForTagOption_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_ListResourcesForTagOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListResourcesForTagOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListResourcesForTagOption) 

# ListServiceActions
<a name="API_ListServiceActions"></a>

Lists all self-service actions.

## Request Syntax
<a name="API_ListServiceActions_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string"
}
```

## Request Parameters
<a name="API_ListServiceActions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListServiceActions_RequestSyntax) **   <a name="servicecatalog-ListServiceActions-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListServiceActions_RequestSyntax) **   <a name="servicecatalog-ListServiceActions-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListServiceActions_RequestSyntax) **   <a name="servicecatalog-ListServiceActions-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

## Response Syntax
<a name="API_ListServiceActions_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ServiceActionSummaries": [ 
      { 
         "DefinitionType": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceActions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListServiceActions_ResponseSyntax) **   <a name="servicecatalog-ListServiceActions-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ServiceActionSummaries](#API_ListServiceActions_ResponseSyntax) **   <a name="servicecatalog-ListServiceActions-response-ServiceActionSummaries"></a>
An object containing information about the service actions associated with the provisioning artifact.  
Type: Array of [ServiceActionSummary](API_ServiceActionSummary.md) objects

## Errors
<a name="API_ListServiceActions_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ListServiceActions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListServiceActions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListServiceActions) 

# ListServiceActionsForProvisioningArtifact
<a name="API_ListServiceActionsForProvisioningArtifact"></a>

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

## Request Syntax
<a name="API_ListServiceActionsForProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string"
}
```

## Request Parameters
<a name="API_ListServiceActionsForProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListServiceActionsForProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListServiceActionsForProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListServiceActionsForProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProductId](#API_ListServiceActionsForProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-request-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_ListServiceActionsForProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListServiceActionsForProvisioningArtifact_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ServiceActionSummaries": [ 
      { 
         "DefinitionType": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListServiceActionsForProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListServiceActionsForProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ServiceActionSummaries](#API_ListServiceActionsForProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-ListServiceActionsForProvisioningArtifact-response-ServiceActionSummaries"></a>
An object containing information about the self-service actions associated with the provisioning artifact.  
Type: Array of [ServiceActionSummary](API_ServiceActionSummary.md) objects

## Errors
<a name="API_ListServiceActionsForProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListServiceActionsForProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListServiceActionsForProvisioningArtifact) 

# ListStackInstancesForProvisionedProduct
<a name="API_ListStackInstancesForProvisionedProduct"></a>

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 AWS account name or Region. 

## Request Syntax
<a name="API_ListStackInstancesForProvisionedProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PageSize": number,
   "PageToken": "string",
   "ProvisionedProductId": "string"
}
```

## Request Parameters
<a name="API_ListStackInstancesForProvisionedProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ListStackInstancesForProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PageSize](#API_ListStackInstancesForProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListStackInstancesForProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [ProvisionedProductId](#API_ListStackInstancesForProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-request-ProvisionedProductId"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_ListStackInstancesForProvisionedProduct_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "StackInstances": [ 
      { 
         "Account": "string",
         "Region": "string",
         "StackInstanceStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListStackInstancesForProvisionedProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ListStackInstancesForProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [StackInstances](#API_ListStackInstancesForProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-ListStackInstancesForProvisionedProduct-response-StackInstances"></a>
List of stack instances.  
Type: Array of [StackInstance](API_StackInstance.md) objects

## Errors
<a name="API_ListStackInstancesForProvisionedProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ListStackInstancesForProvisionedProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListStackInstancesForProvisionedProduct) 

# ListTagOptions
<a name="API_ListTagOptions"></a>

Lists the specified TagOptions or all TagOptions.

## Request Syntax
<a name="API_ListTagOptions_RequestSyntax"></a>

```
{
   "Filters": { 
      "Active": boolean,
      "Key": "string",
      "Value": "string"
   },
   "PageSize": number,
   "PageToken": "string"
}
```

## Request Parameters
<a name="API_ListTagOptions_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Filters](#API_ListTagOptions_RequestSyntax) **   <a name="servicecatalog-ListTagOptions-request-Filters"></a>
The search filters. If no search filters are specified, the output includes all TagOptions.  
Type: [ListTagOptionsFilters](API_ListTagOptionsFilters.md) object  
Required: No

 ** [PageSize](#API_ListTagOptions_RequestSyntax) **   <a name="servicecatalog-ListTagOptions-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ListTagOptions_RequestSyntax) **   <a name="servicecatalog-ListTagOptions-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

## Response Syntax
<a name="API_ListTagOptions_ResponseSyntax"></a>

```
{
   "PageToken": "string",
   "TagOptionDetails": [ 
      { 
         "Active": boolean,
         "Id": "string",
         "Key": "string",
         "Owner": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PageToken](#API_ListTagOptions_ResponseSyntax) **   <a name="servicecatalog-ListTagOptions-response-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [TagOptionDetails](#API_ListTagOptions_ResponseSyntax) **   <a name="servicecatalog-ListTagOptions-response-TagOptionDetails"></a>
Information about the TagOptions.  
Type: Array of [TagOptionDetail](API_TagOptionDetail.md) objects

## Errors
<a name="API_ListTagOptions_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_ListTagOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ListTagOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListTagOptions) 

# NotifyProvisionProductEngineWorkflowResult
<a name="API_NotifyProvisionProductEngineWorkflowResult"></a>

 Notifies the result of the provisioning engine execution. 

## Request Syntax
<a name="API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax"></a>

```
{
   "FailureReason": "string",
   "IdempotencyToken": "string",
   "Outputs": [ 
      { 
         "Description": "string",
         "OutputKey": "string",
         "OutputValue": "string"
      }
   ],
   "RecordId": "string",
   "ResourceIdentifier": { 
      "UniqueTag": { 
         "Key": "string",
         "Value": "string"
      }
   },
   "Status": "string",
   "WorkflowToken": "string"
}
```

## Request Parameters
<a name="API_NotifyProvisionProductEngineWorkflowResult_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [FailureReason](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-FailureReason"></a>
 The reason why the provisioning engine execution failed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [IdempotencyToken](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-IdempotencyToken"></a>
 The idempotency token that identifies the provisioning engine execution.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Outputs](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-Outputs"></a>
 The output of the provisioning engine execution.   
Type: Array of [RecordOutput](API_RecordOutput.md) objects  
Required: No

 ** [RecordId](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-RecordId"></a>
 The identifier of the record.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ResourceIdentifier](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-ResourceIdentifier"></a>
 The ID for the provisioned product resources that are part of a resource group.   
Type: [EngineWorkflowResourceIdentifier](API_EngineWorkflowResourceIdentifier.md) object  
Required: No

 ** [Status](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-Status"></a>
 The status of the provisioning engine execution.   
Type: String  
Valid Values: `SUCCEEDED | FAILED`   
Required: Yes

 ** [WorkflowToken](#API_NotifyProvisionProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyProvisionProductEngineWorkflowResult-request-WorkflowToken"></a>
 The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20000.  
Pattern: `[0-9A-Za-z+\/\-=]+`   
Required: Yes

## Response Elements
<a name="API_NotifyProvisionProductEngineWorkflowResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_NotifyProvisionProductEngineWorkflowResult_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_NotifyProvisionProductEngineWorkflowResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/NotifyProvisionProductEngineWorkflowResult) 

# NotifyTerminateProvisionedProductEngineWorkflowResult
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult"></a>

 Notifies the result of the terminate engine execution. 

## Request Syntax
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax"></a>

```
{
   "FailureReason": "string",
   "IdempotencyToken": "string",
   "RecordId": "string",
   "Status": "string",
   "WorkflowToken": "string"
}
```

## Request Parameters
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [FailureReason](#API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyTerminateProvisionedProductEngineWorkflowResult-request-FailureReason"></a>
 The reason why the terminate engine execution failed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [IdempotencyToken](#API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyTerminateProvisionedProductEngineWorkflowResult-request-IdempotencyToken"></a>
 The idempotency token that identifies the terminate engine execution.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [RecordId](#API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyTerminateProvisionedProductEngineWorkflowResult-request-RecordId"></a>
 The identifier of the record.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Status](#API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyTerminateProvisionedProductEngineWorkflowResult-request-Status"></a>
 The status of the terminate engine execution.   
Type: String  
Valid Values: `SUCCEEDED | FAILED`   
Required: Yes

 ** [WorkflowToken](#API_NotifyTerminateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyTerminateProvisionedProductEngineWorkflowResult-request-WorkflowToken"></a>
 The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20000.  
Pattern: `[0-9A-Za-z+\/\-=]+`   
Required: Yes

## Response Elements
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_NotifyTerminateProvisionedProductEngineWorkflowResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/NotifyTerminateProvisionedProductEngineWorkflowResult) 

# NotifyUpdateProvisionedProductEngineWorkflowResult
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult"></a>

 Notifies the result of the update engine execution. 

## Request Syntax
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax"></a>

```
{
   "FailureReason": "string",
   "IdempotencyToken": "string",
   "Outputs": [ 
      { 
         "Description": "string",
         "OutputKey": "string",
         "OutputValue": "string"
      }
   ],
   "RecordId": "string",
   "Status": "string",
   "WorkflowToken": "string"
}
```

## Request Parameters
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [FailureReason](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-FailureReason"></a>
 The reason why the update engine execution failed.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [IdempotencyToken](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-IdempotencyToken"></a>
 The idempotency token that identifies the update engine execution.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Outputs](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-Outputs"></a>
 The output of the update engine execution.   
Type: Array of [RecordOutput](API_RecordOutput.md) objects  
Required: No

 ** [RecordId](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-RecordId"></a>
 The identifier of the record.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Status](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-Status"></a>
 The status of the update engine execution.   
Type: String  
Valid Values: `SUCCEEDED | FAILED`   
Required: Yes

 ** [WorkflowToken](#API_NotifyUpdateProvisionedProductEngineWorkflowResult_RequestSyntax) **   <a name="servicecatalog-NotifyUpdateProvisionedProductEngineWorkflowResult-request-WorkflowToken"></a>
 The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20000.  
Pattern: `[0-9A-Za-z+\/\-=]+`   
Required: Yes

## Response Elements
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_NotifyUpdateProvisionedProductEngineWorkflowResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/NotifyUpdateProvisionedProductEngineWorkflowResult) 

# ProvisionProduct
<a name="API_ProvisionProduct"></a>

 Provisions the specified product. 

 A provisioned product is a resourced instance of a product. For example, provisioning a product that's based on an AWS CloudFormation template launches an AWS CloudFormation stack and its underlying resources. You can check the status of this request using [DescribeRecord](API_DescribeRecord.md). 

 If the request contains a tag key with an empty list of values, there's a tag conflict for that key. Don't include conflicted keys as tags, or this will cause the error "Parameter validation failed: Missing required parameter in Tags[*N*]:*Value*". 

**Note**  
 When provisioning a product that's been added to a portfolio, you must grant your user, group, or role access to the portfolio. For more information, see [Granting users access](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_users.html) in the *Service Catalog User Guide*. 

## Request Syntax
<a name="API_ProvisionProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "NotificationArns": [ "string" ],
   "PathId": "string",
   "PathName": "string",
   "ProductId": "string",
   "ProductName": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ProvisioningPreferences": { 
      "StackSetAccounts": [ "string" ],
      "StackSetFailureToleranceCount": number,
      "StackSetFailureTolerancePercentage": number,
      "StackSetMaxConcurrencyCount": number,
      "StackSetMaxConcurrencyPercentage": number,
      "StackSetRegions": [ "string" ]
   },
   "ProvisionToken": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_ProvisionProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [NotificationArns](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-NotificationArns"></a>
Passed to AWS CloudFormation. The SNS topic ARNs to which to publish stack-related events.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [PathId](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-PathId"></a>
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](API_ListLaunchPaths.md). You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PathName](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-PathName"></a>
The name of the path. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ProductId](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProductId"></a>
The product identifier. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductName](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProductName"></a>
The name of the product. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [ProvisionedProductName](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisionedProductName"></a>
A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisioningArtifactName](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisioningArtifactName"></a>
The name of the provisioning artifact. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** [ProvisioningParameters](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisioningParameters"></a>
Parameters specified by the administrator that are required for provisioning the product.  
Type: Array of [ProvisioningParameter](API_ProvisioningParameter.md) objects  
Required: No

 ** [ProvisioningPreferences](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisioningPreferences"></a>
An object that contains information about the provisioning preferences for a stack set.  
Type: [ProvisioningPreferences](API_ProvisioningPreferences.md) object  
Required: No

 ** [ProvisionToken](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-ProvisionToken"></a>
An idempotency token that uniquely identifies the provisioning request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [Tags](#API_ProvisionProduct_RequestSyntax) **   <a name="servicecatalog-ProvisionProduct-request-Tags"></a>
One or more tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_ProvisionProduct_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_ProvisionProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_ProvisionProduct_ResponseSyntax) **   <a name="servicecatalog-ProvisionProduct-response-RecordDetail"></a>
Information about the result of provisioning the product.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_ProvisionProduct_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_ProvisionProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ProvisionProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisionProduct) 

# RejectPortfolioShare
<a name="API_RejectPortfolioShare"></a>

Rejects an offer to share the specified portfolio.

## Request Syntax
<a name="API_RejectPortfolioShare_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PortfolioId": "string",
   "PortfolioShareType": "string"
}
```

## Request Parameters
<a name="API_RejectPortfolioShare_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_RejectPortfolioShare_RequestSyntax) **   <a name="servicecatalog-RejectPortfolioShare-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PortfolioId](#API_RejectPortfolioShare_RequestSyntax) **   <a name="servicecatalog-RejectPortfolioShare-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [PortfolioShareType](#API_RejectPortfolioShare_RequestSyntax) **   <a name="servicecatalog-RejectPortfolioShare-request-PortfolioShareType"></a>
The type of shared portfolios to reject. The default is to reject imported portfolios.  
+  `AWS_ORGANIZATIONS` - Reject portfolios shared by the management account of your organization.
+  `IMPORTED` - Reject imported portfolios.
+  `AWS_SERVICECATALOG` - Not supported. (Throws ResourceNotFoundException.)
For example, `aws servicecatalog reject-portfolio-share --portfolio-id "port-2qwzkwxt3y5fk" --portfolio-share-type AWS_ORGANIZATIONS`   
Type: String  
Valid Values: `IMPORTED | AWS_SERVICECATALOG | AWS_ORGANIZATIONS`   
Required: No

## Response Elements
<a name="API_RejectPortfolioShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RejectPortfolioShare_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_RejectPortfolioShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/RejectPortfolioShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/RejectPortfolioShare) 

# ScanProvisionedProducts
<a name="API_ScanProvisionedProducts"></a>

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

To use additional filtering, see [SearchProvisionedProducts](API_SearchProvisionedProducts.md).

## Request Syntax
<a name="API_ScanProvisionedProducts_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccessLevelFilter": { 
      "Key": "string",
      "Value": "string"
   },
   "PageSize": number,
   "PageToken": "string"
}
```

## Request Parameters
<a name="API_ScanProvisionedProducts_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_ScanProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccessLevelFilter](#API_ScanProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-request-AccessLevelFilter"></a>
The access level to use to obtain results. The default is `User`.  
Type: [AccessLevelFilter](API_AccessLevelFilter.md) object  
Required: No

 ** [PageSize](#API_ScanProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 20.  
Required: No

 ** [PageToken](#API_ScanProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

## Response Syntax
<a name="API_ScanProvisionedProducts_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisionedProducts": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Id": "string",
         "IdempotencyToken": "string",
         "LastProvisioningRecordId": "string",
         "LastRecordId": "string",
         "LastSuccessfulProvisioningRecordId": "string",
         "LaunchRoleArn": "string",
         "Name": "string",
         "ProductId": "string",
         "ProvisioningArtifactId": "string",
         "Status": "string",
         "StatusMessage": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ScanProvisionedProducts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_ScanProvisionedProducts_ResponseSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisionedProducts](#API_ScanProvisionedProducts_ResponseSyntax) **   <a name="servicecatalog-ScanProvisionedProducts-response-ProvisionedProducts"></a>
Information about the provisioned products.  
Type: Array of [ProvisionedProductDetail](API_ProvisionedProductDetail.md) objects

## Errors
<a name="API_ScanProvisionedProducts_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_ScanProvisionedProducts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/ScanProvisionedProducts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ScanProvisionedProducts) 

# SearchProducts
<a name="API_SearchProducts"></a>

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

## Request Syntax
<a name="API_SearchProducts_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Filters": { 
      "string" : [ "string" ]
   },
   "PageSize": number,
   "PageToken": "string",
   "SortBy": "string",
   "SortOrder": "string"
}
```

## Request Parameters
<a name="API_SearchProducts_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Filters](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-Filters"></a>
The search filters. If no search filters are specified, the output includes all products to which the caller has access.  
Type: String to array of strings map  
Valid Keys: `FullTextSearch | Owner | ProductType | SourceProductId`   
Required: No

 ** [PageSize](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [SortBy](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-SortBy"></a>
The sort field. If no value is specified, the results are not sorted.  
Type: String  
Valid Values: `Title | VersionCount | CreationDate`   
Required: No

 ** [SortOrder](#API_SearchProducts_RequestSyntax) **   <a name="servicecatalog-SearchProducts-request-SortOrder"></a>
The sort order. If no value is specified, the results are not sorted.  
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

## Response Syntax
<a name="API_SearchProducts_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProductViewAggregations": { 
      "string" : [ 
         { 
            "ApproximateCount": number,
            "Value": "string"
         }
      ]
   },
   "ProductViewSummaries": [ 
      { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchProducts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_SearchProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProducts-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProductViewAggregations](#API_SearchProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProducts-response-ProductViewAggregations"></a>
The product view aggregations.  
Type: String to array of [ProductViewAggregationValue](API_ProductViewAggregationValue.md) objects map

 ** [ProductViewSummaries](#API_SearchProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProducts-response-ProductViewSummaries"></a>
Information about the product views.  
Type: Array of [ProductViewSummary](API_ProductViewSummary.md) objects

## Errors
<a name="API_SearchProducts_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## Examples
<a name="API_SearchProducts_Examples"></a>

### Search for all available products
<a name="API_SearchProducts_Example_1"></a>

The following JSON example retrieves all products available to the current user.

#### Sample Request
<a name="API_SearchProducts_Example_1_Request"></a>

```
POST
/
content-type:application/x-amz-json-1.1
host:servicecatalog.us-west-2.amazonaws.com
user-agent:aws-cli/1.10.19 Python/2.7.10 Darwin/15.5.0 botocore/1.4.10
x-amz-date:20160607T224008Z
x-amz-target:AWS242ServiceCatalogService.SearchProducts
```

#### Sample Response
<a name="API_SearchProducts_Example_1_Response"></a>

```
{
   "ProductViewAggregations":
   {
      "Owner":
      [
         {
            "ApproximateCount":4,
            "Value":"387896429941"
         }
      ],
      "ProductType":
      [
         {
            "ApproximateCount":4,
            "Value":"ServiceCatalog"
         }
      ],
      "Vendor":
      [
         {
            "ApproximateCount":1,
            "Value":""
         },
         {
            "ApproximateCount":1,
            "Value":"me"
         }
      ]
   },
   "ProductViewSummaries":
   [
      {
         "HasDefaultPath":false,
         "Id":"prodview-w35uhtf6nrqqy",
         "Name":"RDS template",
         "Owner":"AWS",
         "ProductId":"prod-3tsertlc2g7pw",
         "ShortDescription":"Test 2",
         "Type":"Base"
      },
      {
         "HasDefaultPath":false,
         "Id":"prodview-r2tzjgsao7mc4",
         "Name":"Devo enviro 2",
         "Owner":"asda",
         "ProductId":"prod-enx2jvf33gi52",
         "ShortDescription":"asd",
         "Type":"Base"
      },
      {
         "Distributor":"",
         "HasDefaultPath":false,
         "Id":"prodview-e64tf73gp3gl4",
         "Name":"Devo environment",
         "Owner":"test",
         "ProductId":"prod-3p2k2ejvcsdvi",
         "ShortDescription":"test",
         "Type":"Base"
      },
      {
         "Distributor":"Me",
         "HasDefaultPath":false,
         "Id":"prodview-3fmrw464floam",
         "Name":"Testtemplate",
         "Owner":"MSP XYZ",
         "ProductId":"prod-eqeqzgemstiea",
         "ShortDescription":"asdas",
         "Type":"Base"
      }
   ]
}
```

## See Also
<a name="API_SearchProducts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/SearchProducts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SearchProducts) 

# SearchProductsAsAdmin
<a name="API_SearchProductsAsAdmin"></a>

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

## Request Syntax
<a name="API_SearchProductsAsAdmin_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Filters": { 
      "string" : [ "string" ]
   },
   "PageSize": number,
   "PageToken": "string",
   "PortfolioId": "string",
   "ProductSource": "string",
   "SortBy": "string",
   "SortOrder": "string"
}
```

## Request Parameters
<a name="API_SearchProductsAsAdmin_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Filters](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-Filters"></a>
The search filters. If no search filters are specified, the output includes all products to which the administrator has access.  
Type: String to array of strings map  
Valid Keys: `FullTextSearch | Owner | ProductType | SourceProductId`   
Required: No

 ** [PageSize](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [PortfolioId](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-PortfolioId"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductSource](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-ProductSource"></a>
Access level of the source of the product.  
Type: String  
Valid Values: `ACCOUNT`   
Required: No

 ** [SortBy](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-SortBy"></a>
The sort field. If no value is specified, the results are not sorted.  
Type: String  
Valid Values: `Title | VersionCount | CreationDate`   
Required: No

 ** [SortOrder](#API_SearchProductsAsAdmin_RequestSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-request-SortOrder"></a>
The sort order. If no value is specified, the results are not sorted.  
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

## Response Syntax
<a name="API_SearchProductsAsAdmin_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProductViewDetails": [ 
      { 
         "CreatedTime": number,
         "ProductARN": "string",
         "ProductViewSummary": { 
            "Distributor": "string",
            "HasDefaultPath": boolean,
            "Id": "string",
            "Name": "string",
            "Owner": "string",
            "ProductId": "string",
            "ShortDescription": "string",
            "SupportDescription": "string",
            "SupportEmail": "string",
            "SupportUrl": "string",
            "Type": "string"
         },
         "SourceConnection": { 
            "ConnectionParameters": { 
               "CodeStar": { 
                  "ArtifactPath": "string",
                  "Branch": "string",
                  "ConnectionArn": "string",
                  "Repository": "string"
               }
            },
            "LastSync": { 
               "LastSuccessfulSyncProvisioningArtifactId": "string",
               "LastSuccessfulSyncTime": number,
               "LastSyncStatus": "string",
               "LastSyncStatusMessage": "string",
               "LastSyncTime": number
            },
            "Type": "string"
         },
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchProductsAsAdmin_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_SearchProductsAsAdmin_ResponseSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProductViewDetails](#API_SearchProductsAsAdmin_ResponseSyntax) **   <a name="servicecatalog-SearchProductsAsAdmin-response-ProductViewDetails"></a>
Information about the product views.  
Type: Array of [ProductViewDetail](API_ProductViewDetail.md) objects

## Errors
<a name="API_SearchProductsAsAdmin_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_SearchProductsAsAdmin_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/SearchProductsAsAdmin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SearchProductsAsAdmin) 

# SearchProvisionedProducts
<a name="API_SearchProvisionedProducts"></a>

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

## Request Syntax
<a name="API_SearchProvisionedProducts_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccessLevelFilter": { 
      "Key": "string",
      "Value": "string"
   },
   "Filters": { 
      "string" : [ "string" ]
   },
   "PageSize": number,
   "PageToken": "string",
   "SortBy": "string",
   "SortOrder": "string"
}
```

## Request Parameters
<a name="API_SearchProvisionedProducts_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccessLevelFilter](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-AccessLevelFilter"></a>
The access level to use to obtain results. The default is `Account`.  
Type: [AccessLevelFilter](API_AccessLevelFilter.md) object  
Required: No

 ** [Filters](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-Filters"></a>
The search filters.  
When the key is `SearchQuery`, the searchable fields are `arn`, `createdTime`, `id`, `lastRecordId`, `idempotencyToken`, `name`, `physicalId`, `productId`, `provisioningArtifactId`, `type`, `status`, `tags`, `userArn`, `userArnSession`, `lastProvisioningRecordId`, `lastSuccessfulProvisioningRecordId`, `productName`, and `provisioningArtifactName`.  
Example: `"SearchQuery":["status:AVAILABLE"]`   
Type: String to array of strings map  
Valid Keys: `SearchQuery`   
Required: No

 ** [PageSize](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-PageSize"></a>
The maximum number of items to return with this call.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [PageToken](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-PageToken"></a>
The page token for the next set of results. To retrieve the first set of results, use null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** [SortBy](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-SortBy"></a>
The sort field. If no value is specified, the results are not sorted. The valid values are `arn`, `id`, `name`, and `lastRecordId`.  
Type: String  
Required: No

 ** [SortOrder](#API_SearchProvisionedProducts_RequestSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-request-SortOrder"></a>
The sort order. If no value is specified, the results are not sorted.  
Type: String  
Valid Values: `ASCENDING | DESCENDING`   
Required: No

## Response Syntax
<a name="API_SearchProvisionedProducts_ResponseSyntax"></a>

```
{
   "NextPageToken": "string",
   "ProvisionedProducts": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Id": "string",
         "IdempotencyToken": "string",
         "LastProvisioningRecordId": "string",
         "LastRecordId": "string",
         "LastSuccessfulProvisioningRecordId": "string",
         "LaunchRoleArn": "string",
         "Name": "string",
         "PhysicalId": "string",
         "ProductId": "string",
         "ProductName": "string",
         "ProvisioningArtifactId": "string",
         "ProvisioningArtifactName": "string",
         "Status": "string",
         "StatusMessage": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "Type": "string",
         "UserArn": "string",
         "UserArnSession": "string"
      }
   ],
   "TotalResultsCount": number
}
```

## Response Elements
<a name="API_SearchProvisionedProducts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextPageToken](#API_SearchProvisionedProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-response-NextPageToken"></a>
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.  
Type: String  
Length Constraints: Maximum length of 2024.  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*` 

 ** [ProvisionedProducts](#API_SearchProvisionedProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-response-ProvisionedProducts"></a>
Information about the provisioned products.  
Type: Array of [ProvisionedProductAttribute](API_ProvisionedProductAttribute.md) objects

 ** [TotalResultsCount](#API_SearchProvisionedProducts_ResponseSyntax) **   <a name="servicecatalog-SearchProvisionedProducts-response-TotalResultsCount"></a>
The number of provisioned products found.  
Type: Integer

## Errors
<a name="API_SearchProvisionedProducts_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

## See Also
<a name="API_SearchProvisionedProducts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/SearchProvisionedProducts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SearchProvisionedProducts) 

# TerminateProvisionedProduct
<a name="API_TerminateProvisionedProduct"></a>

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](API_DescribeRecord.md).

## Request Syntax
<a name="API_TerminateProvisionedProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IgnoreErrors": boolean,
   "ProvisionedProductId": "string",
   "ProvisionedProductName": "string",
   "RetainPhysicalResources": boolean,
   "TerminateToken": "string"
}
```

## Request Parameters
<a name="API_TerminateProvisionedProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IgnoreErrors](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-IgnoreErrors"></a>
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.  
Type: Boolean  
Required: No

 ** [ProvisionedProductId](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-ProvisionedProductId"></a>
The identifier of the provisioned product. You cannot specify both `ProvisionedProductName` and `ProvisionedProductId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisionedProductName](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-ProvisionedProductName"></a>
The name of the provisioned product. You cannot specify both `ProvisionedProductName` and `ProvisionedProductId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [RetainPhysicalResources](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-RetainPhysicalResources"></a>
When this boolean parameter is set to true, the `TerminateProvisionedProduct` API deletes the AWS Service Catalog provisioned product. However, it does not remove the AWS CloudFormation stack, stack set, or the underlying resources of the deleted provisioned product. The default value is false.  
Type: Boolean  
Required: No

 ** [TerminateToken](#API_TerminateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-request-TerminateToken"></a>
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return **ResourceNotFound**.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

## Response Syntax
<a name="API_TerminateProvisionedProduct_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_TerminateProvisionedProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_TerminateProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-TerminateProvisionedProduct-response-RecordDetail"></a>
Information about the result of this request.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_TerminateProvisionedProduct_Errors"></a>

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_TerminateProvisionedProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/TerminateProvisionedProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/TerminateProvisionedProduct) 

# UpdateConstraint
<a name="API_UpdateConstraint"></a>

Updates the specified constraint.

## Request Syntax
<a name="API_UpdateConstraint_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Description": "string",
   "Id": "string",
   "Parameters": "string"
}
```

## Request Parameters
<a name="API_UpdateConstraint_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateConstraint_RequestSyntax) **   <a name="servicecatalog-UpdateConstraint-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Description](#API_UpdateConstraint_RequestSyntax) **   <a name="servicecatalog-UpdateConstraint-request-Description"></a>
The updated description of the constraint.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** [Id](#API_UpdateConstraint_RequestSyntax) **   <a name="servicecatalog-UpdateConstraint-request-Id"></a>
The identifier of the constraint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Parameters](#API_UpdateConstraint_RequestSyntax) **   <a name="servicecatalog-UpdateConstraint-request-Parameters"></a>
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:    
LAUNCH  
You are required to specify either the `RoleArn` or the `LocalRoleName` but can't use both.  
Specify the `RoleArn` property as follows:  
 `{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}`   
Specify the `LocalRoleName` property as follows:  
 `{"LocalRoleName": "SCBasicLaunchRole"}`   
If you specify the `LocalRoleName` property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.  
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
You cannot have both a `LAUNCH` and a `STACKSET` constraint.  
You also cannot have more than one `LAUNCH` constraint on a product and portfolio.  
NOTIFICATION  
Specify the `NotificationArns` property as follows:  
 `{"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]}`   
RESOURCE\$1UPDATE  
Specify the `TagUpdatesOnProvisionedProduct` property as follows:  
 `{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}`   
The `TagUpdatesOnProvisionedProduct` property accepts a string value of `ALLOWED` or `NOT_ALLOWED`.  
STACKSET  
Specify the `Parameters` property as follows:  
 `{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}`   
You cannot have both a `LAUNCH` and a `STACKSET` constraint.  
You also cannot have more than one `STACKSET` constraint on a product and portfolio.  
Products with a `STACKSET` constraint will launch an AWS CloudFormation stack set.  
TEMPLATE  
Specify the `Rules` property. For more information, see [Template Constraint Rules](http://docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html).
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateConstraint_ResponseSyntax"></a>

```
{
   "ConstraintDetail": { 
      "ConstraintId": "string",
      "Description": "string",
      "Owner": "string",
      "PortfolioId": "string",
      "ProductId": "string",
      "Type": "string"
   },
   "ConstraintParameters": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateConstraint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConstraintDetail](#API_UpdateConstraint_ResponseSyntax) **   <a name="servicecatalog-UpdateConstraint-response-ConstraintDetail"></a>
Information about the constraint.  
Type: [ConstraintDetail](API_ConstraintDetail.md) object

 ** [ConstraintParameters](#API_UpdateConstraint_ResponseSyntax) **   <a name="servicecatalog-UpdateConstraint-response-ConstraintParameters"></a>
The constraint parameters.  
Type: String

 ** [Status](#API_UpdateConstraint_ResponseSyntax) **   <a name="servicecatalog-UpdateConstraint-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_UpdateConstraint_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateConstraint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateConstraint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateConstraint) 

# UpdatePortfolio
<a name="API_UpdatePortfolio"></a>

Updates the specified portfolio.

You cannot update a product that was shared with you.

## Request Syntax
<a name="API_UpdatePortfolio_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AddTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Description": "string",
   "DisplayName": "string",
   "Id": "string",
   "ProviderName": "string",
   "RemoveTags": [ "string" ]
}
```

## Request Parameters
<a name="API_UpdatePortfolio_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AddTags](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-AddTags"></a>
The tags to add.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 20 items.  
Required: No

 ** [Description](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-Description"></a>
The updated description of the portfolio.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** [DisplayName](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-DisplayName"></a>
The name to use for display purposes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Id](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-Id"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProviderName](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-ProviderName"></a>
The updated name of the portfolio provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** [RemoveTags](#API_UpdatePortfolio_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolio-request-RemoveTags"></a>
The tags to remove.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## Response Syntax
<a name="API_UpdatePortfolio_ResponseSyntax"></a>

```
{
   "PortfolioDetail": { 
      "ARN": "string",
      "CreatedTime": number,
      "Description": "string",
      "DisplayName": "string",
      "Id": "string",
      "ProviderName": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdatePortfolio_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PortfolioDetail](#API_UpdatePortfolio_ResponseSyntax) **   <a name="servicecatalog-UpdatePortfolio-response-PortfolioDetail"></a>
Information about the portfolio.  
Type: [PortfolioDetail](API_PortfolioDetail.md) object

 ** [Tags](#API_UpdatePortfolio_ResponseSyntax) **   <a name="servicecatalog-UpdatePortfolio-response-Tags"></a>
Information about the tags associated with the portfolio.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_UpdatePortfolio_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_UpdatePortfolio_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdatePortfolio) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdatePortfolio) 

# UpdatePortfolioShare
<a name="API_UpdatePortfolioShare"></a>

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

The portfolio share cannot be updated if the `CreatePortfolioShare` operation is `IN_PROGRESS`, as the share is not available to recipient entities. In this case, you must wait for the portfolio share to be completed.

You must provide the `accountId` or organization node in the input, but not both.

If the portfolio is shared to both an external account and an organization node, and both shares need to be updated, you must invoke `UpdatePortfolioShare` separately for each share type. 

This API cannot be used for removing the portfolio share. You must use `DeletePortfolioShare` API for that action. 

**Note**  
When you associate a principal with portfolio, a potential privilege escalation path may occur when that portfolio is then shared with other accounts. For a user in a recipient account who is *not* an Service Catalog Admin, but still has the ability to create Principals (Users/Groups/Roles), that user could create a role that matches a principal name association for the portfolio. Although this user may not know which principal names are associated through Service Catalog, they may be able to guess the user. If this potential escalation path is a concern, then Service Catalog recommends using `PrincipalType` as `IAM`. With this configuration, the `PrincipalARN` must already exist in the recipient account before it can be associated. 

## Request Syntax
<a name="API_UpdatePortfolioShare_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AccountId": "string",
   "OrganizationNode": { 
      "Type": "string",
      "Value": "string"
   },
   "PortfolioId": "string",
   "SharePrincipals": boolean,
   "ShareTagOptions": boolean
}
```

## Request Parameters
<a name="API_UpdatePortfolioShare_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AccountId](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-AccountId"></a>
The AWS account Id of the recipient account. This field is required when updating an external account to account type share.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** [OrganizationNode](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-OrganizationNode"></a>
Information about the organization node.  
Type: [OrganizationNode](API_OrganizationNode.md) object  
Required: No

 ** [PortfolioId](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-PortfolioId"></a>
The unique identifier of the portfolio for which the share will be updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [SharePrincipals](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-SharePrincipals"></a>
A flag to enables or disables `Principals` sharing in the portfolio. If this field is not provided, the current state of the `Principals` sharing on the portfolio share will not be modified.   
Type: Boolean  
Required: No

 ** [ShareTagOptions](#API_UpdatePortfolioShare_RequestSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-request-ShareTagOptions"></a>
Enables or disables `TagOptions` sharing for the portfolio share. If this field is not provided, the current state of TagOptions sharing on the portfolio share will not be modified.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_UpdatePortfolioShare_ResponseSyntax"></a>

```
{
   "PortfolioShareToken": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdatePortfolioShare_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PortfolioShareToken](#API_UpdatePortfolioShare_ResponseSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-response-PortfolioShareToken"></a>
The token that tracks the status of the `UpdatePortfolioShare` operation for external account to account or organizational type sharing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [Status](#API_UpdatePortfolioShare_ResponseSyntax) **   <a name="servicecatalog-UpdatePortfolioShare-response-Status"></a>
The status of `UpdatePortfolioShare` operation. You can also obtain the operation status using `DescribePortfolioShareStatus` API.   
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | ERROR` 

## Errors
<a name="API_UpdatePortfolioShare_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** OperationNotSupportedException **   
The operation is not supported.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdatePortfolioShare_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdatePortfolioShare) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdatePortfolioShare) 

# UpdateProduct
<a name="API_UpdateProduct"></a>

Updates the specified product.

## Request Syntax
<a name="API_UpdateProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "AddTags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Description": "string",
   "Distributor": "string",
   "Id": "string",
   "Name": "string",
   "Owner": "string",
   "RemoveTags": [ "string" ],
   "SourceConnection": { 
      "ConnectionParameters": { 
         "CodeStar": { 
            "ArtifactPath": "string",
            "Branch": "string",
            "ConnectionArn": "string",
            "Repository": "string"
         }
      },
      "Type": "string"
   },
   "SupportDescription": "string",
   "SupportEmail": "string",
   "SupportUrl": "string"
}
```

## Request Parameters
<a name="API_UpdateProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [AddTags](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-AddTags"></a>
The tags to add to the product.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 20 items.  
Required: No

 ** [Description](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-Description"></a>
The updated description of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [Distributor](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-Distributor"></a>
The updated distributor of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [Id](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-Id"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Name](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-Name"></a>
The updated product name.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [Owner](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-Owner"></a>
The updated owner of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [RemoveTags](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-RemoveTags"></a>
The tags to remove from the product.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** [SourceConnection](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-SourceConnection"></a>
Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The `SourceConnection` parameter consists of the following sub-fields.  
+  `Type` 
+  `ConnectionParamters` 
Type: [SourceConnection](API_SourceConnection.md) object  
Required: No

 ** [SupportDescription](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-SupportDescription"></a>
The updated support description for the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [SupportEmail](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-SupportEmail"></a>
The updated support email for the product.  
Type: String  
Length Constraints: Maximum length of 254.  
Required: No

 ** [SupportUrl](#API_UpdateProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProduct-request-SupportUrl"></a>
The updated support URL for the product.  
Type: String  
Length Constraints: Maximum length of 2083.  
Required: No

## Response Syntax
<a name="API_UpdateProduct_ResponseSyntax"></a>

```
{
   "ProductViewDetail": { 
      "CreatedTime": number,
      "ProductARN": "string",
      "ProductViewSummary": { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      },
      "SourceConnection": { 
         "ConnectionParameters": { 
            "CodeStar": { 
               "ArtifactPath": "string",
               "Branch": "string",
               "ConnectionArn": "string",
               "Repository": "string"
            }
         },
         "LastSync": { 
            "LastSuccessfulSyncProvisioningArtifactId": "string",
            "LastSuccessfulSyncTime": number,
            "LastSyncStatus": "string",
            "LastSyncStatusMessage": "string",
            "LastSyncTime": number
         },
         "Type": "string"
      },
      "Status": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_UpdateProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProductViewDetail](#API_UpdateProduct_ResponseSyntax) **   <a name="servicecatalog-UpdateProduct-response-ProductViewDetail"></a>
Information about the product view.  
Type: [ProductViewDetail](API_ProductViewDetail.md) object

 ** [Tags](#API_UpdateProduct_ResponseSyntax) **   <a name="servicecatalog-UpdateProduct-response-Tags"></a>
Information about the tags associated with the product.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.

## Errors
<a name="API_UpdateProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProduct) 

# UpdateProvisionedProduct
<a name="API_UpdateProvisionedProduct"></a>

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](API_DescribeRecord.md).

## Request Syntax
<a name="API_UpdateProvisionedProduct_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "PathId": "string",
   "PathName": "string",
   "ProductId": "string",
   "ProductName": "string",
   "ProvisionedProductId": "string",
   "ProvisionedProductName": "string",
   "ProvisioningArtifactId": "string",
   "ProvisioningArtifactName": "string",
   "ProvisioningParameters": [ 
      { 
         "Key": "string",
         "UsePreviousValue": boolean,
         "Value": "string"
      }
   ],
   "ProvisioningPreferences": { 
      "StackSetAccounts": [ "string" ],
      "StackSetFailureToleranceCount": number,
      "StackSetFailureTolerancePercentage": number,
      "StackSetMaxConcurrencyCount": number,
      "StackSetMaxConcurrencyPercentage": number,
      "StackSetOperationType": "string",
      "StackSetRegions": [ "string" ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "UpdateToken": "string"
}
```

## Request Parameters
<a name="API_UpdateProvisionedProduct_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [PathId](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-PathId"></a>
The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [PathName](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-PathName"></a>
The name of the path. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ProductId](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProductId"></a>
The identifier of the product. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProductName](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProductName"></a>
The name of the product. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** [ProvisionedProductId](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisionedProductId"></a>
The identifier of the provisioned product. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisionedProductName](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisionedProductName"></a>
The name of the provisioned product. You cannot specify both `ProvisionedProductName` and `ProvisionedProductId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** [ProvisioningArtifactId](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** [ProvisioningArtifactName](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisioningArtifactName"></a>
The name of the provisioning artifact. You must provide the name or ID, but not both.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** [ProvisioningParameters](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisioningParameters"></a>
The new parameters.  
Type: Array of [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) objects  
Required: No

 ** [ProvisioningPreferences](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-ProvisioningPreferences"></a>
An object that contains information about the provisioning preferences for a stack set.  
Type: [UpdateProvisioningPreferences](API_UpdateProvisioningPreferences.md) object  
Required: No

 ** [Tags](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-Tags"></a>
One or more tags. Requires the product to have `RESOURCE_UPDATE` constraint with `TagUpdatesOnProvisionedProduct` set to `ALLOWED` to allow tag updates.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** [UpdateToken](#API_UpdateProvisionedProduct_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-request-UpdateToken"></a>
The idempotency token that uniquely identifies the provisioning update request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

## Response Syntax
<a name="API_UpdateProvisionedProduct_ResponseSyntax"></a>

```
{
   "RecordDetail": { 
      "CreatedTime": number,
      "LaunchRoleArn": "string",
      "PathId": "string",
      "ProductId": "string",
      "ProvisionedProductId": "string",
      "ProvisionedProductName": "string",
      "ProvisionedProductType": "string",
      "ProvisioningArtifactId": "string",
      "RecordErrors": [ 
         { 
            "Code": "string",
            "Description": "string"
         }
      ],
      "RecordId": "string",
      "RecordTags": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "RecordType": "string",
      "Status": "string",
      "UpdatedTime": number
   }
}
```

## Response Elements
<a name="API_UpdateProvisionedProduct_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecordDetail](#API_UpdateProvisionedProduct_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisionedProduct-response-RecordDetail"></a>
Information about the result of the request.  
Type: [RecordDetail](API_RecordDetail.md) object

## Errors
<a name="API_UpdateProvisionedProduct_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProvisionedProduct_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateProvisionedProduct) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProvisionedProduct) 

# UpdateProvisionedProductProperties
<a name="API_UpdateProvisionedProductProperties"></a>

Requests updates to the properties of the specified provisioned product.

## Request Syntax
<a name="API_UpdateProvisionedProductProperties_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "IdempotencyToken": "string",
   "ProvisionedProductId": "string",
   "ProvisionedProductProperties": { 
      "string" : "string" 
   }
}
```

## Request Parameters
<a name="API_UpdateProvisionedProductProperties_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateProvisionedProductProperties_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [IdempotencyToken](#API_UpdateProvisionedProductProperties_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-request-IdempotencyToken"></a>
The idempotency token that uniquely identifies the provisioning product update request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ProvisionedProductId](#API_UpdateProvisionedProductProperties_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-request-ProvisionedProductId"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisionedProductProperties](#API_UpdateProvisionedProductProperties_RequestSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-request-ProvisionedProductProperties"></a>
A map that contains the provisioned product properties to be updated.  
The `LAUNCH_ROLE` key accepts role ARNs. This key allows an administrator to call `UpdateProvisionedProductProperties` to update the launch role that is associated with a provisioned product. This role is used when an end user calls a provisioning operation such as `UpdateProvisionedProduct`, `TerminateProvisionedProduct`, or `ExecuteProvisionedProductServiceAction`. Only a role ARN is valid. A user ARN is invalid.   
The `OWNER` key accepts user ARNs, IAM role ARNs, and STS assumed-role ARNs. The owner is the user that has permission to see, update, terminate, and execute service actions in the provisioned product.  
The administrator can change the owner of a provisioned product to another IAM or STS entity within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the `ListRecordHistory` API. The new owner can describe all past records for the provisioned product using the `DescribeRecord` API. The previous owner can no longer use `DescribeRecord`, but can still see the product's history from when he was an owner using `ListRecordHistory`.  
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or AWS Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the AWS Service Catalog console on that provisioned product.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Valid Keys: `OWNER | LAUNCH_ROLE`   
Value Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: Yes

## Response Syntax
<a name="API_UpdateProvisionedProductProperties_ResponseSyntax"></a>

```
{
   "ProvisionedProductId": "string",
   "ProvisionedProductProperties": { 
      "string" : "string" 
   },
   "RecordId": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateProvisionedProductProperties_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProvisionedProductId](#API_UpdateProvisionedProductProperties_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-response-ProvisionedProductId"></a>
The provisioned product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [ProvisionedProductProperties](#API_UpdateProvisionedProductProperties_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-response-ProvisionedProductProperties"></a>
A map that contains the properties updated.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Valid Keys: `OWNER | LAUNCH_ROLE`   
Value Length Constraints: Minimum length of 0. Maximum length of 1024.

 ** [RecordId](#API_UpdateProvisionedProductProperties_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-response-RecordId"></a>
The identifier of the record.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*` 

 ** [Status](#API_UpdateProvisionedProductProperties_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisionedProductProperties-response-Status"></a>
The status of the request.  
Type: String  
Valid Values: `CREATED | IN_PROGRESS | IN_PROGRESS_IN_ERROR | SUCCEEDED | FAILED` 

## Errors
<a name="API_UpdateProvisionedProductProperties_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProvisionedProductProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProvisionedProductProperties) 

# UpdateProvisioningArtifact
<a name="API_UpdateProvisioningArtifact"></a>

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.

## Request Syntax
<a name="API_UpdateProvisioningArtifact_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Active": boolean,
   "Description": "string",
   "Guidance": "string",
   "Name": "string",
   "ProductId": "string",
   "ProvisioningArtifactId": "string"
}
```

## Request Parameters
<a name="API_UpdateProvisioningArtifact_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Active](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-Active"></a>
Indicates whether the product version is active.  
Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.  
Type: Boolean  
Required: No

 ** [Description](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-Description"></a>
The updated description of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** [Guidance](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-Guidance"></a>
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.  
The `DEFAULT` value indicates that the product version is active.  
The administrator can set the guidance to `DEPRECATED` to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.  
Type: String  
Valid Values: `DEFAULT | DEPRECATED`   
Required: No

 ** [Name](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-Name"></a>
The updated name of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** [ProductId](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [ProvisioningArtifactId](#API_UpdateProvisioningArtifact_RequestSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-request-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## Response Syntax
<a name="API_UpdateProvisioningArtifact_ResponseSyntax"></a>

```
{
   "Info": { 
      "string" : "string" 
   },
   "ProvisioningArtifactDetail": { 
      "Active": boolean,
      "CreatedTime": number,
      "Description": "string",
      "Guidance": "string",
      "Id": "string",
      "Name": "string",
      "SourceRevision": "string",
      "Type": "string"
   },
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateProvisioningArtifact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Info](#API_UpdateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-response-Info"></a>
The URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format.  
Type: String to string map  
Map Entries: Maximum number of 100 items.

 ** [ProvisioningArtifactDetail](#API_UpdateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-response-ProvisioningArtifactDetail"></a>
Information about the provisioning artifact.  
Type: [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) object

 ** [Status](#API_UpdateProvisioningArtifact_ResponseSyntax) **   <a name="servicecatalog-UpdateProvisioningArtifact-response-Status"></a>
The status of the current request.  
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED` 

## Errors
<a name="API_UpdateProvisioningArtifact_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProvisioningArtifact) 

# UpdateServiceAction
<a name="API_UpdateServiceAction"></a>

Updates a self-service action.

## Request Syntax
<a name="API_UpdateServiceAction_RequestSyntax"></a>

```
{
   "AcceptLanguage": "string",
   "Definition": { 
      "string" : "string" 
   },
   "Description": "string",
   "Id": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateServiceAction_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [AcceptLanguage](#API_UpdateServiceAction_RequestSyntax) **   <a name="servicecatalog-UpdateServiceAction-request-AcceptLanguage"></a>
The language code.  
+  `jp` - Japanese
+  `zh` - Chinese
Type: String  
Length Constraints: Maximum length of 100.  
Required: No

 ** [Definition](#API_UpdateServiceAction_RequestSyntax) **   <a name="servicecatalog-UpdateServiceAction-request-Definition"></a>
A map that defines the self-service action.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Valid Keys: `Name | Version | AssumeRole | Parameters`   
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** [Description](#API_UpdateServiceAction_RequestSyntax) **   <a name="servicecatalog-UpdateServiceAction-request-Description"></a>
The self-service action description.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [Id](#API_UpdateServiceAction_RequestSyntax) **   <a name="servicecatalog-UpdateServiceAction-request-Id"></a>
The self-service action identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** [Name](#API_UpdateServiceAction_RequestSyntax) **   <a name="servicecatalog-UpdateServiceAction-request-Name"></a>
The self-service action name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9_\-.]*`   
Required: No

## Response Syntax
<a name="API_UpdateServiceAction_ResponseSyntax"></a>

```
{
   "ServiceActionDetail": { 
      "Definition": { 
         "string" : "string" 
      },
      "ServiceActionSummary": { 
         "DefinitionType": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string"
      }
   }
}
```

## Response Elements
<a name="API_UpdateServiceAction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ServiceActionDetail](#API_UpdateServiceAction_ResponseSyntax) **   <a name="servicecatalog-UpdateServiceAction-response-ServiceActionDetail"></a>
Detailed information about the self-service action.  
Type: [ServiceActionDetail](API_ServiceActionDetail.md) object

## Errors
<a name="API_UpdateServiceAction_Errors"></a>

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateServiceAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateServiceAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateServiceAction) 

# UpdateTagOption
<a name="API_UpdateTagOption"></a>

Updates the specified TagOption.

## Request Syntax
<a name="API_UpdateTagOption_RequestSyntax"></a>

```
{
   "Active": boolean,
   "Id": "string",
   "Value": "string"
}
```

## Request Parameters
<a name="API_UpdateTagOption_RequestParameters"></a>

The request accepts the following data in JSON format.

 ** [Active](#API_UpdateTagOption_RequestSyntax) **   <a name="servicecatalog-UpdateTagOption-request-Active"></a>
The updated active state.  
Type: Boolean  
Required: No

 ** [Id](#API_UpdateTagOption_RequestSyntax) **   <a name="servicecatalog-UpdateTagOption-request-Id"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Value](#API_UpdateTagOption_RequestSyntax) **   <a name="servicecatalog-UpdateTagOption-request-Value"></a>
The updated value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## Response Syntax
<a name="API_UpdateTagOption_ResponseSyntax"></a>

```
{
   "TagOptionDetail": { 
      "Active": boolean,
      "Id": "string",
      "Key": "string",
      "Owner": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_UpdateTagOption_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TagOptionDetail](#API_UpdateTagOption_ResponseSyntax) **   <a name="servicecatalog-UpdateTagOption-response-TagOptionDetail"></a>
Information about the TagOption.  
Type: [TagOptionDetail](API_TagOptionDetail.md) object

## Errors
<a name="API_UpdateTagOption_Errors"></a>

 ** DuplicateResourceException **   
The specified resource is a duplicate.  
HTTP Status Code: 400

 ** InvalidParametersException **   
One or more parameters provided to the operation are not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 400

 ** TagOptionNotMigratedException **   
An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Use the AWS Management Console to perform the migration process before retrying the operation.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateTagOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/servicecatalog-2015-12-10/UpdateTagOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateTagOption) 

# AppRegistry
<a name="API_Operations_AWS_Service_Catalog_App_Registry"></a>

The following actions are supported by AppRegistry:
+  [AssociateAttributeGroup](API_app-registry_AssociateAttributeGroup.md) 
+  [AssociateResource](API_app-registry_AssociateResource.md) 
+  [CreateApplication](API_app-registry_CreateApplication.md) 
+  [CreateAttributeGroup](API_app-registry_CreateAttributeGroup.md) 
+  [DeleteApplication](API_app-registry_DeleteApplication.md) 
+  [DeleteAttributeGroup](API_app-registry_DeleteAttributeGroup.md) 
+  [DisassociateAttributeGroup](API_app-registry_DisassociateAttributeGroup.md) 
+  [DisassociateResource](API_app-registry_DisassociateResource.md) 
+  [GetApplication](API_app-registry_GetApplication.md) 
+  [GetAssociatedResource](API_app-registry_GetAssociatedResource.md) 
+  [GetAttributeGroup](API_app-registry_GetAttributeGroup.md) 
+  [GetConfiguration](API_app-registry_GetConfiguration.md) 
+  [ListApplications](API_app-registry_ListApplications.md) 
+  [ListAssociatedAttributeGroups](API_app-registry_ListAssociatedAttributeGroups.md) 
+  [ListAssociatedResources](API_app-registry_ListAssociatedResources.md) 
+  [ListAttributeGroups](API_app-registry_ListAttributeGroups.md) 
+  [ListAttributeGroupsForApplication](API_app-registry_ListAttributeGroupsForApplication.md) 
+  [ListTagsForResource](API_app-registry_ListTagsForResource.md) 
+  [PutConfiguration](API_app-registry_PutConfiguration.md) 
+  [SyncResource](API_app-registry_SyncResource.md) 
+  [TagResource](API_app-registry_TagResource.md) 
+  [UntagResource](API_app-registry_UntagResource.md) 
+  [UpdateApplication](API_app-registry_UpdateApplication.md) 
+  [UpdateAttributeGroup](API_app-registry_UpdateAttributeGroup.md) 

# AssociateAttributeGroup
<a name="API_app-registry_AssociateAttributeGroup"></a>

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

## Request Syntax
<a name="API_app-registry_AssociateAttributeGroup_RequestSyntax"></a>

```
PUT /applications/application/attribute-groups/attributeGroup HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_AssociateAttributeGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_AssociateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateAttributeGroup-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [attributeGroup](#API_app-registry_AssociateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateAttributeGroup-request-uri-attributeGroup"></a>
 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.   
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_AssociateAttributeGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_AssociateAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "attributeGroupArn": "string"
}
```

## Response Elements
<a name="API_app-registry_AssociateAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationArn](#API_app-registry_AssociateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_AssociateAttributeGroup-response-applicationArn"></a>
The Amazon resource name (ARN) of the application that was augmented with attributes.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [attributeGroupArn](#API_app-registry_AssociateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_AssociateAttributeGroup-response-attributeGroupArn"></a>
The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+` 

## Errors
<a name="API_app-registry_AssociateAttributeGroup_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
 The maximum number of resources per account has been reached.  
HTTP Status Code: 402

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_AssociateAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AssociateAttributeGroup) 

# AssociateResource
<a name="API_app-registry_AssociateResource"></a>

 Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name. 

 **Minimum permissions** 

 You must have the following permissions to associate a resource using the `OPTIONS` parameter set to `APPLY_APPLICATION_TAG`. 
+  `tag:GetResources` 
+  `tag:TagResources` 

 You must also have these additional permissions if you don't use the `AWSServiceCatalogAppRegistryFullAccess` policy. For more information, see [AWSServiceCatalogAppRegistryFullAccess](https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html) in the AppRegistry Administrator Guide. 
+  `resource-groups:AssociateResource` 
+  `cloudformation:UpdateStack` 
+  `cloudformation:DescribeStacks` 

**Note**  
 In addition, you must have the tagging permission defined by the AWS service that creates the resource. For more information, see [TagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html) in the *Resource Groups Tagging API Reference*. 

## Request Syntax
<a name="API_app-registry_AssociateResource_RequestSyntax"></a>

```
PUT /applications/application/resources/resourceType/resource HTTP/1.1
Content-type: application/json

{
   "options": [ "string" ]
}
```

## URI Request Parameters
<a name="API_app-registry_AssociateResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_AssociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [resource](#API_app-registry_AssociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-request-uri-resource"></a>
The name or ID of the resource of which the application will be associated.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: Yes

 ** [resourceType](#API_app-registry_AssociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-request-uri-resourceType"></a>
The type of resource of which the application will be associated.  
Valid Values: `CFN_STACK | RESOURCE_TAG_VALUE`   
Required: Yes

## Request Body
<a name="API_app-registry_AssociateResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [options](#API_app-registry_AssociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-request-options"></a>
 Determines whether an application tag is applied or skipped.   
Type: Array of strings  
Valid Values: `APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG`   
Required: No

## Response Syntax
<a name="API_app-registry_AssociateResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "options": [ "string" ],
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_app-registry_AssociateResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationArn](#API_app-registry_AssociateResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-response-applicationArn"></a>
The Amazon resource name (ARN) of the application that was augmented with attributes.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [options](#API_app-registry_AssociateResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-response-options"></a>
 Determines whether an application tag is applied or skipped.   
Type: Array of strings  
Valid Values: `APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG` 

 ** [resourceArn](#API_app-registry_AssociateResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_AssociateResource-response-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` 

## Errors
<a name="API_app-registry_AssociateResource_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
 The maximum number of resources per account has been reached.  
HTTP Status Code: 402

 ** ThrottlingException **   
 The maximum number of API requests has been exceeded.     
 ** message **   
A message associated with the Throttling exception.  
 ** serviceCode **   
The originating service code.
HTTP Status Code: 429

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_AssociateResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/AssociateResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AssociateResource) 

# CreateApplication
<a name="API_app-registry_CreateApplication"></a>

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

## Request Syntax
<a name="API_app-registry_CreateApplication_RequestSyntax"></a>

```
POST /applications HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_app-registry_CreateApplication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_app-registry_CreateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_app-registry_CreateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateApplication-request-clientToken"></a>
A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [description](#API_app-registry_CreateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateApplication-request-description"></a>
The description of the application.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [name](#API_app-registry_CreateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateApplication-request-name"></a>
The name of the application. The name must be unique in the region in which you are creating the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: Yes

 ** [tags](#API_app-registry_CreateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateApplication-request-tags"></a>
Key-value pairs you can use to associate with the application.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## Response Syntax
<a name="API_app-registry_CreateApplication_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "application": { 
      "applicationTag": { 
         "string" : "string" 
      },
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_app-registry_CreateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [application](#API_app-registry_CreateApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_CreateApplication-response-application"></a>
Information about the application.  
Type: [Application](API_app-registry_Application.md) object

## Errors
<a name="API_app-registry_CreateApplication_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
 The maximum number of resources per account has been reached.  
HTTP Status Code: 402

 ** ThrottlingException **   
 The maximum number of API requests has been exceeded.     
 ** message **   
A message associated with the Throttling exception.  
 ** serviceCode **   
The originating service code.
HTTP Status Code: 429

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/CreateApplication) 

# CreateAttributeGroup
<a name="API_app-registry_CreateAttributeGroup"></a>

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

## Request Syntax
<a name="API_app-registry_CreateAttributeGroup_RequestSyntax"></a>

```
POST /attribute-groups HTTP/1.1
Content-type: application/json

{
   "attributes": "string",
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_app-registry_CreateAttributeGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_app-registry_CreateAttributeGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_app-registry_CreateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-request-attributes"></a>
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+`   
Required: Yes

 ** [clientToken](#API_app-registry_CreateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-request-clientToken"></a>
A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [description](#API_app-registry_CreateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-request-description"></a>
The description of the attribute group that the user provides.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [name](#API_app-registry_CreateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-request-name"></a>
The name of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: Yes

 ** [tags](#API_app-registry_CreateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-request-tags"></a>
Key-value pairs you can use to associate with the attribute group.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## Response Syntax
<a name="API_app-registry_CreateAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "attributeGroup": { 
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_app-registry_CreateAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

 ** [attributeGroup](#API_app-registry_CreateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_CreateAttributeGroup-response-attributeGroup"></a>
Information about the attribute group.  
Type: [AttributeGroup](API_app-registry_AttributeGroup.md) object

## Errors
<a name="API_app-registry_CreateAttributeGroup_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
 The maximum number of resources per account has been reached.  
HTTP Status Code: 402

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_CreateAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/CreateAttributeGroup) 

# DeleteApplication
<a name="API_app-registry_DeleteApplication"></a>

Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.

## Request Syntax
<a name="API_app-registry_DeleteApplication_RequestSyntax"></a>

```
DELETE /applications/application HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_DeleteApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_DeleteApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_DeleteApplication-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_DeleteApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_DeleteApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "application": { 
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string"
   }
}
```

## Response Elements
<a name="API_app-registry_DeleteApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [application](#API_app-registry_DeleteApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_DeleteApplication-response-application"></a>
Information about the deleted application.  
Type: [ApplicationSummary](API_app-registry_ApplicationSummary.md) object

## Errors
<a name="API_app-registry_DeleteApplication_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_DeleteApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/DeleteApplication) 

# DeleteAttributeGroup
<a name="API_app-registry_DeleteAttributeGroup"></a>

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

## Request Syntax
<a name="API_app-registry_DeleteAttributeGroup_RequestSyntax"></a>

```
DELETE /attribute-groups/attributeGroup HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_DeleteAttributeGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [attributeGroup](#API_app-registry_DeleteAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_DeleteAttributeGroup-request-uri-attributeGroup"></a>
 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.   
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_DeleteAttributeGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_DeleteAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributeGroup": { 
      "arn": "string",
      "createdBy": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string"
   }
}
```

## Response Elements
<a name="API_app-registry_DeleteAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributeGroup](#API_app-registry_DeleteAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_DeleteAttributeGroup-response-attributeGroup"></a>
Information about the deleted attribute group.  
Type: [AttributeGroupSummary](API_app-registry_AttributeGroupSummary.md) object

## Errors
<a name="API_app-registry_DeleteAttributeGroup_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_DeleteAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/DeleteAttributeGroup) 

# DisassociateAttributeGroup
<a name="API_app-registry_DisassociateAttributeGroup"></a>

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata. This operation reverts `AssociateAttributeGroup`.

## Request Syntax
<a name="API_app-registry_DisassociateAttributeGroup_RequestSyntax"></a>

```
DELETE /applications/application/attribute-groups/attributeGroup HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_DisassociateAttributeGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_DisassociateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_DisassociateAttributeGroup-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [attributeGroup](#API_app-registry_DisassociateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_DisassociateAttributeGroup-request-uri-attributeGroup"></a>
 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.   
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_DisassociateAttributeGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_DisassociateAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "attributeGroupArn": "string"
}
```

## Response Elements
<a name="API_app-registry_DisassociateAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationArn](#API_app-registry_DisassociateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_DisassociateAttributeGroup-response-applicationArn"></a>
The Amazon resource name (ARN) that specifies the application.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [attributeGroupArn](#API_app-registry_DisassociateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_DisassociateAttributeGroup-response-attributeGroupArn"></a>
The Amazon resource name (ARN) that specifies the attribute group.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+` 

## Errors
<a name="API_app-registry_DisassociateAttributeGroup_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_DisassociateAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/DisassociateAttributeGroup) 

# DisassociateResource
<a name="API_app-registry_DisassociateResource"></a>

 Disassociates a resource from application. Both the resource and the application can be specified either by ID or name. 

 **Minimum permissions** 

 You must have the following permissions to remove a resource that's been associated with an application using the `APPLY_APPLICATION_TAG` option for [AssociateResource](https://docs.aws.amazon.com/servicecatalog/latest/dg/API_app-registry_AssociateResource.html). 
+  `tag:GetResources` 
+  `tag:UntagResources` 

 You must also have the following permissions if you don't use the `AWSServiceCatalogAppRegistryFullAccess` policy. For more information, see [AWSServiceCatalogAppRegistryFullAccess](https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html) in the AppRegistry Administrator Guide. 
+  `resource-groups:DisassociateResource` 
+  `cloudformation:UpdateStack` 
+  `cloudformation:DescribeStacks` 

**Note**  
 In addition, you must have the tagging permission defined by the AWS service that creates the resource. For more information, see [UntagResources](https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_UntTagResources.html) in the *Resource Groups Tagging API Reference*. 

## Request Syntax
<a name="API_app-registry_DisassociateResource_RequestSyntax"></a>

```
DELETE /applications/application/resources/resourceType/resource HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_DisassociateResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_DisassociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_DisassociateResource-request-uri-application"></a>
The name or ID of the application.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [resource](#API_app-registry_DisassociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_DisassociateResource-request-uri-resource"></a>
The name or ID of the resource.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: Yes

 ** [resourceType](#API_app-registry_DisassociateResource_RequestSyntax) **   <a name="servicecatalog-app-registry_DisassociateResource-request-uri-resourceType"></a>
The type of the resource that is being disassociated.  
Valid Values: `CFN_STACK | RESOURCE_TAG_VALUE`   
Required: Yes

## Request Body
<a name="API_app-registry_DisassociateResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_DisassociateResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "string",
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_app-registry_DisassociateResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationArn](#API_app-registry_DisassociateResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_DisassociateResource-response-applicationArn"></a>
The Amazon resource name (ARN) that specifies the application.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [resourceArn](#API_app-registry_DisassociateResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_DisassociateResource-response-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` 

## Errors
<a name="API_app-registry_DisassociateResource_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
 The maximum number of API requests has been exceeded.     
 ** message **   
A message associated with the Throttling exception.  
 ** serviceCode **   
The originating service code.
HTTP Status Code: 429

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_DisassociateResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/DisassociateResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/DisassociateResource) 

# GetApplication
<a name="API_app-registry_GetApplication"></a>

 Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or ID in automated workflows if you want to make sure that the exact same application is returned or a `ResourceNotFoundException` is thrown, avoiding the ABA addressing problem. 

## Request Syntax
<a name="API_app-registry_GetApplication_RequestSyntax"></a>

```
GET /applications/application HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_GetApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_GetApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_GetApplication-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_GetApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_GetApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationTag": { 
      "string" : "string" 
   },
   "arn": "string",
   "associatedResourceCount": number,
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "integrations": { 
      "applicationTagResourceGroup": { 
         "arn": "string",
         "errorMessage": "string",
         "state": "string"
      },
      "resourceGroup": { 
         "arn": "string",
         "errorMessage": "string",
         "state": "string"
      }
   },
   "lastUpdateTime": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_app-registry_GetApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationTag](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-applicationTag"></a>
 A key-value pair that identifies an associated resource.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` 

 ** [arn](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-arn"></a>
The Amazon resource name (ARN) that specifies the application across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [associatedResourceCount](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-associatedResourceCount"></a>
The number of top-level resources that were registered as part of this application.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [creationTime](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-creationTime"></a>
The ISO-8601 formatted timestamp of the moment when the application was created.  
Type: Timestamp

 ** [description](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-description"></a>
The description of the application.  
Type: String  
Length Constraints: Maximum length of 1024.

 ** [id](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-id"></a>
The identifier of the application.  
Type: String  
Length Constraints: Fixed length of 26.  
Pattern: `[a-z0-9]+` 

 ** [integrations](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-integrations"></a>
 The information about the integration of the application with other services, such as AWS Resource Groups.   
Type: [Integrations](API_app-registry_Integrations.md) object

 ** [lastUpdateTime](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-lastUpdateTime"></a>
The ISO-8601 formatted timestamp of the moment when the application was last updated.  
Type: Timestamp

 ** [name](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-name"></a>
The name of the application. The name must be unique in the region in which you are creating the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+` 

 ** [tags](#API_app-registry_GetApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetApplication-response-tags"></a>
Key-value pairs associated with the application.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` 

## Errors
<a name="API_app-registry_GetApplication_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_GetApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/GetApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/GetApplication) 

# GetAssociatedResource
<a name="API_app-registry_GetAssociatedResource"></a>

Gets the resource associated with the application.

## Request Syntax
<a name="API_app-registry_GetAssociatedResource_RequestSyntax"></a>

```
GET /applications/application/resources/resourceType/resource?maxResults=maxResults&nextToken=nextToken&resourceTagStatus=resourceTagStatus HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_GetAssociatedResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [maxResults](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-maxResults"></a>
 The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-nextToken"></a>
 A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.   
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [resource](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-resource"></a>
The name or ID of the resource associated with the application.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: Yes

 ** [resourceTagStatus](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-resourceTagStatus"></a>
 States whether an application tag is applied, not applied, in the process of being applied, or skipped.   
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Valid Values: `SUCCESS | FAILED | IN_PROGRESS | SKIPPED` 

 ** [resourceType](#API_app-registry_GetAssociatedResource_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-request-uri-resourceType"></a>
The type of resource associated with the application.  
Valid Values: `CFN_STACK | RESOURCE_TAG_VALUE`   
Required: Yes

## Request Body
<a name="API_app-registry_GetAssociatedResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_GetAssociatedResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applicationTagResult": { 
      "applicationTagStatus": "string",
      "errorMessage": "string",
      "nextToken": "string",
      "resources": [ 
         { 
            "errorMessage": "string",
            "resourceArn": "string",
            "resourceType": "string",
            "status": "string"
         }
      ]
   },
   "options": [ "string" ],
   "resource": { 
      "arn": "string",
      "associationTime": "string",
      "integrations": { 
         "resourceGroup": { 
            "arn": "string",
            "errorMessage": "string",
            "state": "string"
         }
      },
      "name": "string"
   }
}
```

## Response Elements
<a name="API_app-registry_GetAssociatedResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applicationTagResult](#API_app-registry_GetAssociatedResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-response-applicationTagResult"></a>
 The result of the application that's tag applied to a resource.   
Type: [ApplicationTagResult](API_app-registry_ApplicationTagResult.md) object

 ** [options](#API_app-registry_GetAssociatedResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-response-options"></a>
 Determines whether an application tag is applied or skipped.   
Type: Array of strings  
Valid Values: `APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG` 

 ** [resource](#API_app-registry_GetAssociatedResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAssociatedResource-response-resource"></a>
The resource associated with the application.  
Type: [Resource](API_app-registry_Resource.md) object

## Errors
<a name="API_app-registry_GetAssociatedResource_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_GetAssociatedResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/GetAssociatedResource) 

# GetAttributeGroup
<a name="API_app-registry_GetAttributeGroup"></a>

 Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name. 

## Request Syntax
<a name="API_app-registry_GetAttributeGroup_RequestSyntax"></a>

```
GET /attribute-groups/attributeGroup HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_GetAttributeGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [attributeGroup](#API_app-registry_GetAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-request-uri-attributeGroup"></a>
 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.   
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_GetAttributeGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_GetAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "attributes": "string",
   "createdBy": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "lastUpdateTime": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_app-registry_GetAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-arn"></a>
The Amazon resource name (ARN) that specifies the attribute group across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+` 

 ** [attributes](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-attributes"></a>
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+` 

 ** [createdBy](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-createdBy"></a>
The service principal that created the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!-)([a-z0-9-]+\.)+(aws\.internal|amazonaws\.com(\.cn)?)$` 

 ** [creationTime](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-creationTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was created.  
Type: Timestamp

 ** [description](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-description"></a>
The description of the attribute group that the user provides.  
Type: String  
Length Constraints: Maximum length of 1024.

 ** [id](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-id"></a>
The identifier of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+` 

 ** [lastUpdateTime](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-lastUpdateTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.  
Type: Timestamp

 ** [name](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-name"></a>
The name of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+` 

 ** [tags](#API_app-registry_GetAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetAttributeGroup-response-tags"></a>
Key-value pairs associated with the attribute group.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` 

## Errors
<a name="API_app-registry_GetAttributeGroup_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_GetAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/GetAttributeGroup) 

# GetConfiguration
<a name="API_app-registry_GetConfiguration"></a>

 Retrieves a `TagKey` configuration from an account. 

## Request Syntax
<a name="API_app-registry_GetConfiguration_RequestSyntax"></a>

```
GET /configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_GetConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_app-registry_GetConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_GetConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configuration": { 
      "tagQueryConfiguration": { 
         "tagKey": "string"
      }
   }
}
```

## Response Elements
<a name="API_app-registry_GetConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configuration](#API_app-registry_GetConfiguration_ResponseSyntax) **   <a name="servicecatalog-app-registry_GetConfiguration-response-configuration"></a>
 Retrieves `TagKey` configuration from an account.   
Type: [AppRegistryConfiguration](API_app-registry_AppRegistryConfiguration.md) object

## Errors
<a name="API_app-registry_GetConfiguration_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

## See Also
<a name="API_app-registry_GetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/GetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/GetConfiguration) 

# ListApplications
<a name="API_app-registry_ListApplications"></a>

Retrieves a list of all of your applications. Results are paginated.

## Request Syntax
<a name="API_app-registry_ListApplications_RequestSyntax"></a>

```
GET /applications?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_app-registry_ListApplications_RequestSyntax) **   <a name="servicecatalog-app-registry_ListApplications-request-uri-maxResults"></a>
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_ListApplications_RequestSyntax) **   <a name="servicecatalog-app-registry_ListApplications-request-uri-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_app-registry_ListApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "applications": [ 
      { 
         "arn": "string",
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "lastUpdateTime": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_app-registry_ListApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [applications](#API_app-registry_ListApplications_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListApplications-response-applications"></a>
This list of applications.  
Type: Array of [ApplicationSummary](API_app-registry_ApplicationSummary.md) objects

 ** [nextToken](#API_app-registry_ListApplications_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListApplications-response-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_app-registry_ListApplications_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListApplications) 

# ListAssociatedAttributeGroups
<a name="API_app-registry_ListAssociatedAttributeGroups"></a>

Lists all attribute groups that are associated with specified application. Results are paginated.

## Request Syntax
<a name="API_app-registry_ListAssociatedAttributeGroups_RequestSyntax"></a>

```
GET /applications/application/attribute-groups?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListAssociatedAttributeGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_ListAssociatedAttributeGroups_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedAttributeGroups-request-uri-application"></a>
The name or ID of the application.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [maxResults](#API_app-registry_ListAssociatedAttributeGroups_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedAttributeGroups-request-uri-maxResults"></a>
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_ListAssociatedAttributeGroups_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedAttributeGroups-request-uri-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_app-registry_ListAssociatedAttributeGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListAssociatedAttributeGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributeGroups": [ "string" ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_app-registry_ListAssociatedAttributeGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributeGroups](#API_app-registry_ListAssociatedAttributeGroups_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedAttributeGroups-response-attributeGroups"></a>
A list of attribute group IDs.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+` 

 ** [nextToken](#API_app-registry_ListAssociatedAttributeGroups_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedAttributeGroups-response-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_app-registry_ListAssociatedAttributeGroups_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListAssociatedAttributeGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListAssociatedAttributeGroups) 

# ListAssociatedResources
<a name="API_app-registry_ListAssociatedResources"></a>

 Lists all of the resources that are associated with the specified application. Results are paginated. 

**Note**  
 If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API. 

## Request Syntax
<a name="API_app-registry_ListAssociatedResources_RequestSyntax"></a>

```
GET /applications/application/resources?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListAssociatedResources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_ListAssociatedResources_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedResources-request-uri-application"></a>
 The name, ID, or ARN of the application.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [maxResults](#API_app-registry_ListAssociatedResources_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedResources-request-uri-maxResults"></a>
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_ListAssociatedResources_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedResources-request-uri-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_app-registry_ListAssociatedResources_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListAssociatedResources_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resources": [ 
      { 
         "arn": "string",
         "name": "string",
         "options": [ "string" ],
         "resourceDetails": { 
            "tagValue": "string"
         },
         "resourceType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_app-registry_ListAssociatedResources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_app-registry_ListAssociatedResources_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedResources-response-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

 ** [resources](#API_app-registry_ListAssociatedResources_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAssociatedResources-response-resources"></a>
Information about the resources.  
Type: Array of [ResourceInfo](API_app-registry_ResourceInfo.md) objects

## Errors
<a name="API_app-registry_ListAssociatedResources_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListAssociatedResources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListAssociatedResources) 

# ListAttributeGroups
<a name="API_app-registry_ListAttributeGroups"></a>

Lists all attribute groups which you have access to. Results are paginated.

## Request Syntax
<a name="API_app-registry_ListAttributeGroups_RequestSyntax"></a>

```
GET /attribute-groups?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListAttributeGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_app-registry_ListAttributeGroups_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroups-request-uri-maxResults"></a>
The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_ListAttributeGroups_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroups-request-uri-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_app-registry_ListAttributeGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListAttributeGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributeGroups": [ 
      { 
         "arn": "string",
         "createdBy": "string",
         "creationTime": "string",
         "description": "string",
         "id": "string",
         "lastUpdateTime": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_app-registry_ListAttributeGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributeGroups](#API_app-registry_ListAttributeGroups_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroups-response-attributeGroups"></a>
This list of attribute groups.  
Type: Array of [AttributeGroupSummary](API_app-registry_AttributeGroupSummary.md) objects

 ** [nextToken](#API_app-registry_ListAttributeGroups_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroups-response-nextToken"></a>
The token to use to get the next page of results after a previous API call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_app-registry_ListAttributeGroups_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListAttributeGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListAttributeGroups) 

# ListAttributeGroupsForApplication
<a name="API_app-registry_ListAttributeGroupsForApplication"></a>

Lists the details of all attribute groups associated with a specific application. The results display in pages.

## Request Syntax
<a name="API_app-registry_ListAttributeGroupsForApplication_RequestSyntax"></a>

```
GET /applications/application/attribute-group-details?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListAttributeGroupsForApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_ListAttributeGroupsForApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroupsForApplication-request-uri-application"></a>
The name or ID of the application.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

 ** [maxResults](#API_app-registry_ListAttributeGroupsForApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroupsForApplication-request-uri-maxResults"></a>
The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_app-registry_ListAttributeGroupsForApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroupsForApplication-request-uri-nextToken"></a>
This token retrieves the next page of results after a previous API call.  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Request Body
<a name="API_app-registry_ListAttributeGroupsForApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListAttributeGroupsForApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributeGroupsDetails": [ 
      { 
         "arn": "string",
         "createdBy": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_app-registry_ListAttributeGroupsForApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributeGroupsDetails](#API_app-registry_ListAttributeGroupsForApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroupsForApplication-response-attributeGroupsDetails"></a>
 The details related to a specific attribute group.   
Type: Array of [AttributeGroupDetails](API_app-registry_AttributeGroupDetails.md) objects

 ** [nextToken](#API_app-registry_ListAttributeGroupsForApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListAttributeGroupsForApplication-response-nextToken"></a>
The token to use to get the next page of results after a previous API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+` 

## Errors
<a name="API_app-registry_ListAttributeGroupsForApplication_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListAttributeGroupsForApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListAttributeGroupsForApplication) 

# ListTagsForResource
<a name="API_app-registry_ListTagsForResource"></a>

Lists all of the tags on the resource.

## Request Syntax
<a name="API_app-registry_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_app-registry_ListTagsForResource_RequestSyntax) **   <a name="servicecatalog-app-registry_ListTagsForResource-request-uri-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: Yes

## Request Body
<a name="API_app-registry_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_app-registry_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_app-registry_ListTagsForResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_ListTagsForResource-response-tags"></a>
The tags on the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*` 

## Errors
<a name="API_app-registry_ListTagsForResource_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ListTagsForResource) 

# PutConfiguration
<a name="API_app-registry_PutConfiguration"></a>

 Associates a `TagKey` configuration to an account. 

## Request Syntax
<a name="API_app-registry_PutConfiguration_RequestSyntax"></a>

```
PUT /configuration HTTP/1.1
Content-type: application/json

{
   "configuration": { 
      "tagQueryConfiguration": { 
         "tagKey": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_app-registry_PutConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_app-registry_PutConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configuration](#API_app-registry_PutConfiguration_RequestSyntax) **   <a name="servicecatalog-app-registry_PutConfiguration-request-configuration"></a>
 Associates a `TagKey` configuration to an account.   
Type: [AppRegistryConfiguration](API_app-registry_AppRegistryConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_app-registry_PutConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_app-registry_PutConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_app-registry_PutConfiguration_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_PutConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/PutConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/PutConfiguration) 

# SyncResource
<a name="API_app-registry_SyncResource"></a>

Syncs the resource with current AppRegistry records.

Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.

## Request Syntax
<a name="API_app-registry_SyncResource_RequestSyntax"></a>

```
POST /sync/resourceType/resource HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_SyncResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resource](#API_app-registry_SyncResource_RequestSyntax) **   <a name="servicecatalog-app-registry_SyncResource-request-uri-resource"></a>
An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: Yes

 ** [resourceType](#API_app-registry_SyncResource_RequestSyntax) **   <a name="servicecatalog-app-registry_SyncResource-request-uri-resourceType"></a>
The type of resource of which the application will be associated.  
Valid Values: `CFN_STACK | RESOURCE_TAG_VALUE`   
Required: Yes

## Request Body
<a name="API_app-registry_SyncResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_SyncResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionTaken": "string",
   "applicationArn": "string",
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_app-registry_SyncResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [actionTaken](#API_app-registry_SyncResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_SyncResource-response-actionTaken"></a>
The results of the output if an application is associated with an ARN value, which could be `syncStarted` or None.  
Type: String  
Valid Values: `START_SYNC | NO_ACTION` 

 ** [applicationArn](#API_app-registry_SyncResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_SyncResource-response-applicationArn"></a>
The Amazon resource name (ARN) that specifies the application.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+` 

 ** [resourceArn](#API_app-registry_SyncResource_ResponseSyntax) **   <a name="servicecatalog-app-registry_SyncResource-response-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)` 

## Errors
<a name="API_app-registry_SyncResource_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
 The maximum number of API requests has been exceeded.     
 ** message **   
A message associated with the Throttling exception.  
 ** serviceCode **   
The originating service code.
HTTP Status Code: 429

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_SyncResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/SyncResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/SyncResource) 

# TagResource
<a name="API_app-registry_TagResource"></a>

Assigns one or more tags (key-value pairs) to the specified resource.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

This operation returns an empty response if the call was successful.

## Request Syntax
<a name="API_app-registry_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_app-registry_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_app-registry_TagResource_RequestSyntax) **   <a name="servicecatalog-app-registry_TagResource-request-uri-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: Yes

## Request Body
<a name="API_app-registry_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_app-registry_TagResource_RequestSyntax) **   <a name="servicecatalog-app-registry_TagResource-request-tags"></a>
The new or modified tags for the resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: Yes

## Response Syntax
<a name="API_app-registry_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_app-registry_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_app-registry_TagResource_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/TagResource) 

# UntagResource
<a name="API_app-registry_UntagResource"></a>

Removes tags from a resource.

This operation returns an empty response if the call was successful.

## Request Syntax
<a name="API_app-registry_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_app-registry_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_app-registry_UntagResource_RequestSyntax) **   <a name="servicecatalog-app-registry_UntagResource-request-uri-resourceArn"></a>
The Amazon resource name (ARN) that specifies the resource.  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: Yes

 ** [tagKeys](#API_app-registry_UntagResource_RequestSyntax) **   <a name="servicecatalog-app-registry_UntagResource-request-uri-tagKeys"></a>
A list of the tag keys to remove from the specified resource.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Required: Yes

## Request Body
<a name="API_app-registry_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_app-registry_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_app-registry_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_app-registry_UntagResource_Errors"></a>

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/UntagResource) 

# UpdateApplication
<a name="API_app-registry_UpdateApplication"></a>

Updates an existing application with new attributes.

## Request Syntax
<a name="API_app-registry_UpdateApplication_RequestSyntax"></a>

```
PATCH /applications/application HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_app-registry_UpdateApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [application](#API_app-registry_UpdateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateApplication-request-uri-application"></a>
 The name, ID, or ARN of the application that will be updated.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_UpdateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_app-registry_UpdateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateApplication-request-description"></a>
The new description of the application.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [name](#API_app-registry_UpdateApplication_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateApplication-request-name"></a>
Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

## Response Syntax
<a name="API_app-registry_UpdateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "application": { 
      "applicationTag": { 
         "string" : "string" 
      },
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_app-registry_UpdateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [application](#API_app-registry_UpdateApplication_ResponseSyntax) **   <a name="servicecatalog-app-registry_UpdateApplication-response-application"></a>
The updated information of the application.  
Type: [Application](API_app-registry_Application.md) object

## Errors
<a name="API_app-registry_UpdateApplication_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
 The maximum number of API requests has been exceeded.     
 ** message **   
A message associated with the Throttling exception.  
 ** serviceCode **   
The originating service code.
HTTP Status Code: 429

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/UpdateApplication) 

# UpdateAttributeGroup
<a name="API_app-registry_UpdateAttributeGroup"></a>

Updates an existing attribute group with new details. 

## Request Syntax
<a name="API_app-registry_UpdateAttributeGroup_RequestSyntax"></a>

```
PATCH /attribute-groups/attributeGroup HTTP/1.1
Content-type: application/json

{
   "attributes": "string",
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_app-registry_UpdateAttributeGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [attributeGroup](#API_app-registry_UpdateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateAttributeGroup-request-uri-attributeGroup"></a>
 The name, ID, or ARN of the attribute group that holds the attributes to describe the application.   
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)`   
Required: Yes

## Request Body
<a name="API_app-registry_UpdateAttributeGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_app-registry_UpdateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateAttributeGroup-request-attributes"></a>
A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 8000.  
Pattern: `[\u0009\u000A\u000D\u0020-\u00FF]+`   
Required: No

 ** [description](#API_app-registry_UpdateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateAttributeGroup-request-description"></a>
The description of the attribute group that the user provides.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** [name](#API_app-registry_UpdateAttributeGroup_RequestSyntax) **   <a name="servicecatalog-app-registry_UpdateAttributeGroup-request-name"></a>
Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

## Response Syntax
<a name="API_app-registry_UpdateAttributeGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attributeGroup": { 
      "arn": "string",
      "creationTime": "string",
      "description": "string",
      "id": "string",
      "lastUpdateTime": "string",
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_app-registry_UpdateAttributeGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attributeGroup](#API_app-registry_UpdateAttributeGroup_ResponseSyntax) **   <a name="servicecatalog-app-registry_UpdateAttributeGroup-response-attributeGroup"></a>
The updated information of the attribute group.  
Type: [AttributeGroup](API_app-registry_AttributeGroup.md) object

## Errors
<a name="API_app-registry_UpdateAttributeGroup_Errors"></a>

 ** ConflictException **   
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).  
HTTP Status Code: 409

 ** InternalServerException **   
The service is experiencing internal problems.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The request has invalid or missing parameters.  
HTTP Status Code: 400

## See Also
<a name="API_app-registry_UpdateAttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/UpdateAttributeGroup) 

# Data Types
<a name="API_Types"></a>

The following data types are supported by Service Catalog:
+  [AccessLevelFilter](API_AccessLevelFilter.md) 
+  [BudgetDetail](API_BudgetDetail.md) 
+  [CloudWatchDashboard](API_CloudWatchDashboard.md) 
+  [CodeStarParameters](API_CodeStarParameters.md) 
+  [ConstraintDetail](API_ConstraintDetail.md) 
+  [ConstraintSummary](API_ConstraintSummary.md) 
+  [EngineWorkflowResourceIdentifier](API_EngineWorkflowResourceIdentifier.md) 
+  [ExecutionParameter](API_ExecutionParameter.md) 
+  [FailedServiceActionAssociation](API_FailedServiceActionAssociation.md) 
+  [LastSync](API_LastSync.md) 
+  [LaunchPath](API_LaunchPath.md) 
+  [LaunchPathSummary](API_LaunchPathSummary.md) 
+  [ListRecordHistorySearchFilter](API_ListRecordHistorySearchFilter.md) 
+  [ListTagOptionsFilters](API_ListTagOptionsFilters.md) 
+  [OrganizationNode](API_OrganizationNode.md) 
+  [ParameterConstraints](API_ParameterConstraints.md) 
+  [PortfolioDetail](API_PortfolioDetail.md) 
+  [PortfolioShareDetail](API_PortfolioShareDetail.md) 
+  [Principal](API_Principal.md) 
+  [ProductViewAggregationValue](API_ProductViewAggregationValue.md) 
+  [ProductViewDetail](API_ProductViewDetail.md) 
+  [ProductViewSummary](API_ProductViewSummary.md) 
+  [ProvisionedProductAttribute](API_ProvisionedProductAttribute.md) 
+  [ProvisionedProductDetail](API_ProvisionedProductDetail.md) 
+  [ProvisionedProductPlanDetails](API_ProvisionedProductPlanDetails.md) 
+  [ProvisionedProductPlanSummary](API_ProvisionedProductPlanSummary.md) 
+  [ProvisioningArtifact](API_ProvisioningArtifact.md) 
+  [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) 
+  [ProvisioningArtifactOutput](API_ProvisioningArtifactOutput.md) 
+  [ProvisioningArtifactParameter](API_ProvisioningArtifactParameter.md) 
+  [ProvisioningArtifactPreferences](API_ProvisioningArtifactPreferences.md) 
+  [ProvisioningArtifactProperties](API_ProvisioningArtifactProperties.md) 
+  [ProvisioningArtifactSummary](API_ProvisioningArtifactSummary.md) 
+  [ProvisioningArtifactView](API_ProvisioningArtifactView.md) 
+  [ProvisioningParameter](API_ProvisioningParameter.md) 
+  [ProvisioningPreferences](API_ProvisioningPreferences.md) 
+  [RecordDetail](API_RecordDetail.md) 
+  [RecordError](API_RecordError.md) 
+  [RecordOutput](API_RecordOutput.md) 
+  [RecordTag](API_RecordTag.md) 
+  [ResourceChange](API_ResourceChange.md) 
+  [ResourceChangeDetail](API_ResourceChangeDetail.md) 
+  [ResourceDetail](API_ResourceDetail.md) 
+  [ResourceTargetDefinition](API_ResourceTargetDefinition.md) 
+  [ServiceActionAssociation](API_ServiceActionAssociation.md) 
+  [ServiceActionDetail](API_ServiceActionDetail.md) 
+  [ServiceActionSummary](API_ServiceActionSummary.md) 
+  [ShareDetails](API_ShareDetails.md) 
+  [ShareError](API_ShareError.md) 
+  [SourceConnection](API_SourceConnection.md) 
+  [SourceConnectionDetail](API_SourceConnectionDetail.md) 
+  [SourceConnectionParameters](API_SourceConnectionParameters.md) 
+  [StackInstance](API_StackInstance.md) 
+  [Tag](API_Tag.md) 
+  [TagOptionDetail](API_TagOptionDetail.md) 
+  [TagOptionSummary](API_TagOptionSummary.md) 
+  [UniqueTagResourceIdentifier](API_UniqueTagResourceIdentifier.md) 
+  [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) 
+  [UpdateProvisioningPreferences](API_UpdateProvisioningPreferences.md) 
+  [UsageInstruction](API_UsageInstruction.md) 

The following data types are supported by AppRegistry:
+  [Application](API_app-registry_Application.md) 
+  [ApplicationSummary](API_app-registry_ApplicationSummary.md) 
+  [ApplicationTagResult](API_app-registry_ApplicationTagResult.md) 
+  [AppRegistryConfiguration](API_app-registry_AppRegistryConfiguration.md) 
+  [AttributeGroup](API_app-registry_AttributeGroup.md) 
+  [AttributeGroupDetails](API_app-registry_AttributeGroupDetails.md) 
+  [AttributeGroupSummary](API_app-registry_AttributeGroupSummary.md) 
+  [Integrations](API_app-registry_Integrations.md) 
+  [Resource](API_app-registry_Resource.md) 
+  [ResourceDetails](API_app-registry_ResourceDetails.md) 
+  [ResourceGroup](API_app-registry_ResourceGroup.md) 
+  [ResourceInfo](API_app-registry_ResourceInfo.md) 
+  [ResourceIntegrations](API_app-registry_ResourceIntegrations.md) 
+  [ResourcesListItem](API_app-registry_ResourcesListItem.md) 
+  [TagQueryConfiguration](API_app-registry_TagQueryConfiguration.md) 

# Service Catalog
<a name="API_Types_AWS_Service_Catalog"></a>

The following data types are supported by Service Catalog:
+  [AccessLevelFilter](API_AccessLevelFilter.md) 
+  [BudgetDetail](API_BudgetDetail.md) 
+  [CloudWatchDashboard](API_CloudWatchDashboard.md) 
+  [CodeStarParameters](API_CodeStarParameters.md) 
+  [ConstraintDetail](API_ConstraintDetail.md) 
+  [ConstraintSummary](API_ConstraintSummary.md) 
+  [EngineWorkflowResourceIdentifier](API_EngineWorkflowResourceIdentifier.md) 
+  [ExecutionParameter](API_ExecutionParameter.md) 
+  [FailedServiceActionAssociation](API_FailedServiceActionAssociation.md) 
+  [LastSync](API_LastSync.md) 
+  [LaunchPath](API_LaunchPath.md) 
+  [LaunchPathSummary](API_LaunchPathSummary.md) 
+  [ListRecordHistorySearchFilter](API_ListRecordHistorySearchFilter.md) 
+  [ListTagOptionsFilters](API_ListTagOptionsFilters.md) 
+  [OrganizationNode](API_OrganizationNode.md) 
+  [ParameterConstraints](API_ParameterConstraints.md) 
+  [PortfolioDetail](API_PortfolioDetail.md) 
+  [PortfolioShareDetail](API_PortfolioShareDetail.md) 
+  [Principal](API_Principal.md) 
+  [ProductViewAggregationValue](API_ProductViewAggregationValue.md) 
+  [ProductViewDetail](API_ProductViewDetail.md) 
+  [ProductViewSummary](API_ProductViewSummary.md) 
+  [ProvisionedProductAttribute](API_ProvisionedProductAttribute.md) 
+  [ProvisionedProductDetail](API_ProvisionedProductDetail.md) 
+  [ProvisionedProductPlanDetails](API_ProvisionedProductPlanDetails.md) 
+  [ProvisionedProductPlanSummary](API_ProvisionedProductPlanSummary.md) 
+  [ProvisioningArtifact](API_ProvisioningArtifact.md) 
+  [ProvisioningArtifactDetail](API_ProvisioningArtifactDetail.md) 
+  [ProvisioningArtifactOutput](API_ProvisioningArtifactOutput.md) 
+  [ProvisioningArtifactParameter](API_ProvisioningArtifactParameter.md) 
+  [ProvisioningArtifactPreferences](API_ProvisioningArtifactPreferences.md) 
+  [ProvisioningArtifactProperties](API_ProvisioningArtifactProperties.md) 
+  [ProvisioningArtifactSummary](API_ProvisioningArtifactSummary.md) 
+  [ProvisioningArtifactView](API_ProvisioningArtifactView.md) 
+  [ProvisioningParameter](API_ProvisioningParameter.md) 
+  [ProvisioningPreferences](API_ProvisioningPreferences.md) 
+  [RecordDetail](API_RecordDetail.md) 
+  [RecordError](API_RecordError.md) 
+  [RecordOutput](API_RecordOutput.md) 
+  [RecordTag](API_RecordTag.md) 
+  [ResourceChange](API_ResourceChange.md) 
+  [ResourceChangeDetail](API_ResourceChangeDetail.md) 
+  [ResourceDetail](API_ResourceDetail.md) 
+  [ResourceTargetDefinition](API_ResourceTargetDefinition.md) 
+  [ServiceActionAssociation](API_ServiceActionAssociation.md) 
+  [ServiceActionDetail](API_ServiceActionDetail.md) 
+  [ServiceActionSummary](API_ServiceActionSummary.md) 
+  [ShareDetails](API_ShareDetails.md) 
+  [ShareError](API_ShareError.md) 
+  [SourceConnection](API_SourceConnection.md) 
+  [SourceConnectionDetail](API_SourceConnectionDetail.md) 
+  [SourceConnectionParameters](API_SourceConnectionParameters.md) 
+  [StackInstance](API_StackInstance.md) 
+  [Tag](API_Tag.md) 
+  [TagOptionDetail](API_TagOptionDetail.md) 
+  [TagOptionSummary](API_TagOptionSummary.md) 
+  [UniqueTagResourceIdentifier](API_UniqueTagResourceIdentifier.md) 
+  [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) 
+  [UpdateProvisioningPreferences](API_UpdateProvisioningPreferences.md) 
+  [UsageInstruction](API_UsageInstruction.md) 

# AccessLevelFilter
<a name="API_AccessLevelFilter"></a>

The access level to use to filter results.

## Contents
<a name="API_AccessLevelFilter_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-AccessLevelFilter-Key"></a>
The access level.  
+  `Account` - Filter results based on the account.
+  `Role` - Filter results based on the federated role of the specified user.
+  `User` - Filter results based on the specified user.
Type: String  
Valid Values: `Account | Role | User`   
Required: No

 ** Value **   <a name="servicecatalog-Type-AccessLevelFilter-Value"></a>
The user to which the access level applies. The only supported value is `self`.  
Type: String  
Required: No

## See Also
<a name="API_AccessLevelFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/AccessLevelFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/AccessLevelFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/AccessLevelFilter) 

# BudgetDetail
<a name="API_BudgetDetail"></a>

Information about a budget.

## Contents
<a name="API_BudgetDetail_Contents"></a>

 ** BudgetName **   <a name="servicecatalog-Type-BudgetDetail-BudgetName"></a>
Name of the associated budget.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## See Also
<a name="API_BudgetDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/BudgetDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/BudgetDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/BudgetDetail) 

# CloudWatchDashboard
<a name="API_CloudWatchDashboard"></a>

Information about a CloudWatch dashboard.

## Contents
<a name="API_CloudWatchDashboard_Contents"></a>

 ** Name **   <a name="servicecatalog-Type-CloudWatchDashboard-Name"></a>
The name of the CloudWatch dashboard.  
Type: String  
Required: No

## See Also
<a name="API_CloudWatchDashboard_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CloudWatchDashboard) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CloudWatchDashboard) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CloudWatchDashboard) 

# CodeStarParameters
<a name="API_CodeStarParameters"></a>

The subtype containing details about the Codestar connection `Type`. 

## Contents
<a name="API_CodeStarParameters_Contents"></a>

 ** ArtifactPath **   <a name="servicecatalog-Type-CodeStarParameters-ArtifactPath"></a>
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

 ** Branch **   <a name="servicecatalog-Type-CodeStarParameters-Branch"></a>
The specific branch where the artifact resides.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: Yes

 ** ConnectionArn **   <a name="servicecatalog-Type-CodeStarParameters-ConnectionArn"></a>
The CodeStar ARN, which is the connection between AWS Service Catalog and the external repository.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9][-.a-z0-9]{0,62}:(codestar-connections|codeconnections):([a-z0-9][-.a-z0-9]{0,62})?:([a-z0-9][-.a-z0-9]{0,62})?:[^/].{0,1023}$`   
Required: Yes

 ** Repository **   <a name="servicecatalog-Type-CodeStarParameters-Repository"></a>
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## See Also
<a name="API_CodeStarParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/CodeStarParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/CodeStarParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/CodeStarParameters) 

# ConstraintDetail
<a name="API_ConstraintDetail"></a>

Information about a constraint.

## Contents
<a name="API_ConstraintDetail_Contents"></a>

 ** ConstraintId **   <a name="servicecatalog-Type-ConstraintDetail-ConstraintId"></a>
The identifier of the constraint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Description **   <a name="servicecatalog-Type-ConstraintDetail-Description"></a>
The description of the constraint.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** Owner **   <a name="servicecatalog-Type-ConstraintDetail-Owner"></a>
The owner of the constraint.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** PortfolioId **   <a name="servicecatalog-Type-ConstraintDetail-PortfolioId"></a>
The identifier of the portfolio the product resides in. The constraint applies only to the instance of the product that lives within this portfolio.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProductId **   <a name="servicecatalog-Type-ConstraintDetail-ProductId"></a>
The identifier of the product the constraint applies to. Note that a constraint applies to a specific instance of a product within a certain portfolio.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Type **   <a name="servicecatalog-Type-ConstraintDetail-Type"></a>
The type of constraint.  
+  `LAUNCH` 
+  `NOTIFICATION` 
+ STACKSET
+  `TEMPLATE` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_ConstraintDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ConstraintDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ConstraintDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ConstraintDetail) 

# ConstraintSummary
<a name="API_ConstraintSummary"></a>

Summary information about a constraint.

## Contents
<a name="API_ConstraintSummary_Contents"></a>

 ** Description **   <a name="servicecatalog-Type-ConstraintSummary-Description"></a>
The description of the constraint.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ConstraintSummary-Type"></a>
The type of constraint.  
+  `LAUNCH` 
+  `NOTIFICATION` 
+ STACKSET
+  `TEMPLATE` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_ConstraintSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ConstraintSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ConstraintSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ConstraintSummary) 

# EngineWorkflowResourceIdentifier
<a name="API_EngineWorkflowResourceIdentifier"></a>

 The ID for the provisioned product resources that are part of a resource group. 

## Contents
<a name="API_EngineWorkflowResourceIdentifier_Contents"></a>

 ** UniqueTag **   <a name="servicecatalog-Type-EngineWorkflowResourceIdentifier-UniqueTag"></a>
 The unique key-value pair for a tag that identifies provisioned product resources.   
Type: [UniqueTagResourceIdentifier](API_UniqueTagResourceIdentifier.md) object  
Required: No

## See Also
<a name="API_EngineWorkflowResourceIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/EngineWorkflowResourceIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/EngineWorkflowResourceIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/EngineWorkflowResourceIdentifier) 

# ExecutionParameter
<a name="API_ExecutionParameter"></a>

Details of an execution parameter value that is passed to a self-service action when executed on a provisioned product.

## Contents
<a name="API_ExecutionParameter_Contents"></a>

 ** DefaultValues **   <a name="servicecatalog-Type-ExecutionParameter-DefaultValues"></a>
The default values for the execution parameter.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: No

 ** Name **   <a name="servicecatalog-Type-ExecutionParameter-Name"></a>
The name of the execution parameter.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ExecutionParameter-Type"></a>
The execution parameter type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

## See Also
<a name="API_ExecutionParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ExecutionParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ExecutionParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ExecutionParameter) 

# FailedServiceActionAssociation
<a name="API_FailedServiceActionAssociation"></a>

An object containing information about the error, along with identifying information about the self-service action and its associations.

## Contents
<a name="API_FailedServiceActionAssociation_Contents"></a>

 ** ErrorCode **   <a name="servicecatalog-Type-FailedServiceActionAssociation-ErrorCode"></a>
The error code. Valid values are listed below.  
Type: String  
Valid Values: `DUPLICATE_RESOURCE | INTERNAL_FAILURE | LIMIT_EXCEEDED | RESOURCE_NOT_FOUND | THROTTLING | INVALID_PARAMETER`   
Required: No

 ** ErrorMessage **   <a name="servicecatalog-Type-FailedServiceActionAssociation-ErrorMessage"></a>
A text description of the error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ProductId **   <a name="servicecatalog-Type-FailedServiceActionAssociation-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-FailedServiceActionAssociation-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ServiceActionId **   <a name="servicecatalog-Type-FailedServiceActionAssociation-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

## See Also
<a name="API_FailedServiceActionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/FailedServiceActionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/FailedServiceActionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/FailedServiceActionAssociation) 

# LastSync
<a name="API_LastSync"></a>

Provides details about the product's connection sync and contains the following sub-fields. 
+  `LastSyncTime` 
+  `LastSyncStatus` 
+  `LastSyncStatusMessage` 
+  `LastSuccessfulSyncTime` 
+  `LastSuccessfulSyncProvisioningArtifactID` 

## Contents
<a name="API_LastSync_Contents"></a>

 ** LastSuccessfulSyncProvisioningArtifactId **   <a name="servicecatalog-Type-LastSync-LastSuccessfulSyncProvisioningArtifactId"></a>
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LastSuccessfulSyncTime **   <a name="servicecatalog-Type-LastSync-LastSuccessfulSyncTime"></a>
The time of the latest successful sync from the source repo artifact to the AWS Service Catalog product.  
Type: Timestamp  
Required: No

 ** LastSyncStatus **   <a name="servicecatalog-Type-LastSync-LastSyncStatus"></a>
The current status of the sync. Responses include `SUCCEEDED` or `FAILED`.   
Type: String  
Valid Values: `SUCCEEDED | FAILED`   
Required: No

 ** LastSyncStatusMessage **   <a name="servicecatalog-Type-LastSync-LastSyncStatusMessage"></a>
The sync's status message.   
Type: String  
Required: No

 ** LastSyncTime **   <a name="servicecatalog-Type-LastSync-LastSyncTime"></a>
The time of the last attempted sync from the repository to the AWS Service Catalog product.   
Type: Timestamp  
Required: No

## See Also
<a name="API_LastSync_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/LastSync) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/LastSync) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/LastSync) 

# LaunchPath
<a name="API_LaunchPath"></a>

A launch path object.

## Contents
<a name="API_LaunchPath_Contents"></a>

 ** Id **   <a name="servicecatalog-Type-LaunchPath-Id"></a>
The identifier of the launch path.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-LaunchPath-Name"></a>
The name of the launch path.  
Type: String  
Required: No

## See Also
<a name="API_LaunchPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/LaunchPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/LaunchPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/LaunchPath) 

# LaunchPathSummary
<a name="API_LaunchPathSummary"></a>

Summary information about a product path for a user.

## Contents
<a name="API_LaunchPathSummary_Contents"></a>

 ** ConstraintSummaries **   <a name="servicecatalog-Type-LaunchPathSummary-ConstraintSummaries"></a>
The constraints on the portfolio-product relationship.  
Type: Array of [ConstraintSummary](API_ConstraintSummary.md) objects  
Required: No

 ** Id **   <a name="servicecatalog-Type-LaunchPathSummary-Id"></a>
The identifier of the product path.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-LaunchPathSummary-Name"></a>
The name of the portfolio that contains the product.   
Type: String  
Required: No

 ** Tags **   <a name="servicecatalog-Type-LaunchPathSummary-Tags"></a>
The tags associated with this product path.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

## See Also
<a name="API_LaunchPathSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/LaunchPathSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/LaunchPathSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/LaunchPathSummary) 

# ListRecordHistorySearchFilter
<a name="API_ListRecordHistorySearchFilter"></a>

The search filter to use when listing history records.

## Contents
<a name="API_ListRecordHistorySearchFilter_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-ListRecordHistorySearchFilter-Key"></a>
The filter key.  
+  `product` - Filter results based on the specified product identifier.
+  `provisionedproduct` - Filter results based on the provisioned product identifier.
Type: String  
Required: No

 ** Value **   <a name="servicecatalog-Type-ListRecordHistorySearchFilter-Value"></a>
The filter value.  
Type: String  
Required: No

## See Also
<a name="API_ListRecordHistorySearchFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListRecordHistorySearchFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListRecordHistorySearchFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListRecordHistorySearchFilter) 

# ListTagOptionsFilters
<a name="API_ListTagOptionsFilters"></a>

Filters to use when listing TagOptions.

## Contents
<a name="API_ListTagOptionsFilters_Contents"></a>

 ** Active **   <a name="servicecatalog-Type-ListTagOptionsFilters-Active"></a>
The active state.  
Type: Boolean  
Required: No

 ** Key **   <a name="servicecatalog-Type-ListTagOptionsFilters-Key"></a>
The TagOption key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** Value **   <a name="servicecatalog-Type-ListTagOptionsFilters-Value"></a>
The TagOption value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## See Also
<a name="API_ListTagOptionsFilters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ListTagOptionsFilters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ListTagOptionsFilters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ListTagOptionsFilters) 

# OrganizationNode
<a name="API_OrganizationNode"></a>

Information about the organization node.

## Contents
<a name="API_OrganizationNode_Contents"></a>

 ** Type **   <a name="servicecatalog-Type-OrganizationNode-Type"></a>
The organization node type.  
Type: String  
Valid Values: `ORGANIZATION | ORGANIZATIONAL_UNIT | ACCOUNT`   
Required: No

 ** Value **   <a name="servicecatalog-Type-OrganizationNode-Value"></a>
The identifier of the organization node.  
Type: String  
Pattern: `(^[0-9]{12}$)|(^arn:aws:organizations::\d{12}:organization\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\d{12}:ou\/o-[a-z0-9]{10,32}\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)`   
Required: No

## See Also
<a name="API_OrganizationNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/OrganizationNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/OrganizationNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/OrganizationNode) 

# ParameterConstraints
<a name="API_ParameterConstraints"></a>

The constraints that the administrator has put on the parameter.

## Contents
<a name="API_ParameterConstraints_Contents"></a>

 ** AllowedPattern **   <a name="servicecatalog-Type-ParameterConstraints-AllowedPattern"></a>
A regular expression that represents the patterns that allow for `String` types. The pattern must match the entire parameter value provided.  
Type: String  
Required: No

 ** AllowedValues **   <a name="servicecatalog-Type-ParameterConstraints-AllowedValues"></a>
The values that the administrator has allowed for the parameter.  
Type: Array of strings  
Required: No

 ** ConstraintDescription **   <a name="servicecatalog-Type-ParameterConstraints-ConstraintDescription"></a>
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of `[A-Za-z0-9]+` displays the following error message when the user specifies an invalid value:  
 `Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+`   
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:  
 `Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.`   
Type: String  
Required: No

 ** MaxLength **   <a name="servicecatalog-Type-ParameterConstraints-MaxLength"></a>
An integer value that determines the largest number of characters you want to allow for `String` types.   
Type: String  
Required: No

 ** MaxValue **   <a name="servicecatalog-Type-ParameterConstraints-MaxValue"></a>
A numeric value that determines the largest numeric value you want to allow for `Number` types.  
Type: String  
Required: No

 ** MinLength **   <a name="servicecatalog-Type-ParameterConstraints-MinLength"></a>
An integer value that determines the smallest number of characters you want to allow for `String` types.  
Type: String  
Required: No

 ** MinValue **   <a name="servicecatalog-Type-ParameterConstraints-MinValue"></a>
A numeric value that determines the smallest numeric value you want to allow for `Number` types.   
Type: String  
Required: No

## See Also
<a name="API_ParameterConstraints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ParameterConstraints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ParameterConstraints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ParameterConstraints) 

# PortfolioDetail
<a name="API_PortfolioDetail"></a>

Information about a portfolio.

## Contents
<a name="API_PortfolioDetail_Contents"></a>

 ** ARN **   <a name="servicecatalog-Type-PortfolioDetail-ARN"></a>
The ARN assigned to the portfolio.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Required: No

 ** CreatedTime **   <a name="servicecatalog-Type-PortfolioDetail-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Description **   <a name="servicecatalog-Type-PortfolioDetail-Description"></a>
The description of the portfolio.  
Type: String  
Length Constraints: Maximum length of 2000.  
Required: No

 ** DisplayName **   <a name="servicecatalog-Type-PortfolioDetail-DisplayName"></a>
The name to use for display purposes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Id **   <a name="servicecatalog-Type-PortfolioDetail-Id"></a>
The portfolio identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProviderName **   <a name="servicecatalog-Type-PortfolioDetail-ProviderName"></a>
The name of the portfolio provider.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Required: No

## See Also
<a name="API_PortfolioDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/PortfolioDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/PortfolioDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/PortfolioDetail) 

# PortfolioShareDetail
<a name="API_PortfolioShareDetail"></a>

Information about the portfolio share.

## Contents
<a name="API_PortfolioShareDetail_Contents"></a>

 ** Accepted **   <a name="servicecatalog-Type-PortfolioShareDetail-Accepted"></a>
Indicates whether the shared portfolio is imported by the recipient account. If the recipient is in an organization node, the share is automatically imported, and the field is always set to true.  
Type: Boolean  
Required: No

 ** PrincipalARN **   <a name="servicecatalog-Type-PortfolioShareDetail-PrincipalARN"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** PrincipalId **   <a name="servicecatalog-Type-PortfolioShareDetail-PrincipalId"></a>
The identifier of the recipient entity that received the portfolio share. The recipient entity can be one of the following:  
1. An external account.  
2. An organziation member account.  
3. An organzational unit (OU).  
4. The organization itself. (This shares with every account in the organization).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** SharePrincipals **   <a name="servicecatalog-Type-PortfolioShareDetail-SharePrincipals"></a>
Indicates if `Principal` sharing is enabled or disabled for the portfolio share.   
Type: Boolean  
Required: No

 ** ShareTagOptions **   <a name="servicecatalog-Type-PortfolioShareDetail-ShareTagOptions"></a>
Indicates whether TagOptions sharing is enabled or disabled for the portfolio share.  
Type: Boolean  
Required: No

 ** Status **   <a name="servicecatalog-Type-PortfolioShareDetail-Status"></a>
  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | ERROR`   
Required: No

 ** Type **   <a name="servicecatalog-Type-PortfolioShareDetail-Type"></a>
The type of the portfolio share.  
Type: String  
Valid Values: `ACCOUNT | ORGANIZATION | ORGANIZATIONAL_UNIT | ORGANIZATION_MEMBER_ACCOUNT`   
Required: No

## See Also
<a name="API_PortfolioShareDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/PortfolioShareDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/PortfolioShareDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/PortfolioShareDetail) 

# Principal
<a name="API_Principal"></a>

Information about a principal.

## Contents
<a name="API_Principal_Contents"></a>

 ** PrincipalARN **   <a name="servicecatalog-Type-Principal-PrincipalARN"></a>
The ARN of the principal (user, role, or group). This field allows for an ARN with no `accountID`, with or without wildcard characters if the `PrincipalType` is an `IAM_PATTERN`.   
For more information, review [associate-principal-with-portfolio](https://docs.aws.amazon.com/cli/latest/reference/servicecatalog/associate-principal-with-portfolio.html#options) in the AWS CLI Command Reference.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** PrincipalType **   <a name="servicecatalog-Type-Principal-PrincipalType"></a>
The principal type. The supported value is `IAM` if you use a fully defined ARN, or `IAM_PATTERN` if you use an ARN with no `accountID`, with or without wildcard characters.   
Type: String  
Valid Values: `IAM | IAM_PATTERN`   
Required: No

## See Also
<a name="API_Principal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/Principal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/Principal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/Principal) 

# ProductViewAggregationValue
<a name="API_ProductViewAggregationValue"></a>

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

## Contents
<a name="API_ProductViewAggregationValue_Contents"></a>

 ** ApproximateCount **   <a name="servicecatalog-Type-ProductViewAggregationValue-ApproximateCount"></a>
An approximate count of the products that match the value.  
Type: Integer  
Required: No

 ** Value **   <a name="servicecatalog-Type-ProductViewAggregationValue-Value"></a>
The value of the product view aggregation.  
Type: String  
Required: No

## See Also
<a name="API_ProductViewAggregationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProductViewAggregationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProductViewAggregationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProductViewAggregationValue) 

# ProductViewDetail
<a name="API_ProductViewDetail"></a>

Information about a product view.

## Contents
<a name="API_ProductViewDetail_Contents"></a>

 ** CreatedTime **   <a name="servicecatalog-Type-ProductViewDetail-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** ProductARN **   <a name="servicecatalog-Type-ProductViewDetail-ProductARN"></a>
The ARN of the product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 150.  
Required: No

 ** ProductViewSummary **   <a name="servicecatalog-Type-ProductViewDetail-ProductViewSummary"></a>
Summary information about the product view.  
Type: [ProductViewSummary](API_ProductViewSummary.md) object  
Required: No

 ** SourceConnection **   <a name="servicecatalog-Type-ProductViewDetail-SourceConnection"></a>
A top level `ProductViewDetail` response containing details about the product’s connection. AWS Service Catalog returns this field for the `CreateProduct`, `UpdateProduct`, `DescribeProductAsAdmin`, and `SearchProductAsAdmin` APIs. This response contains the same fields as the `ConnectionParameters` request, with the addition of the `LastSync` response.  
Type: [SourceConnectionDetail](API_SourceConnectionDetail.md) object  
Required: No

 ** Status **   <a name="servicecatalog-Type-ProductViewDetail-Status"></a>
The status of the product.  
+  `AVAILABLE` - The product is ready for use.
+  `CREATING` - Product creation has started; the product is not ready for use.
+  `FAILED` - An action failed.
Type: String  
Valid Values: `AVAILABLE | CREATING | FAILED`   
Required: No

## See Also
<a name="API_ProductViewDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProductViewDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProductViewDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProductViewDetail) 

# ProductViewSummary
<a name="API_ProductViewSummary"></a>

Summary information about a product view.

## Contents
<a name="API_ProductViewSummary_Contents"></a>

 ** Distributor **   <a name="servicecatalog-Type-ProductViewSummary-Distributor"></a>
The distributor of the product. Contact the product administrator for the significance of this value.  
Type: String  
Required: No

 ** HasDefaultPath **   <a name="servicecatalog-Type-ProductViewSummary-HasDefaultPath"></a>
Indicates whether the product has a default path. If the product does not have a default path, call [ListLaunchPaths](API_ListLaunchPaths.md) to disambiguate between paths. Otherwise, [ListLaunchPaths](API_ListLaunchPaths.md) is not required, and the output of [ProductViewSummary](#API_ProductViewSummary) can be used directly with [DescribeProvisioningParameters](API_DescribeProvisioningParameters.md).  
Type: Boolean  
Required: No

 ** Id **   <a name="servicecatalog-Type-ProductViewSummary-Id"></a>
The product view identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProductViewSummary-Name"></a>
The name of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** Owner **   <a name="servicecatalog-Type-ProductViewSummary-Owner"></a>
The owner of the product. Contact the product administrator for the significance of this value.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** ProductId **   <a name="servicecatalog-Type-ProductViewSummary-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ShortDescription **   <a name="servicecatalog-Type-ProductViewSummary-ShortDescription"></a>
Short description of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** SupportDescription **   <a name="servicecatalog-Type-ProductViewSummary-SupportDescription"></a>
The description of the support for this Product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** SupportEmail **   <a name="servicecatalog-Type-ProductViewSummary-SupportEmail"></a>
The email contact information to obtain support for this Product.  
Type: String  
Length Constraints: Maximum length of 254.  
Required: No

 ** SupportUrl **   <a name="servicecatalog-Type-ProductViewSummary-SupportUrl"></a>
The URL information to obtain support for this Product.  
Type: String  
Length Constraints: Maximum length of 2083.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ProductViewSummary-Type"></a>
The product type. Contact the product administrator for the significance of this value. If this value is `MARKETPLACE`, the product was created by AWS Marketplace.  
Type: String  
Length Constraints: Maximum length of 8191.  
Valid Values: `CLOUD_FORMATION_TEMPLATE | MARKETPLACE | TERRAFORM_OPEN_SOURCE | EXTERNAL | TERRAFORM_CLOUD`   
Required: No

## See Also
<a name="API_ProductViewSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProductViewSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProductViewSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProductViewSummary) 

# ProvisionedProductAttribute
<a name="API_ProvisionedProductAttribute"></a>

Information about a provisioned product.

## Contents
<a name="API_ProvisionedProductAttribute_Contents"></a>

 ** Arn **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Arn"></a>
The ARN of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisionedProductAttribute-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Id **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Id"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** IdempotencyToken **   <a name="servicecatalog-Type-ProvisionedProductAttribute-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** LastProvisioningRecordId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-LastProvisioningRecordId"></a>
The record identifier of the last request performed on this provisioned product of the following types:  
+  ProvisionProduct 
+  UpdateProvisionedProduct 
+  ExecuteProvisionedProductPlan 
+  TerminateProvisionedProduct 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LastRecordId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-LastRecordId"></a>
The record identifier of the last request performed on this provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LastSuccessfulProvisioningRecordId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-LastSuccessfulProvisioningRecordId"></a>
The record identifier of the last successful request performed on this provisioned product of the following types:  
+  ProvisionProduct 
+  UpdateProvisionedProduct 
+  ExecuteProvisionedProductPlan 
+  TerminateProvisionedProduct 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LaunchRoleArn **   <a name="servicecatalog-Type-ProvisionedProductAttribute-LaunchRoleArn"></a>
  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:iam::[a-z0-9-\.]{0,63}:role\/.{0,1023}`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Name"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** PhysicalId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-PhysicalId"></a>
The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.  
Type: String  
Required: No

 ** ProductId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProductName **   <a name="servicecatalog-Type-ProvisionedProductAttribute-ProductName"></a>
The name of the product.  
Type: String  
Length Constraints: Maximum length of 8191.  
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-ProvisionedProductAttribute-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisioningArtifactName **   <a name="servicecatalog-Type-ProvisionedProductAttribute-ProvisioningArtifactName"></a>
The name of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** Status **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Status"></a>
The current status of the provisioned product.  
+  `AVAILABLE` - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
+  `UNDER_CHANGE` - Transitive state. Operations performed might not have valid results. Wait for an `AVAILABLE` status before performing operations.
+  `TAINTED` - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
+  `ERROR` - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, AWS CloudFormation received a parameter value that was not valid and could not launch the stack.
+  `PLAN_IN_PROGRESS` - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an `AVAILABLE` status before performing operations.
Type: String  
Valid Values: `AVAILABLE | UNDER_CHANGE | TAINTED | ERROR | PLAN_IN_PROGRESS`   
Required: No

 ** StatusMessage **   <a name="servicecatalog-Type-ProvisionedProductAttribute-StatusMessage"></a>
The current status message of the provisioned product.  
Type: String  
Required: No

 ** Tags **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Tags"></a>
One or more tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ProvisionedProductAttribute-Type"></a>
The type of provisioned product. The supported values are `CFN_STACK`, `CFN_STACKSET`, `TERRAFORM_OPEN_SOURCE`, `TERRAFORM_CLOUD`, and `EXTERNAL`.  
Type: String  
Required: No

 ** UserArn **   <a name="servicecatalog-Type-ProvisionedProductAttribute-UserArn"></a>
The Amazon Resource Name (ARN) of the user.  
Type: String  
Required: No

 ** UserArnSession **   <a name="servicecatalog-Type-ProvisionedProductAttribute-UserArnSession"></a>
The ARN of the user in the session. This ARN might contain a session ID.  
Type: String  
Required: No

## See Also
<a name="API_ProvisionedProductAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisionedProductAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisionedProductAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisionedProductAttribute) 

# ProvisionedProductDetail
<a name="API_ProvisionedProductDetail"></a>

Information about a provisioned product.

## Contents
<a name="API_ProvisionedProductDetail_Contents"></a>

 ** Arn **   <a name="servicecatalog-Type-ProvisionedProductDetail-Arn"></a>
The ARN of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisionedProductDetail-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Id **   <a name="servicecatalog-Type-ProvisionedProductDetail-Id"></a>
The identifier of the provisioned product.  
Type: String  
Required: No

 ** IdempotencyToken **   <a name="servicecatalog-Type-ProvisionedProductDetail-IdempotencyToken"></a>
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** LastProvisioningRecordId **   <a name="servicecatalog-Type-ProvisionedProductDetail-LastProvisioningRecordId"></a>
The record identifier of the last request performed on this provisioned product of the following types:  
+  ProvisionProduct 
+  UpdateProvisionedProduct 
+  ExecuteProvisionedProductPlan 
+  TerminateProvisionedProduct 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LastRecordId **   <a name="servicecatalog-Type-ProvisionedProductDetail-LastRecordId"></a>
The record identifier of the last request performed on this provisioned product.  
Type: String  
Required: No

 ** LastSuccessfulProvisioningRecordId **   <a name="servicecatalog-Type-ProvisionedProductDetail-LastSuccessfulProvisioningRecordId"></a>
The record identifier of the last successful request performed on this provisioned product of the following types:  
+  ProvisionProduct 
+  UpdateProvisionedProduct 
+  ExecuteProvisionedProductPlan 
+  TerminateProvisionedProduct 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** LaunchRoleArn **   <a name="servicecatalog-Type-ProvisionedProductDetail-LaunchRoleArn"></a>
The ARN of the launch role associated with the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:iam::[a-z0-9-\.]{0,63}:role\/.{0,1023}`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisionedProductDetail-Name"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** ProductId **   <a name="servicecatalog-Type-ProvisionedProductDetail-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-ProvisionedProductDetail-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Status **   <a name="servicecatalog-Type-ProvisionedProductDetail-Status"></a>
The current status of the provisioned product.  
+  `AVAILABLE` - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
+  `UNDER_CHANGE` - Transitive state. Operations performed might not have valid results. Wait for an `AVAILABLE` status before performing operations.
+  `TAINTED` - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
+  `ERROR` - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, AWS CloudFormation received a parameter value that was not valid and could not launch the stack.
+  `PLAN_IN_PROGRESS` - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an `AVAILABLE` status before performing operations.
Type: String  
Valid Values: `AVAILABLE | UNDER_CHANGE | TAINTED | ERROR | PLAN_IN_PROGRESS`   
Required: No

 ** StatusMessage **   <a name="servicecatalog-Type-ProvisionedProductDetail-StatusMessage"></a>
The current status message of the provisioned product.  
Type: String  
Required: No

 ** Type **   <a name="servicecatalog-Type-ProvisionedProductDetail-Type"></a>
The type of provisioned product. The supported values are `CFN_STACK`, `CFN_STACKSET`, `TERRAFORM_OPEN_SOURCE`, `TERRAFORM_CLOUD`, and `EXTERNAL`.  
Type: String  
Required: No

## See Also
<a name="API_ProvisionedProductDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisionedProductDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisionedProductDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisionedProductDetail) 

# ProvisionedProductPlanDetails
<a name="API_ProvisionedProductPlanDetails"></a>

Information about a plan.

## Contents
<a name="API_ProvisionedProductPlanDetails_Contents"></a>

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** NotificationArns **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-NotificationArns"></a>
Passed to AWS CloudFormation. The SNS topic ARNs to which to publish stack-related events.  
Type: Array of strings  
Array Members: Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`   
Required: No

 ** PathId **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-PathId"></a>
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use [ListLaunchPaths](API_ListLaunchPaths.md).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** PlanId **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** PlanName **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-PlanName"></a>
The name of the plan.  
Type: String  
Required: No

 ** PlanType **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-PlanType"></a>
The plan type.  
Type: String  
Valid Values: `CLOUDFORMATION`   
Required: No

 ** ProductId **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisioningParameters **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-ProvisioningParameters"></a>
Parameters specified by the administrator that are required for provisioning the product.  
Type: Array of [UpdateProvisioningParameter](API_UpdateProvisioningParameter.md) objects  
Required: No

 ** ProvisionProductId **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-ProvisionProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisionProductName **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-ProvisionProductName"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: No

 ** Status **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-Status"></a>
The status.  
Type: String  
Valid Values: `CREATE_IN_PROGRESS | CREATE_SUCCESS | CREATE_FAILED | EXECUTE_IN_PROGRESS | EXECUTE_SUCCESS | EXECUTE_FAILED`   
Required: No

 ** StatusMessage **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-StatusMessage"></a>
The status message.  
Type: String  
Pattern: `[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*`   
Required: No

 ** Tags **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-Tags"></a>
One or more tags.  
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** UpdatedTime **   <a name="servicecatalog-Type-ProvisionedProductPlanDetails-UpdatedTime"></a>
The UTC time stamp when the plan was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ProvisionedProductPlanDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisionedProductPlanDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisionedProductPlanDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisionedProductPlanDetails) 

# ProvisionedProductPlanSummary
<a name="API_ProvisionedProductPlanSummary"></a>

Summary information about a plan.

## Contents
<a name="API_ProvisionedProductPlanSummary_Contents"></a>

 ** PlanId **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-PlanId"></a>
The plan identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** PlanName **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-PlanName"></a>
The name of the plan.  
Type: String  
Required: No

 ** PlanType **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-PlanType"></a>
The plan type.  
Type: String  
Valid Values: `CLOUDFORMATION`   
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisionProductId **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-ProvisionProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisionProductName **   <a name="servicecatalog-Type-ProvisionedProductPlanSummary-ProvisionProductName"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: No

## See Also
<a name="API_ProvisionedProductPlanSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisionedProductPlanSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisionedProductPlanSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisionedProductPlanSummary) 

# ProvisioningArtifact
<a name="API_ProvisioningArtifact"></a>

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

## Contents
<a name="API_ProvisioningArtifact_Contents"></a>

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisioningArtifact-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifact-Description"></a>
The description of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** Guidance **   <a name="servicecatalog-Type-ProvisioningArtifact-Guidance"></a>
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.  
Type: String  
Valid Values: `DEFAULT | DEPRECATED`   
Required: No

 ** Id **   <a name="servicecatalog-Type-ProvisioningArtifact-Id"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisioningArtifact-Name"></a>
The name of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

## See Also
<a name="API_ProvisioningArtifact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifact) 

# ProvisioningArtifactDetail
<a name="API_ProvisioningArtifactDetail"></a>

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

## Contents
<a name="API_ProvisioningArtifactDetail_Contents"></a>

 ** Active **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Active"></a>
Indicates whether the product version is active.  
Type: Boolean  
Required: No

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Description"></a>
The description of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** Guidance **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Guidance"></a>
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.  
Type: String  
Valid Values: `DEFAULT | DEPRECATED`   
Required: No

 ** Id **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Id"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Name"></a>
The name of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** SourceRevision **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-SourceRevision"></a>
Specifies the revision of the external artifact that was used to automatically sync the AWS Service Catalog product and create the provisioning artifact. AWS Service Catalog includes this response parameter as a high level field to the existing `ProvisioningArtifactDetail` type, which is returned as part of the response for `CreateProduct`, `UpdateProduct`, `DescribeProductAsAdmin`, `DescribeProvisioningArtifact`, `ListProvisioningArtifact`, and `UpdateProvisioningArticat` APIs.   
This field only exists for Repo-Synced products.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ProvisioningArtifactDetail-Type"></a>
The type of provisioning artifact.  
+  `CLOUD_FORMATION_TEMPLATE` - AWS CloudFormation template
+  `TERRAFORM_OPEN_SOURCE` - Terraform Open Source configuration file
+  `TERRAFORM_CLOUD` - Terraform Cloud configuration file
+  `EXTERNAL` - External configuration file
Type: String  
Valid Values: `CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | EXTERNAL | TERRAFORM_CLOUD`   
Required: No

## See Also
<a name="API_ProvisioningArtifactDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactDetail) 

# ProvisioningArtifactOutput
<a name="API_ProvisioningArtifactOutput"></a>

Provisioning artifact output.

## Contents
<a name="API_ProvisioningArtifactOutput_Contents"></a>

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifactOutput-Description"></a>
Description of the provisioning artifact output key.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** Key **   <a name="servicecatalog-Type-ProvisioningArtifactOutput-Key"></a>
The provisioning artifact output key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9]*`   
Required: No

## See Also
<a name="API_ProvisioningArtifactOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactOutput) 

# ProvisioningArtifactParameter
<a name="API_ProvisioningArtifactParameter"></a>

Information about a parameter used to provision a product.

## Contents
<a name="API_ProvisioningArtifactParameter_Contents"></a>

 ** DefaultValue **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-DefaultValue"></a>
The default value.  
Type: String  
Required: No

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-Description"></a>
The description of the parameter.  
Type: String  
Required: No

 ** IsNoEcho **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-IsNoEcho"></a>
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.  
Type: Boolean  
Required: No

 ** ParameterConstraints **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-ParameterConstraints"></a>
Constraints that the administrator has put on a parameter.  
Type: [ParameterConstraints](API_ParameterConstraints.md) object  
Required: No

 ** ParameterKey **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-ParameterKey"></a>
The parameter key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** ParameterType **   <a name="servicecatalog-Type-ProvisioningArtifactParameter-ParameterType"></a>
The parameter type.  
Type: String  
Required: No

## See Also
<a name="API_ProvisioningArtifactParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactParameter) 

# ProvisioningArtifactPreferences
<a name="API_ProvisioningArtifactPreferences"></a>

The user-defined preferences that will be applied during product provisioning, unless overridden by `ProvisioningPreferences` or `UpdateProvisioningPreferences`.

For more information on maximum concurrent accounts and failure tolerance, see [Stack set operation options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options) in the * AWS CloudFormation User Guide*.

## Contents
<a name="API_ProvisioningArtifactPreferences_Contents"></a>

 ** StackSetAccounts **   <a name="servicecatalog-Type-ProvisioningArtifactPreferences-StackSetAccounts"></a>
One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in `ProvisioningPreferences$StackSetAccounts` and `UpdateProvisioningPreferences$StackSetAccounts`.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** StackSetRegions **   <a name="servicecatalog-Type-ProvisioningArtifactPreferences-StackSetRegions"></a>
One or more AWS Regions where stack instances are deployed from the stack set. These Regions can be scoped in `ProvisioningPreferences$StackSetRegions` and `UpdateProvisioningPreferences$StackSetRegions`.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ProvisioningArtifactPreferences_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactPreferences) 

# ProvisioningArtifactProperties
<a name="API_ProvisioningArtifactProperties"></a>

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

## Contents
<a name="API_ProvisioningArtifactProperties_Contents"></a>

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifactProperties-Description"></a>
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** DisableTemplateValidation **   <a name="servicecatalog-Type-ProvisioningArtifactProperties-DisableTemplateValidation"></a>
If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.   
 AWS Service Catalog does not support template validation for the `TERRAFORM_OS` product type.   
Type: Boolean  
Required: No

 ** Info **   <a name="servicecatalog-Type-ProvisioningArtifactProperties-Info"></a>
Specify the template source with one of the following options, but not both. Keys accepted: [ `LoadTemplateFromURL`, `ImportFromPhysicalId` ]  
The URL of the AWS CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:  
 `"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."`   
 `ImportFromPhysicalId`: The physical id of the resource that contains the template. Currently only supports AWS CloudFormation stack arn. Specify the physical id in JSON format as follows: `ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]`   
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisioningArtifactProperties-Name"></a>
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** Type **   <a name="servicecatalog-Type-ProvisioningArtifactProperties-Type"></a>
The type of provisioning artifact.  
+  `CLOUD_FORMATION_TEMPLATE` - AWS CloudFormation template
+  `TERRAFORM_OPEN_SOURCE` - Terraform Open Source configuration file
+  `TERRAFORM_CLOUD` - Terraform Cloud configuration file
+  `EXTERNAL` - External configuration file
Type: String  
Valid Values: `CLOUD_FORMATION_TEMPLATE | MARKETPLACE_AMI | MARKETPLACE_CAR | TERRAFORM_OPEN_SOURCE | EXTERNAL | TERRAFORM_CLOUD`   
Required: No

## See Also
<a name="API_ProvisioningArtifactProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactProperties) 

# ProvisioningArtifactSummary
<a name="API_ProvisioningArtifactSummary"></a>

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

## Contents
<a name="API_ProvisioningArtifactSummary_Contents"></a>

 ** CreatedTime **   <a name="servicecatalog-Type-ProvisioningArtifactSummary-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** Description **   <a name="servicecatalog-Type-ProvisioningArtifactSummary-Description"></a>
The description of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** Id **   <a name="servicecatalog-Type-ProvisioningArtifactSummary-Id"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ProvisioningArtifactSummary-Name"></a>
The name of the provisioning artifact.  
Type: String  
Length Constraints: Maximum length of 8192.  
Required: No

 ** ProvisioningArtifactMetadata **   <a name="servicecatalog-Type-ProvisioningArtifactSummary-ProvisioningArtifactMetadata"></a>
The metadata for the provisioning artifact. This is used with AWS Marketplace products.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Required: No

## See Also
<a name="API_ProvisioningArtifactSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactSummary) 

# ProvisioningArtifactView
<a name="API_ProvisioningArtifactView"></a>

An object that contains summary information about a product view and a provisioning artifact.

## Contents
<a name="API_ProvisioningArtifactView_Contents"></a>

 ** ProductViewSummary **   <a name="servicecatalog-Type-ProvisioningArtifactView-ProductViewSummary"></a>
Summary information about a product view.  
Type: [ProductViewSummary](API_ProductViewSummary.md) object  
Required: No

 ** ProvisioningArtifact **   <a name="servicecatalog-Type-ProvisioningArtifactView-ProvisioningArtifact"></a>
Information about a provisioning artifact. A provisioning artifact is also known as a product version.  
Type: [ProvisioningArtifact](API_ProvisioningArtifact.md) object  
Required: No

## See Also
<a name="API_ProvisioningArtifactView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningArtifactView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningArtifactView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningArtifactView) 

# ProvisioningParameter
<a name="API_ProvisioningParameter"></a>

Information about a parameter used to provision a product.

## Contents
<a name="API_ProvisioningParameter_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-ProvisioningParameter-Key"></a>
The parameter key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** Value **   <a name="servicecatalog-Type-ProvisioningParameter-Value"></a>
The parameter value.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: No

## See Also
<a name="API_ProvisioningParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningParameter) 

# ProvisioningPreferences
<a name="API_ProvisioningPreferences"></a>

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product type

One or more AWS accounts that will have access to the provisioned product.

Applicable only to a `CFN_STACKSET` provisioned product type.

The AWS accounts specified should be within the list of accounts in the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.

If no values are specified, the default value is all accounts from the `STACKSET` constraint.

## Contents
<a name="API_ProvisioningPreferences_Contents"></a>

 ** StackSetAccounts **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetAccounts"></a>
One or more AWS accounts where the provisioned product will be available.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
The specified accounts should be within the list of accounts from the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.  
If no values are specified, the default value is all acounts from the `STACKSET` constraint.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** StackSetFailureToleranceCount **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetFailureToleranceCount"></a>
The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.  
The default value is `0` if no value is specified.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** StackSetFailureTolerancePercentage **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetFailureTolerancePercentage"></a>
The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.  
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** StackSetMaxConcurrencyCount **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetMaxConcurrencyCount"></a>
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `StackSetFailureToleranceCount`. `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount`.  
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** StackSetMaxConcurrencyPercentage **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetMaxConcurrencyPercentage"></a>
The maximum percentage of accounts in which to perform this operation at one time.  
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as `1` instead.  
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** StackSetRegions **   <a name="servicecatalog-Type-ProvisioningPreferences-StackSetRegions"></a>
One or more AWS Regions where the provisioned product will be available.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.  
If no values are specified, the default value is all Regions from the `STACKSET` constraint.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ProvisioningPreferences_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ProvisioningPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ProvisioningPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ProvisioningPreferences) 

# RecordDetail
<a name="API_RecordDetail"></a>

Information about a request operation.

## Contents
<a name="API_RecordDetail_Contents"></a>

 ** CreatedTime **   <a name="servicecatalog-Type-RecordDetail-CreatedTime"></a>
The UTC time stamp of the creation time.  
Type: Timestamp  
Required: No

 ** LaunchRoleArn **   <a name="servicecatalog-Type-RecordDetail-LaunchRoleArn"></a>
The ARN of the launch role associated with the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1224.  
Pattern: `arn:[a-z0-9-\.]{1,63}:iam::[a-z0-9-\.]{0,63}:role\/.{0,1023}`   
Required: No

 ** PathId **   <a name="servicecatalog-Type-RecordDetail-PathId"></a>
The path identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProductId **   <a name="servicecatalog-Type-RecordDetail-ProductId"></a>
The product identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisionedProductId **   <a name="servicecatalog-Type-RecordDetail-ProvisionedProductId"></a>
The identifier of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** ProvisionedProductName **   <a name="servicecatalog-Type-RecordDetail-ProvisionedProductName"></a>
The user-friendly name of the provisioned product.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9._-]*`   
Required: No

 ** ProvisionedProductType **   <a name="servicecatalog-Type-RecordDetail-ProvisionedProductType"></a>
The type of provisioned product. The supported values are `CFN_STACK`, `CFN_STACKSET`, `TERRAFORM_OPEN_SOURCE`, `TERRAFORM_CLOUD`, and `EXTERNAL`.  
Type: String  
Required: No

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-RecordDetail-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** RecordErrors **   <a name="servicecatalog-Type-RecordDetail-RecordErrors"></a>
The errors that occurred.  
Type: Array of [RecordError](API_RecordError.md) objects  
Required: No

 ** RecordId **   <a name="servicecatalog-Type-RecordDetail-RecordId"></a>
The identifier of the record.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** RecordTags **   <a name="servicecatalog-Type-RecordDetail-RecordTags"></a>
One or more tags.  
Type: Array of [RecordTag](API_RecordTag.md) objects  
Array Members: Maximum number of 50 items.  
Required: No

 ** RecordType **   <a name="servicecatalog-Type-RecordDetail-RecordType"></a>
The record type.  
+  `PROVISION_PRODUCT` 
+  `UPDATE_PROVISIONED_PRODUCT` 
+  `TERMINATE_PROVISIONED_PRODUCT` 
Type: String  
Required: No

 ** Status **   <a name="servicecatalog-Type-RecordDetail-Status"></a>
The status of the provisioned product.  
+  `CREATED` - The request was created but the operation has not started.
+  `IN_PROGRESS` - The requested operation is in progress.
+  `IN_PROGRESS_IN_ERROR` - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
+  `SUCCEEDED` - The requested operation has successfully completed.
+  `FAILED` - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
Type: String  
Valid Values: `CREATED | IN_PROGRESS | IN_PROGRESS_IN_ERROR | SUCCEEDED | FAILED`   
Required: No

 ** UpdatedTime **   <a name="servicecatalog-Type-RecordDetail-UpdatedTime"></a>
The time when the record was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_RecordDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/RecordDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/RecordDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/RecordDetail) 

# RecordError
<a name="API_RecordError"></a>

The error code and description resulting from an operation.

## Contents
<a name="API_RecordError_Contents"></a>

 ** Code **   <a name="servicecatalog-Type-RecordError-Code"></a>
The numeric value of the error.  
Type: String  
Required: No

 ** Description **   <a name="servicecatalog-Type-RecordError-Description"></a>
The description of the error.  
Type: String  
Required: No

## See Also
<a name="API_RecordError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/RecordError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/RecordError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/RecordError) 

# RecordOutput
<a name="API_RecordOutput"></a>

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.

## Contents
<a name="API_RecordOutput_Contents"></a>

 ** Description **   <a name="servicecatalog-Type-RecordOutput-Description"></a>
The description of the output.  
Type: String  
Required: No

 ** OutputKey **   <a name="servicecatalog-Type-RecordOutput-OutputKey"></a>
The output key.  
Type: String  
Required: No

 ** OutputValue **   <a name="servicecatalog-Type-RecordOutput-OutputValue"></a>
The output value.  
Type: String  
Required: No

## See Also
<a name="API_RecordOutput_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/RecordOutput) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/RecordOutput) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/RecordOutput) 

# RecordTag
<a name="API_RecordTag"></a>

Information about a tag, which is a key-value pair.

## Contents
<a name="API_RecordTag_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-RecordTag-Key"></a>
The key for this tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`   
Required: No

 ** Value **   <a name="servicecatalog-Type-RecordTag-Value"></a>
The value for this tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`   
Required: No

## See Also
<a name="API_RecordTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/RecordTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/RecordTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/RecordTag) 

# ResourceChange
<a name="API_ResourceChange"></a>

Information about a resource change that will occur when a plan is executed.

## Contents
<a name="API_ResourceChange_Contents"></a>

 ** Action **   <a name="servicecatalog-Type-ResourceChange-Action"></a>
The change action.  
Type: String  
Valid Values: `ADD | MODIFY | REMOVE`   
Required: No

 ** Details **   <a name="servicecatalog-Type-ResourceChange-Details"></a>
Information about the resource changes.  
Type: Array of [ResourceChangeDetail](API_ResourceChangeDetail.md) objects  
Required: No

 ** LogicalResourceId **   <a name="servicecatalog-Type-ResourceChange-LogicalResourceId"></a>
The ID of the resource, as defined in the AWS CloudFormation template.  
Type: String  
Required: No

 ** PhysicalResourceId **   <a name="servicecatalog-Type-ResourceChange-PhysicalResourceId"></a>
The ID of the resource, if it was already created.  
Type: String  
Required: No

 ** Replacement **   <a name="servicecatalog-Type-ResourceChange-Replacement"></a>
If the change type is `Modify`, indicates whether the existing resource is deleted and replaced with a new one.  
Type: String  
Valid Values: `TRUE | FALSE | CONDITIONAL`   
Required: No

 ** ResourceType **   <a name="servicecatalog-Type-ResourceChange-ResourceType"></a>
The type of resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** Scope **   <a name="servicecatalog-Type-ResourceChange-Scope"></a>
The change scope.  
Type: Array of strings  
Valid Values: `PROPERTIES | METADATA | CREATIONPOLICY | UPDATEPOLICY | DELETIONPOLICY | TAGS`   
Required: No

## See Also
<a name="API_ResourceChange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ResourceChange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ResourceChange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ResourceChange) 

# ResourceChangeDetail
<a name="API_ResourceChangeDetail"></a>

Information about a change to a resource attribute.

## Contents
<a name="API_ResourceChangeDetail_Contents"></a>

 ** CausingEntity **   <a name="servicecatalog-Type-ResourceChangeDetail-CausingEntity"></a>
The ID of the entity that caused the change.  
Type: String  
Required: No

 ** Evaluation **   <a name="servicecatalog-Type-ResourceChangeDetail-Evaluation"></a>
For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.  
Type: String  
Valid Values: `STATIC | DYNAMIC`   
Required: No

 ** Target **   <a name="servicecatalog-Type-ResourceChangeDetail-Target"></a>
Information about the resource attribute to be modified.  
Type: [ResourceTargetDefinition](API_ResourceTargetDefinition.md) object  
Required: No

## See Also
<a name="API_ResourceChangeDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ResourceChangeDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ResourceChangeDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ResourceChangeDetail) 

# ResourceDetail
<a name="API_ResourceDetail"></a>

Information about a resource.

## Contents
<a name="API_ResourceDetail_Contents"></a>

 ** ARN **   <a name="servicecatalog-Type-ResourceDetail-ARN"></a>
The ARN of the resource.  
Type: String  
Required: No

 ** CreatedTime **   <a name="servicecatalog-Type-ResourceDetail-CreatedTime"></a>
The creation time of the resource.  
Type: Timestamp  
Required: No

 ** Description **   <a name="servicecatalog-Type-ResourceDetail-Description"></a>
The description of the resource.  
Type: String  
Required: No

 ** Id **   <a name="servicecatalog-Type-ResourceDetail-Id"></a>
The identifier of the resource.  
Type: String  
Required: No

 ** Name **   <a name="servicecatalog-Type-ResourceDetail-Name"></a>
The name of the resource.  
Type: String  
Required: No

## See Also
<a name="API_ResourceDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ResourceDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ResourceDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ResourceDetail) 

# ResourceTargetDefinition
<a name="API_ResourceTargetDefinition"></a>

Information about a change to a resource attribute.

## Contents
<a name="API_ResourceTargetDefinition_Contents"></a>

 ** Attribute **   <a name="servicecatalog-Type-ResourceTargetDefinition-Attribute"></a>
The attribute to be changed.  
Type: String  
Valid Values: `PROPERTIES | METADATA | CREATIONPOLICY | UPDATEPOLICY | DELETIONPOLICY | TAGS`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ResourceTargetDefinition-Name"></a>
If the attribute is `Properties`, the value is the name of the property. Otherwise, the value is null.  
Type: String  
Required: No

 ** RequiresRecreation **   <a name="servicecatalog-Type-ResourceTargetDefinition-RequiresRecreation"></a>
If the attribute is `Properties`, indicates whether a change to this property causes the resource to be re-created.  
Type: String  
Valid Values: `NEVER | CONDITIONALLY | ALWAYS`   
Required: No

## See Also
<a name="API_ResourceTargetDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ResourceTargetDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ResourceTargetDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ResourceTargetDefinition) 

# ServiceActionAssociation
<a name="API_ServiceActionAssociation"></a>

A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

## Contents
<a name="API_ServiceActionAssociation_Contents"></a>

 ** ProductId **   <a name="servicecatalog-Type-ServiceActionAssociation-ProductId"></a>
The product identifier. For example, `prod-abcdzk7xy33qa`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** ProvisioningArtifactId **   <a name="servicecatalog-Type-ServiceActionAssociation-ProvisioningArtifactId"></a>
The identifier of the provisioning artifact. For example, `pa-4abcdjnxjj6ne`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

 ** ServiceActionId **   <a name="servicecatalog-Type-ServiceActionAssociation-ServiceActionId"></a>
The self-service action identifier. For example, `act-fs7abcd89wxyz`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: Yes

## See Also
<a name="API_ServiceActionAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ServiceActionAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ServiceActionAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ServiceActionAssociation) 

# ServiceActionDetail
<a name="API_ServiceActionDetail"></a>

An object containing detailed information about the self-service action.

## Contents
<a name="API_ServiceActionDetail_Contents"></a>

 ** Definition **   <a name="servicecatalog-Type-ServiceActionDetail-Definition"></a>
A map that defines the self-service action.  
Type: String to string map  
Map Entries: Maximum number of 100 items.  
Valid Keys: `Name | Version | AssumeRole | Parameters`   
Value Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** ServiceActionSummary **   <a name="servicecatalog-Type-ServiceActionDetail-ServiceActionSummary"></a>
Summary information about the self-service action.  
Type: [ServiceActionSummary](API_ServiceActionSummary.md) object  
Required: No

## See Also
<a name="API_ServiceActionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ServiceActionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ServiceActionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ServiceActionDetail) 

# ServiceActionSummary
<a name="API_ServiceActionSummary"></a>

Detailed information about the self-service action.

## Contents
<a name="API_ServiceActionSummary_Contents"></a>

 ** DefinitionType **   <a name="servicecatalog-Type-ServiceActionSummary-DefinitionType"></a>
The self-service action definition type. For example, `SSM_AUTOMATION`.  
Type: String  
Valid Values: `SSM_AUTOMATION`   
Required: No

 ** Description **   <a name="servicecatalog-Type-ServiceActionSummary-Description"></a>
The self-service action description.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** Id **   <a name="servicecatalog-Type-ServiceActionSummary-Id"></a>
The self-service action identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_\-]*`   
Required: No

 ** Name **   <a name="servicecatalog-Type-ServiceActionSummary-Name"></a>
The self-service action name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9_\-.]*`   
Required: No

## See Also
<a name="API_ServiceActionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ServiceActionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ServiceActionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ServiceActionSummary) 

# ShareDetails
<a name="API_ShareDetails"></a>

Information about the portfolio share operation.

## Contents
<a name="API_ShareDetails_Contents"></a>

 ** ShareErrors **   <a name="servicecatalog-Type-ShareDetails-ShareErrors"></a>
List of errors.  
Type: Array of [ShareError](API_ShareError.md) objects  
Required: No

 ** SuccessfulShares **   <a name="servicecatalog-Type-ShareDetails-SuccessfulShares"></a>
List of accounts for whom the operation succeeded.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

## See Also
<a name="API_ShareDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ShareDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ShareDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ShareDetails) 

# ShareError
<a name="API_ShareError"></a>

Errors that occurred during the portfolio share operation.

## Contents
<a name="API_ShareError_Contents"></a>

 ** Accounts **   <a name="servicecatalog-Type-ShareError-Accounts"></a>
List of accounts impacted by the error.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Error **   <a name="servicecatalog-Type-ShareError-Error"></a>
Error type that happened when processing the operation.  
Type: String  
Required: No

 ** Message **   <a name="servicecatalog-Type-ShareError-Message"></a>
Information about the error.  
Type: String  
Required: No

## See Also
<a name="API_ShareError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/ShareError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/ShareError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/ShareError) 

# SourceConnection
<a name="API_SourceConnection"></a>

A top level `ProductViewDetail` response containing details about the product’s connection. AWS Service Catalog returns this field for the `CreateProduct`, `UpdateProduct`, `DescribeProductAsAdmin`, and `SearchProductAsAdmin` APIs. This response contains the same fields as the `ConnectionParameters` request, with the addition of the `LastSync` response.

## Contents
<a name="API_SourceConnection_Contents"></a>

 ** ConnectionParameters **   <a name="servicecatalog-Type-SourceConnection-ConnectionParameters"></a>
The connection details based on the connection `Type`.   
Type: [SourceConnectionParameters](API_SourceConnectionParameters.md) object  
Required: Yes

 ** Type **   <a name="servicecatalog-Type-SourceConnection-Type"></a>
The only supported `SourceConnection` type is Codestar.   
Type: String  
Valid Values: `CODESTAR`   
Required: No

## See Also
<a name="API_SourceConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SourceConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SourceConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SourceConnection) 

# SourceConnectionDetail
<a name="API_SourceConnectionDetail"></a>

Provides details about the configured `SourceConnection`. 

## Contents
<a name="API_SourceConnectionDetail_Contents"></a>

 ** ConnectionParameters **   <a name="servicecatalog-Type-SourceConnectionDetail-ConnectionParameters"></a>
The connection details based on the connection `Type`.  
Type: [SourceConnectionParameters](API_SourceConnectionParameters.md) object  
Required: No

 ** LastSync **   <a name="servicecatalog-Type-SourceConnectionDetail-LastSync"></a>
Provides details about the product's connection sync and contains the following sub-fields.   
+  `LastSyncTime` 
+  `LastSyncStatus` 
+  `LastSyncStatusMessage` 
+  `LastSuccessfulSyncTime` 
+  `LastSuccessfulSyncProvisioningArtifactID` 
Type: [LastSync](API_LastSync.md) object  
Required: No

 ** Type **   <a name="servicecatalog-Type-SourceConnectionDetail-Type"></a>
The only supported `SourceConnection` type is Codestar.  
Type: String  
Valid Values: `CODESTAR`   
Required: No

## See Also
<a name="API_SourceConnectionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SourceConnectionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SourceConnectionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SourceConnectionDetail) 

# SourceConnectionParameters
<a name="API_SourceConnectionParameters"></a>

Provides connection details.

## Contents
<a name="API_SourceConnectionParameters_Contents"></a>

 ** CodeStar **   <a name="servicecatalog-Type-SourceConnectionParameters-CodeStar"></a>
Provides `ConnectionType` details.  
Type: [CodeStarParameters](API_CodeStarParameters.md) object  
Required: No

## See Also
<a name="API_SourceConnectionParameters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/SourceConnectionParameters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/SourceConnectionParameters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/SourceConnectionParameters) 

# StackInstance
<a name="API_StackInstance"></a>

An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status. 

## Contents
<a name="API_StackInstance_Contents"></a>

 ** Account **   <a name="servicecatalog-Type-StackInstance-Account"></a>
The name of the AWS account that the stack instance is associated with.  
Type: String  
Pattern: `^[0-9]{12}$`   
Required: No

 ** Region **   <a name="servicecatalog-Type-StackInstance-Region"></a>
The name of the AWS Region that the stack instance is associated with.  
Type: String  
Required: No

 ** StackInstanceStatus **   <a name="servicecatalog-Type-StackInstance-StackInstanceStatus"></a>
The status of the stack instance, in terms of its synchronization with its associated stack set.   
+  `INOPERABLE`: A `DeleteStackInstances` operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further `UpdateStackSet` operations. You might need to perform a `DeleteStackInstances` operation, with `RetainStacks` set to true, to delete the stack instance, and then delete the stack manually. 
+  `OUTDATED`: The stack isn't currently up to date with the stack set because either the associated stack failed during a `CreateStackSet` or `UpdateStackSet` operation, or the stack was part of a `CreateStackSet` or `UpdateStackSet` operation that failed or was stopped before the stack was created or updated.
+  `CURRENT`: The stack is currently up to date with the stack set.
Type: String  
Valid Values: `CURRENT | OUTDATED | INOPERABLE`   
Required: No

## See Also
<a name="API_StackInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/StackInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/StackInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/StackInstance) 

# Tag
<a name="API_Tag"></a>

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

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-Tag-Key"></a>
The tag key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="servicecatalog-Type-Tag-Value"></a>
The value for this key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/Tag) 

# TagOptionDetail
<a name="API_TagOptionDetail"></a>

Information about a TagOption.

## Contents
<a name="API_TagOptionDetail_Contents"></a>

 ** Active **   <a name="servicecatalog-Type-TagOptionDetail-Active"></a>
The TagOption active state.  
Type: Boolean  
Required: No

 ** Id **   <a name="servicecatalog-Type-TagOptionDetail-Id"></a>
The TagOption identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** Key **   <a name="servicecatalog-Type-TagOptionDetail-Key"></a>
The TagOption key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** Owner **   <a name="servicecatalog-Type-TagOptionDetail-Owner"></a>
The AWS account Id of the owner account that created the TagOption.  
Type: String  
Required: No

 ** Value **   <a name="servicecatalog-Type-TagOptionDetail-Value"></a>
The TagOption value.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## See Also
<a name="API_TagOptionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/TagOptionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/TagOptionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/TagOptionDetail) 

# TagOptionSummary
<a name="API_TagOptionSummary"></a>

Summary information about a TagOption.

## Contents
<a name="API_TagOptionSummary_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-TagOptionSummary-Key"></a>
The TagOption key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

 ** Values **   <a name="servicecatalog-Type-TagOptionSummary-Values"></a>
The TagOption value.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: No

## See Also
<a name="API_TagOptionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/TagOptionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/TagOptionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/TagOptionSummary) 

# UniqueTagResourceIdentifier
<a name="API_UniqueTagResourceIdentifier"></a>

 The unique key-value pair for a tag that identifies provisioned product resources. 

## Contents
<a name="API_UniqueTagResourceIdentifier_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-UniqueTagResourceIdentifier-Key"></a>
 A unique key that's attached to a resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Required: No

 ** Value **   <a name="servicecatalog-Type-UniqueTagResourceIdentifier-Value"></a>
 A unique value that's attached to a resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Required: No

## See Also
<a name="API_UniqueTagResourceIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UniqueTagResourceIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UniqueTagResourceIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UniqueTagResourceIdentifier) 

# UpdateProvisioningParameter
<a name="API_UpdateProvisioningParameter"></a>

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

## Contents
<a name="API_UpdateProvisioningParameter_Contents"></a>

 ** Key **   <a name="servicecatalog-Type-UpdateProvisioningParameter-Key"></a>
The parameter key.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** UsePreviousValue **   <a name="servicecatalog-Type-UpdateProvisioningParameter-UsePreviousValue"></a>
If set to true, `Value` is ignored and the previous parameter value is kept.  
Type: Boolean  
Required: No

 ** Value **   <a name="servicecatalog-Type-UpdateProvisioningParameter-Value"></a>
The parameter value.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: No

## See Also
<a name="API_UpdateProvisioningParameter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProvisioningParameter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProvisioningParameter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProvisioningParameter) 

# UpdateProvisioningPreferences
<a name="API_UpdateProvisioningPreferences"></a>

The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

## Contents
<a name="API_UpdateProvisioningPreferences_Contents"></a>

 ** StackSetAccounts **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetAccounts"></a>
One or more AWS accounts that will have access to the provisioned product.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
The AWS accounts specified should be within the list of accounts in the `STACKSET` constraint. To get the list of accounts in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.  
If no values are specified, the default value is all accounts from the `STACKSET` constraint.  
Type: Array of strings  
Pattern: `^[0-9]{12}$`   
Required: No

 ** StackSetFailureToleranceCount **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetFailureToleranceCount"></a>
The number of accounts, per Region, for which this operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.  
The default value is `0` if no value is specified.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** StackSetFailureTolerancePercentage **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetFailureTolerancePercentage"></a>
The percentage of accounts, per Region, for which this stack operation can fail before AWS Service Catalog stops the operation in that Region. If the operation is stopped in a Region, AWS Service Catalog doesn't attempt the operation in any subsequent Regions.  
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetFailureToleranceCount` or `StackSetFailureTolerancePercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** StackSetMaxConcurrencyCount **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetMaxConcurrencyCount"></a>
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of `StackSetFailureToleranceCount`. `StackSetMaxConcurrentCount` is at most one more than the `StackSetFailureToleranceCount`.  
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** StackSetMaxConcurrencyPercentage **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetMaxConcurrencyPercentage"></a>
The maximum percentage of accounts in which to perform this operation at one time.  
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as `1` instead.  
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
Conditional: You must specify either `StackSetMaxConcurrentCount` or `StackSetMaxConcurrentPercentage`, but not both.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** StackSetOperationType **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetOperationType"></a>
Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is `UPDATE` if nothing is specified.  
Applicable only to a `CFN_STACKSET` provisioned product type.    
CREATE  
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and Regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.  
UPDATE  
Updates the stack set represented by the provisioned product and also its stack instances.  
DELETE  
Deletes a stack instance in the stack set represented by the provisioned product.
Type: String  
Valid Values: `CREATE | UPDATE | DELETE`   
Required: No

 ** StackSetRegions **   <a name="servicecatalog-Type-UpdateProvisioningPreferences-StackSetRegions"></a>
One or more AWS Regions where the provisioned product will be available.  
Applicable only to a `CFN_STACKSET` provisioned product type.  
The specified Regions should be within the list of Regions from the `STACKSET` constraint. To get the list of Regions in the `STACKSET` constraint, use the `DescribeProvisioningParameters` operation.  
If no values are specified, the default value is all Regions from the `STACKSET` constraint.  
Type: Array of strings  
Required: No

## See Also
<a name="API_UpdateProvisioningPreferences_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UpdateProvisioningPreferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UpdateProvisioningPreferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UpdateProvisioningPreferences) 

# UsageInstruction
<a name="API_UsageInstruction"></a>

Additional information provided by the administrator.

## Contents
<a name="API_UsageInstruction_Contents"></a>

 ** Type **   <a name="servicecatalog-Type-UsageInstruction-Type"></a>
The usage instruction type for the value.  
Type: String  
Required: No

 ** Value **   <a name="servicecatalog-Type-UsageInstruction-Value"></a>
The usage instruction value for this type.  
Type: String  
Required: No

## See Also
<a name="API_UsageInstruction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/servicecatalog-2015-12-10/UsageInstruction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/servicecatalog-2015-12-10/UsageInstruction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/servicecatalog-2015-12-10/UsageInstruction) 

# AppRegistry
<a name="API_Types_AWS_Service_Catalog_App_Registry"></a>

The following data types are supported by AppRegistry:
+  [Application](API_app-registry_Application.md) 
+  [ApplicationSummary](API_app-registry_ApplicationSummary.md) 
+  [ApplicationTagResult](API_app-registry_ApplicationTagResult.md) 
+  [AppRegistryConfiguration](API_app-registry_AppRegistryConfiguration.md) 
+  [AttributeGroup](API_app-registry_AttributeGroup.md) 
+  [AttributeGroupDetails](API_app-registry_AttributeGroupDetails.md) 
+  [AttributeGroupSummary](API_app-registry_AttributeGroupSummary.md) 
+  [Integrations](API_app-registry_Integrations.md) 
+  [Resource](API_app-registry_Resource.md) 
+  [ResourceDetails](API_app-registry_ResourceDetails.md) 
+  [ResourceGroup](API_app-registry_ResourceGroup.md) 
+  [ResourceInfo](API_app-registry_ResourceInfo.md) 
+  [ResourceIntegrations](API_app-registry_ResourceIntegrations.md) 
+  [ResourcesListItem](API_app-registry_ResourcesListItem.md) 
+  [TagQueryConfiguration](API_app-registry_TagQueryConfiguration.md) 

# Application
<a name="API_app-registry_Application"></a>

Represents a AWS Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.

## Contents
<a name="API_app-registry_Application_Contents"></a>

 ** applicationTag **   <a name="servicecatalog-Type-app-registry_Application-applicationTag"></a>
 A key-value pair that identifies an associated resource.   
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

 ** arn **   <a name="servicecatalog-Type-app-registry_Application-arn"></a>
The Amazon resource name (ARN) that specifies the application across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+`   
Required: No

 ** creationTime **   <a name="servicecatalog-Type-app-registry_Application-creationTime"></a>
The ISO-8601 formatted timestamp of the moment when the application was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="servicecatalog-Type-app-registry_Application-description"></a>
The description of the application.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** id **   <a name="servicecatalog-Type-app-registry_Application-id"></a>
The identifier of the application.  
Type: String  
Length Constraints: Fixed length of 26.  
Pattern: `[a-z0-9]+`   
Required: No

 ** lastUpdateTime **   <a name="servicecatalog-Type-app-registry_Application-lastUpdateTime"></a>
 The ISO-8601 formatted timestamp of the moment when the application was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_Application-name"></a>
The name of the application. The name must be unique in the region in which you are creating the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

 ** tags **   <a name="servicecatalog-Type-app-registry_Application-tags"></a>
Key-value pairs you can use to associate with the application.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## See Also
<a name="API_app-registry_Application_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/Application) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/Application) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/Application) 

# ApplicationSummary
<a name="API_app-registry_ApplicationSummary"></a>

Summary of a AWS Service Catalog AppRegistry application.

## Contents
<a name="API_app-registry_ApplicationSummary_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-arn"></a>
The Amazon resource name (ARN) that specifies the application across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/applications/[a-z0-9]+`   
Required: No

 ** creationTime **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-creationTime"></a>
The ISO-8601 formatted timestamp of the moment when the application was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-description"></a>
The description of the application.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** id **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-id"></a>
The identifier of the application.  
Type: String  
Length Constraints: Fixed length of 26.  
Pattern: `[a-z0-9]+`   
Required: No

 ** lastUpdateTime **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-lastUpdateTime"></a>
 The ISO-8601 formatted timestamp of the moment when the application was last updated.  
Type: Timestamp  
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_ApplicationSummary-name"></a>
The name of the application. The name must be unique in the region in which you are creating the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

## See Also
<a name="API_app-registry_ApplicationSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ApplicationSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ApplicationSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ApplicationSummary) 

# ApplicationTagResult
<a name="API_app-registry_ApplicationTagResult"></a>

 The result of the application tag that's applied to a resource. 

## Contents
<a name="API_app-registry_ApplicationTagResult_Contents"></a>

 ** applicationTagStatus **   <a name="servicecatalog-Type-app-registry_ApplicationTagResult-applicationTagStatus"></a>
 The application tag is in the process of being applied to a resource, was successfully applied to a resource, or failed to apply to a resource.   
Type: String  
Valid Values: `IN_PROGRESS | SUCCESS | FAILURE`   
Required: No

 ** errorMessage **   <a name="servicecatalog-Type-app-registry_ApplicationTagResult-errorMessage"></a>
 The message returned if the call fails.   
Type: String  
Required: No

 ** nextToken **   <a name="servicecatalog-Type-app-registry_ApplicationTagResult-nextToken"></a>
 A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2024.  
Pattern: `[A-Za-z0-9+/=]+`   
Required: No

 ** resources **   <a name="servicecatalog-Type-app-registry_ApplicationTagResult-resources"></a>
 The resources associated with an application   
Type: Array of [ResourcesListItem](API_app-registry_ResourcesListItem.md) objects  
Required: No

## See Also
<a name="API_app-registry_ApplicationTagResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ApplicationTagResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ApplicationTagResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ApplicationTagResult) 

# AppRegistryConfiguration
<a name="API_app-registry_AppRegistryConfiguration"></a>

 Includes all of the AppRegistry settings. 

## Contents
<a name="API_app-registry_AppRegistryConfiguration_Contents"></a>

 ** tagQueryConfiguration **   <a name="servicecatalog-Type-app-registry_AppRegistryConfiguration-tagQueryConfiguration"></a>
 Includes the definition of a `tagQuery`.   
Type: [TagQueryConfiguration](API_app-registry_TagQueryConfiguration.md) object  
Required: No

## See Also
<a name="API_app-registry_AppRegistryConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AppRegistryConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AppRegistryConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AppRegistryConfiguration) 

# AttributeGroup
<a name="API_app-registry_AttributeGroup"></a>

Represents a AWS Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.

## Contents
<a name="API_app-registry_AttributeGroup_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_AttributeGroup-arn"></a>
The Amazon resource name (ARN) that specifies the attribute group across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+`   
Required: No

 ** creationTime **   <a name="servicecatalog-Type-app-registry_AttributeGroup-creationTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="servicecatalog-Type-app-registry_AttributeGroup-description"></a>
The description of the attribute group that the user provides.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** id **   <a name="servicecatalog-Type-app-registry_AttributeGroup-id"></a>
The globally unique attribute group identifier of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

 ** lastUpdateTime **   <a name="servicecatalog-Type-app-registry_AttributeGroup-lastUpdateTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.  
Type: Timestamp  
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_AttributeGroup-name"></a>
The name of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

 ** tags **   <a name="servicecatalog-Type-app-registry_AttributeGroup-tags"></a>
Key-value pairs you can use to associate with the attribute group.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Value Length Constraints: Maximum length of 256.  
Value Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## See Also
<a name="API_app-registry_AttributeGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AttributeGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AttributeGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AttributeGroup) 

# AttributeGroupDetails
<a name="API_app-registry_AttributeGroupDetails"></a>

 The details related to a specific AttributeGroup. 

## Contents
<a name="API_app-registry_AttributeGroupDetails_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_AttributeGroupDetails-arn"></a>
The Amazon resource name (ARN) that specifies the attribute group.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+`   
Required: No

 ** createdBy **   <a name="servicecatalog-Type-app-registry_AttributeGroupDetails-createdBy"></a>
The service principal that created the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!-)([a-z0-9-]+\.)+(aws\.internal|amazonaws\.com(\.cn)?)$`   
Required: No

 ** id **   <a name="servicecatalog-Type-app-registry_AttributeGroupDetails-id"></a>
The unique identifier of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_AttributeGroupDetails-name"></a>
 This field is no longer supported. We recommend you don't use the field when using `ListAttributeGroupsForApplication`. 
 The name of the attribute group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

## See Also
<a name="API_app-registry_AttributeGroupDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AttributeGroupDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AttributeGroupDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AttributeGroupDetails) 

# AttributeGroupSummary
<a name="API_app-registry_AttributeGroupSummary"></a>

Summary of a AWS Service Catalog AppRegistry attribute group.

## Contents
<a name="API_app-registry_AttributeGroupSummary_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-arn"></a>
The Amazon resource name (ARN) that specifies the attribute group across services.  
Type: String  
Pattern: `arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+`   
Required: No

 ** createdBy **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-createdBy"></a>
The service principal that created the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!-)([a-z0-9-]+\.)+(aws\.internal|amazonaws\.com(\.cn)?)$`   
Required: No

 ** creationTime **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-creationTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was created.  
Type: Timestamp  
Required: No

 ** description **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-description"></a>
The description of the attribute group that the user provides.  
Type: String  
Length Constraints: Maximum length of 1024.  
Required: No

 ** id **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-id"></a>
The globally unique attribute group identifier of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

 ** lastUpdateTime **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-lastUpdateTime"></a>
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.  
Type: Timestamp  
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_AttributeGroupSummary-name"></a>
The name of the attribute group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-.\w]+`   
Required: No

## See Also
<a name="API_app-registry_AttributeGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/AttributeGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/AttributeGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/AttributeGroupSummary) 

# Integrations
<a name="API_app-registry_Integrations"></a>

 The information about the service integration.

## Contents
<a name="API_app-registry_Integrations_Contents"></a>

 ** applicationTagResourceGroup **   <a name="servicecatalog-Type-app-registry_Integrations-applicationTagResourceGroup"></a>
The information about the resource group integration.  
Type: [ResourceGroup](API_app-registry_ResourceGroup.md) object  
Required: No

 ** resourceGroup **   <a name="servicecatalog-Type-app-registry_Integrations-resourceGroup"></a>
 The information about the resource group integration.  
Type: [ResourceGroup](API_app-registry_ResourceGroup.md) object  
Required: No

## See Also
<a name="API_app-registry_Integrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/Integrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/Integrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/Integrations) 

# Resource
<a name="API_app-registry_Resource"></a>

 The information about the resource.

## Contents
<a name="API_app-registry_Resource_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_Resource-arn"></a>
The Amazon resource name (ARN) of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: No

 ** associationTime **   <a name="servicecatalog-Type-app-registry_Resource-associationTime"></a>
The time the resource was associated with the application.  
Type: Timestamp  
Required: No

 ** integrations **   <a name="servicecatalog-Type-app-registry_Resource-integrations"></a>
The service integration information about the resource.   
Type: [ResourceIntegrations](API_app-registry_ResourceIntegrations.md) object  
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_Resource-name"></a>
The name of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: No

## See Also
<a name="API_app-registry_Resource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/Resource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/Resource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/Resource) 

# ResourceDetails
<a name="API_app-registry_ResourceDetails"></a>

 The details related to the resource. 

## Contents
<a name="API_app-registry_ResourceDetails_Contents"></a>

 ** tagValue **   <a name="servicecatalog-Type-app-registry_ResourceDetails-tagValue"></a>
The value of the tag.  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## See Also
<a name="API_app-registry_ResourceDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ResourceDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ResourceDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ResourceDetails) 

# ResourceGroup
<a name="API_app-registry_ResourceGroup"></a>

The information about the resource group integration.

## Contents
<a name="API_app-registry_ResourceGroup_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_ResourceGroup-arn"></a>
The Amazon resource name (ARN) of the resource group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: No

 ** errorMessage **   <a name="servicecatalog-Type-app-registry_ResourceGroup-errorMessage"></a>
The error message that generates when the propagation process for the resource group fails.  
Type: String  
Required: No

 ** state **   <a name="servicecatalog-Type-app-registry_ResourceGroup-state"></a>
The state of the propagation process for the resource group. The states includes:  
 `CREATING `if the resource group is in the process of being created.  
 `CREATE_COMPLETE` if the resource group was created successfully.  
 `CREATE_FAILED` if the resource group failed to be created.  
 `UPDATING` if the resource group is in the process of being updated.  
 `UPDATE_COMPLETE` if the resource group updated successfully.  
 `UPDATE_FAILED` if the resource group could not update successfully.  
Type: String  
Valid Values: `CREATING | CREATE_COMPLETE | CREATE_FAILED | UPDATING | UPDATE_COMPLETE | UPDATE_FAILED`   
Required: No

## See Also
<a name="API_app-registry_ResourceGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ResourceGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ResourceGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ResourceGroup) 

# ResourceInfo
<a name="API_app-registry_ResourceInfo"></a>

The information about the resource.

## Contents
<a name="API_app-registry_ResourceInfo_Contents"></a>

 ** arn **   <a name="servicecatalog-Type-app-registry_ResourceInfo-arn"></a>
The Amazon resource name (ARN) that specifies the resource across services.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: No

 ** name **   <a name="servicecatalog-Type-app-registry_ResourceInfo-name"></a>
The name of the resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `\S+`   
Required: No

 ** options **   <a name="servicecatalog-Type-app-registry_ResourceInfo-options"></a>
 Determines whether an application tag is applied or skipped.   
Type: Array of strings  
Valid Values: `APPLY_APPLICATION_TAG | SKIP_APPLICATION_TAG`   
Required: No

 ** resourceDetails **   <a name="servicecatalog-Type-app-registry_ResourceInfo-resourceDetails"></a>
 The details related to the resource.   
Type: [ResourceDetails](API_app-registry_ResourceDetails.md) object  
Required: No

 ** resourceType **   <a name="servicecatalog-Type-app-registry_ResourceInfo-resourceType"></a>
 Provides information about the AWS Service Catalog AppRegistry resource type.   
Type: String  
Valid Values: `CFN_STACK | RESOURCE_TAG_VALUE`   
Required: No

## See Also
<a name="API_app-registry_ResourceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ResourceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ResourceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ResourceInfo) 

# ResourceIntegrations
<a name="API_app-registry_ResourceIntegrations"></a>

The service integration information about the resource.

## Contents
<a name="API_app-registry_ResourceIntegrations_Contents"></a>

 ** resourceGroup **   <a name="servicecatalog-Type-app-registry_ResourceIntegrations-resourceGroup"></a>
The information about the integration of Resource Groups.  
Type: [ResourceGroup](API_app-registry_ResourceGroup.md) object  
Required: No

## See Also
<a name="API_app-registry_ResourceIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ResourceIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ResourceIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ResourceIntegrations) 

# ResourcesListItem
<a name="API_app-registry_ResourcesListItem"></a>

 The resource in a list of resources. 

## Contents
<a name="API_app-registry_ResourcesListItem_Contents"></a>

 ** errorMessage **   <a name="servicecatalog-Type-app-registry_ResourcesListItem-errorMessage"></a>
 The message returned if the call fails.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: No

 ** resourceArn **   <a name="servicecatalog-Type-app-registry_ResourcesListItem-resourceArn"></a>
 The Amazon resource name (ARN) of the resource.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\-])+:([a-z]{2}(-gov)?-[a-z]+-\d{1})?:(\d{12})?:(.*)`   
Required: No

 ** resourceType **   <a name="servicecatalog-Type-app-registry_ResourcesListItem-resourceType"></a>
 Provides information about the AppRegistry resource type.   
Type: String  
Pattern: `AWS::[a-zA-Z0-9]+::\w+`   
Required: No

 ** status **   <a name="servicecatalog-Type-app-registry_ResourcesListItem-status"></a>
 The status of the list item.   
Type: String  
Required: No

## See Also
<a name="API_app-registry_ResourcesListItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/ResourcesListItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/ResourcesListItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/ResourcesListItem) 

# TagQueryConfiguration
<a name="API_app-registry_TagQueryConfiguration"></a>

 The definition of `tagQuery`. Specifies which resources are associated with an application. 

## Contents
<a name="API_app-registry_TagQueryConfiguration_Contents"></a>

 ** tagKey **   <a name="servicecatalog-Type-app-registry_TagQueryConfiguration-tagKey"></a>
 Condition in the IAM policy that associates resources to an application.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 128.  
Pattern: `^(?!\s+$)[\p{L}\p{Z}\p{N}_.:/=+\-@]*`   
Required: No

## See Also
<a name="API_app-registry_TagQueryConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/AWS242AppRegistry-2020-06-24/TagQueryConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/AWS242AppRegistry-2020-06-24/TagQueryConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/AWS242AppRegistry-2020-06-24/TagQueryConfiguration)