DescribeComponentConfiguration
Describes the monitoring configuration of the component.
Request Syntax
{
"AccountId": "string",
"ComponentName": "string",
"ResourceGroupName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccountId
-
The AWS account ID for the resource group owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$Required: No
- ComponentName
-
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
- ResourceGroupName
-
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
Response Syntax
{
"ComponentConfiguration": "string",
"Monitor": boolean,
"Tier": "string"
}Response Elements
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
-
The 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]+ - Monitor
-
Indicates whether the application component is monitored.
Type: Boolean
- Tier
-
The tier of the application component. Supported tiers include
DOT_NET_CORE,DOT_NET_WORKER,DOT_NET_WEB,SQL_SERVER, andDEFAULTType: 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
Errors
For information about the errors that are common to all actions, see Common Errors.
- 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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
