ListEntities
Lists all entities in a workspace.
Request Syntax
POST /workspaces/workspaceId/entities-list HTTP/1.1
Content-type: application/json
{
"filters": [
{ ... }
],
"maxResults": number,
"nextToken": "string"
}URI Request Parameters
The request uses the following URI parameters.
- workspaceId
-
The ID of the workspace.
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.
- filters
-
A list of objects that filter the request.
Note
Only one object is accepted as a valid input.
Type: Array of ListEntitiesFilter objects
Required: No
- maxResults
-
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
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
{
"entitySummaries": [
{
"arn": "string",
"creationDateTime": number,
"description": "string",
"entityId": "string",
"entityName": "string",
"hasChildEntities": boolean,
"parentEntityId": "string",
"status": {
"error": {
"code": "string",
"message": "string"
},
"state": "string"
},
"updateDateTime": number
}
],
"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.
- entitySummaries
-
A list of objects that contain information about the entities.
Type: Array of EntitySummary objects
- nextToken
-
The string that specifies the next page of 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.
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
The service quota was exceeded.
HTTP Status Code: 402
- 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: