/

POST

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the Config Developer Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Expression": "string",
    "Limit": 0,
    "NextToken": "string"
}'

Response Example

200 - Example 1

{
  "Results": [],
  "QueryInfo": {
    "SelectFields": []
  },
  "NextToken": "string"
}

Request

Query Params

Limit

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

Expression

string

required

The SQL query SELECT command.

>= 1 characters<= 4096 characters

Limit

integer

optional

The maximum number of query results returned on each page.

>= 0<= 100

NextToken

string

optional

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Examples

Responses

🟢200Success

application/json

Body

Results

array[string]

optional

Returns the results for the SQL query.

QueryInfo

object

optional

Returns the QueryInfo object.

SelectFields

array[object (FieldInfo) {1}]

optional

Returns a FieldInfo object.

NextToken

string

optional

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

🟠480InvalidExpressionException

🟠481InvalidLimitException

🟠482InvalidNextTokenException

Modified at 2023-08-15 05:59:06