Skip to content

Select Aggregate Resource Config

configservice_select_aggregate_resource_config R Documentation

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

Description

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services 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 section in the Config Developer Guide.

If you run an aggregation query (i.e., using ⁠GROUP BY⁠ or using aggregate functions such as COUNT; e.g., ⁠SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId⁠) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

If you run a non-aggregation query (i.e., not using ⁠GROUP BY⁠ or aggregate function; e.g., ⁠SELECT * WHERE resourceType = 'AWS::IAM::Role'⁠) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.

Usage

configservice_select_aggregate_resource_config(Expression,
  ConfigurationAggregatorName, Limit, MaxResults, NextToken)

Arguments

Expression

[required] The SQL query SELECT command.

ConfigurationAggregatorName

[required] The name of the configuration aggregator.

Limit

The maximum number of query results returned on each page.

MaxResults

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

NextToken

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

Value

A list with the following syntax: 

list(
  Results = list(
    "string"
  ),
  QueryInfo = list(
    SelectFields = list(
      list(
        Name = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$select_aggregate_resource_config(
  Expression = "string",
  ConfigurationAggregatorName = "string",
  Limit = 123,
  MaxResults = 123,
  NextToken = "string"
)