ExecuteQuery
Run queries to access information from your knowledge graph of entities within individual workspaces.
Note
The ExecuteQuery action only works with AWS Java SDK2. ExecuteQuery will not work with any AWS Java SDK version < 2.x.
Request Syntax
POST /queries/execution HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"queryStatement": "string",
"workspaceId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of results to return at one time. The default is 50.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
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
- queryStatement
-
The query statement.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[\s\S]+Required: Yes
- workspaceId
-
The ID of the workspace.
Type: String
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
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"columnDescriptions": [
{
"name": "string",
"type": "string"
}
],
"nextToken": "string",
"rows": [
{
"rowData": [ JSON value ]
}
]
}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.
- columnDescriptions
-
A list of ColumnDescription objects.
Type: Array of ColumnDescription objects
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.* - rows
-
Represents a single row in the query results.
Type: Array of Row objects
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
- QueryTimeoutException
-
The query timeout exception.
HTTP Status Code: 400
- 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 AWS SDKs, see the following:
