DescribeComponent
Describes a component and lists the resources that are grouped together in a 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
{
"ApplicationComponent": {
"ComponentName": "string",
"ComponentRemarks": "string",
"DetectedWorkload": {
"string" : {
"string" : "string"
}
},
"Monitor": boolean,
"OsType": "string",
"ResourceType": "string",
"Tier": "string"
},
"ResourceList": [ "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.
- ApplicationComponent
-
Describes a standalone resource or similarly grouped resources that the application is made up of.
Type: ApplicationComponent object
- ResourceList
-
The list of resource ARNs that belong to the component.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
^arn:aws(-\w+)*:[\w\d-]+:([\w\d-]*)?:[\w\d_-]*([:/].+)*$
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:
