[ aws . configservice ]

select-aggregate-resource-config

Description

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the ` Query Components https://docs.aws.amazon.com/config/latest/developerguide/query-components.html`__ section in the AWS Config Developer Guide.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  select-aggregate-resource-config
--expression <value>
--configuration-aggregator-name <value>
[--limit <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--expression (string)

The SQL query SELECT command.

--configuration-aggregator-name (string)

The name of the configuration aggregator.

--limit (integer)

The maximum number of query results returned on each page.

--max-results (integer)

The maximum number of query results returned on each page. AWS Config also allows the Limit request parameter.

--next-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Results -> (list)

Returns the results for the SQL query.

(string)

QueryInfo -> (structure)

Details about the query.

SelectFields -> (list)

Returns a FieldInfo object.

(structure)

Details about the fields such as name of the field.

Name -> (string)

Name of the field.

NextToken -> (string)

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