# DescribeComponentConfigurationRecommendation
<a name="API_DescribeComponentConfigurationRecommendation"></a>

Describes the recommended monitoring configuration of the component.

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

```
{
   "ComponentName": "string",
   "RecommendationType": "string",
   "ResourceGroupName": "string",
   "Tier": "string",
   "WorkloadName": "string"
}
```

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

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ComponentName](#API_DescribeComponentConfigurationRecommendation_RequestSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-request-ComponentName"></a>
The name of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `(?:^[\d\w\-_\.+]*$)|(?:^arn:aws(-\w+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$)`   
Required: Yes

 ** [RecommendationType](#API_DescribeComponentConfigurationRecommendation_RequestSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-request-RecommendationType"></a>
The recommended configuration type.  
Type: String  
Valid Values: `INFRA_ONLY | WORKLOAD_ONLY | ALL`   
Required: No

 ** [ResourceGroupName](#API_DescribeComponentConfigurationRecommendation_RequestSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-request-ResourceGroupName"></a>
The name of the resource group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9\.\-_]*`   
Required: Yes

 ** [Tier](#API_DescribeComponentConfigurationRecommendation_RequestSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-request-Tier"></a>
The tier of the application component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Valid Values: `CUSTOM | DEFAULT | DOT_NET_CORE | DOT_NET_WORKER | DOT_NET_WEB_TIER | DOT_NET_WEB | SQL_SERVER | SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP | MYSQL | POSTGRESQL | JAVA_JMX | ORACLE | SAP_HANA_MULTI_NODE | SAP_HANA_SINGLE_NODE | SAP_HANA_HIGH_AVAILABILITY | SAP_ASE_SINGLE_NODE | SAP_ASE_HIGH_AVAILABILITY | SQL_SERVER_FAILOVER_CLUSTER_INSTANCE | SHAREPOINT | ACTIVE_DIRECTORY | SAP_NETWEAVER_STANDARD | SAP_NETWEAVER_DISTRIBUTED | SAP_NETWEAVER_HIGH_AVAILABILITY`   
Required: Yes

 ** [WorkloadName](#API_DescribeComponentConfigurationRecommendation_RequestSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-request-WorkloadName"></a>
The name of the workload. The name of the workload is required when the tier of the application component is `SAP_ASE_SINGLE_NODE` or `SAP_ASE_HIGH_AVAILABILITY`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `[a-zA-Z0-9\.\-_]*`   
Required: No

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

```
{
   "ComponentConfiguration": "string"
}
```

## Response Elements
<a name="API_DescribeComponentConfigurationRecommendation_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.

 ** [ComponentConfiguration](#API_DescribeComponentConfigurationRecommendation_ResponseSyntax) **   <a name="appinsights-DescribeComponentConfigurationRecommendation-response-ComponentConfiguration"></a>
The recommended configuration settings of the component. The value is the escaped JSON of the configuration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Pattern: `[\S\s]+` 

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

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
The server encountered an internal error and is unable to complete the request.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The resource does not exist in the customer account.  
HTTP Status Code: 400

 ** ValidationException **   
The parameter is not valid.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeComponentConfigurationRecommendation_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/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation)