Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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.
This operation returns paginated results.
Synopsis
- data SelectAggregateResourceConfig = SelectAggregateResourceConfig' {}
- newSelectAggregateResourceConfig :: Text -> Text -> SelectAggregateResourceConfig
- selectAggregateResourceConfig_nextToken :: Lens' SelectAggregateResourceConfig (Maybe Text)
- selectAggregateResourceConfig_limit :: Lens' SelectAggregateResourceConfig (Maybe Natural)
- selectAggregateResourceConfig_maxResults :: Lens' SelectAggregateResourceConfig (Maybe Natural)
- selectAggregateResourceConfig_expression :: Lens' SelectAggregateResourceConfig Text
- selectAggregateResourceConfig_configurationAggregatorName :: Lens' SelectAggregateResourceConfig Text
- data SelectAggregateResourceConfigResponse = SelectAggregateResourceConfigResponse' {}
- newSelectAggregateResourceConfigResponse :: Int -> SelectAggregateResourceConfigResponse
- selectAggregateResourceConfigResponse_results :: Lens' SelectAggregateResourceConfigResponse (Maybe [Text])
- selectAggregateResourceConfigResponse_queryInfo :: Lens' SelectAggregateResourceConfigResponse (Maybe QueryInfo)
- selectAggregateResourceConfigResponse_nextToken :: Lens' SelectAggregateResourceConfigResponse (Maybe Text)
- selectAggregateResourceConfigResponse_httpStatus :: Lens' SelectAggregateResourceConfigResponse Int
Creating a Request
data SelectAggregateResourceConfig Source #
See: newSelectAggregateResourceConfig
smart constructor.
SelectAggregateResourceConfig' | |
|
Instances
newSelectAggregateResourceConfig Source #
:: Text | |
-> Text |
|
-> SelectAggregateResourceConfig |
Create a value of SelectAggregateResourceConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:SelectAggregateResourceConfig'
, selectAggregateResourceConfig_nextToken
- The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
$sel:limit:SelectAggregateResourceConfig'
, selectAggregateResourceConfig_limit
- The maximum number of query results returned on each page.
$sel:maxResults:SelectAggregateResourceConfig'
, selectAggregateResourceConfig_maxResults
- The maximum number of query results returned on each page. Config also
allows the Limit request parameter.
$sel:expression:SelectAggregateResourceConfig'
, selectAggregateResourceConfig_expression
- The SQL query SELECT command.
$sel:configurationAggregatorName:SelectAggregateResourceConfig'
, selectAggregateResourceConfig_configurationAggregatorName
- The name of the configuration aggregator.
Request Lenses
selectAggregateResourceConfig_nextToken :: Lens' SelectAggregateResourceConfig (Maybe Text) Source #
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
selectAggregateResourceConfig_limit :: Lens' SelectAggregateResourceConfig (Maybe Natural) Source #
The maximum number of query results returned on each page.
selectAggregateResourceConfig_maxResults :: Lens' SelectAggregateResourceConfig (Maybe Natural) Source #
The maximum number of query results returned on each page. Config also allows the Limit request parameter.
selectAggregateResourceConfig_expression :: Lens' SelectAggregateResourceConfig Text Source #
The SQL query SELECT command.
selectAggregateResourceConfig_configurationAggregatorName :: Lens' SelectAggregateResourceConfig Text Source #
The name of the configuration aggregator.
Destructuring the Response
data SelectAggregateResourceConfigResponse Source #
See: newSelectAggregateResourceConfigResponse
smart constructor.
Instances
newSelectAggregateResourceConfigResponse Source #
Create a value of SelectAggregateResourceConfigResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:results:SelectAggregateResourceConfigResponse'
, selectAggregateResourceConfigResponse_results
- Returns the results for the SQL query.
$sel:queryInfo:SelectAggregateResourceConfigResponse'
, selectAggregateResourceConfigResponse_queryInfo
- Undocumented member.
$sel:nextToken:SelectAggregateResourceConfig'
, selectAggregateResourceConfigResponse_nextToken
- The nextToken string returned in a previous request that you use to
request the next page of results in a paginated response.
$sel:httpStatus:SelectAggregateResourceConfigResponse'
, selectAggregateResourceConfigResponse_httpStatus
- The response's http status code.
Response Lenses
selectAggregateResourceConfigResponse_results :: Lens' SelectAggregateResourceConfigResponse (Maybe [Text]) Source #
Returns the results for the SQL query.
selectAggregateResourceConfigResponse_queryInfo :: Lens' SelectAggregateResourceConfigResponse (Maybe QueryInfo) Source #
Undocumented member.
selectAggregateResourceConfigResponse_nextToken :: Lens' SelectAggregateResourceConfigResponse (Maybe Text) Source #
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
selectAggregateResourceConfigResponse_httpStatus :: Lens' SelectAggregateResourceConfigResponse Int Source #
The response's http status code.