ListComponents
This API lists the components of an entity.
Request Syntax
POST /workspaces/workspaceId
/entities/entityId
/components-list HTTP/1.1
Content-type: application/json
{
"componentPath": "string
",
"maxResults": number
,
"nextToken": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- entityId
-
The ID for the entity whose metadata (component/properties) is returned by the operation.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|^[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+
Required: Yes
- workspaceId
-
The workspace ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+
Required: Yes
Request Body
The request accepts the following data in JSON format.
- componentPath
-
This string specifies the path to the composite component, starting from the top-level component.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
[a-zA-Z_\-0-9/]+
Required: No
- maxResults
-
The maximum number of results returned at one time. The default is 25.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 200.
Required: No
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"componentSummaries": [
{
"componentName": "string",
"componentPath": "string",
"componentTypeId": "string",
"definedIn": "string",
"description": "string",
"propertyGroups": {
"string" : {
"groupType": "string",
"isInherited": boolean,
"propertyNames": [ "string" ]
}
},
"status": {
"error": {
"code": "string",
"message": "string"
},
"state": "string"
},
"syncSource": "string"
}
],
"nextToken": "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.
- componentSummaries
-
A list of objects that contain information about the components.
Type: Array of ComponentSummary objects
- nextToken
-
The string that specifies the next page of component results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
Failed
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: