/

POST

Returns details about your Config rules.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ConfigRuleNames": [],
    "NextToken": "string",
    "Filters": {
        "EvaluationMode": "DETECTIVE"
    }
}'

Response Example

200 - Example 1

{
    "ConfigRules": [],
    "NextToken": "string"
}

Request

Query Params

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

<p/>

ConfigRuleNames

array[string]

optional

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

>= 0 items<= 25 items

NextToken

string

optional

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

Filters

object

optional

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.

EvaluationMode

enum<string>

optional

The mode of an evaluation. The valid values are Detective or Proactive.

Allowed values:

DETECTIVEPROACTIVE

Examples

Responses

🟢200Success

application/json

Body

<p/>

ConfigRules

array [object]

optional

The details about your Config rules.

NextToken

string

optional

The string that you use in a subsequent request to get the next page of results in a paginated response.

🟠480NoSuchConfigRuleException

🟠481InvalidNextTokenException

🟠482InvalidParameterValueException

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