Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Config.SelectAggregateResourceConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

This operation returns paginated results.

Synopsis

Creating a Request

data SelectAggregateResourceConfig Source #

See: newSelectAggregateResourceConfig smart constructor.

Constructors

SelectAggregateResourceConfig'

Fields

limit :: Maybe Natural
The maximum number of query results returned on each page.
maxResults :: Maybe Natural
The maximum number of query results returned on each page. Config also allows the Limit request parameter.
nextToken :: Maybe Text
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
expression :: Text
The SQL query SELECT command.
configurationAggregatorName :: Text
The name of the configuration aggregator.

Instances

Instances details

ToJSON SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods toJSON :: SelectAggregateResourceConfig -> Value # toEncoding :: SelectAggregateResourceConfig -> Encoding # toJSONList :: [SelectAggregateResourceConfig] -> Value # toEncodingList :: [SelectAggregateResourceConfig] -> Encoding #
ToHeaders SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods toHeaders :: SelectAggregateResourceConfig -> [Header] #
ToPath SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods toPath :: SelectAggregateResourceConfig -> ByteString #
ToQuery SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods toQuery :: SelectAggregateResourceConfig -> QueryString #
AWSPager SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods page :: SelectAggregateResourceConfig -> AWSResponse SelectAggregateResourceConfig -> Maybe SelectAggregateResourceConfig #
AWSRequest SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Associated Types type AWSResponse SelectAggregateResourceConfig # Methods request :: (Service -> Service) -> SelectAggregateResourceConfig -> Request SelectAggregateResourceConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SelectAggregateResourceConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SelectAggregateResourceConfig))) #
Generic SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Associated Types type Rep SelectAggregateResourceConfig :: Type -> Type # Methods from :: SelectAggregateResourceConfig -> Rep SelectAggregateResourceConfig x # to :: Rep SelectAggregateResourceConfig x -> SelectAggregateResourceConfig #
Read SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods readsPrec :: Int -> ReadS SelectAggregateResourceConfig # readList :: ReadS [SelectAggregateResourceConfig] # readPrec :: ReadPrec SelectAggregateResourceConfig # readListPrec :: ReadPrec [SelectAggregateResourceConfig] #
Show SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods showsPrec :: Int -> SelectAggregateResourceConfig -> ShowS # show :: SelectAggregateResourceConfig -> String # showList :: [SelectAggregateResourceConfig] -> ShowS #
NFData SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods rnf :: SelectAggregateResourceConfig -> () #
Eq SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods (==) :: SelectAggregateResourceConfig -> SelectAggregateResourceConfig -> Bool # (/=) :: SelectAggregateResourceConfig -> SelectAggregateResourceConfig -> Bool #
Hashable SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods hashWithSalt :: Int -> SelectAggregateResourceConfig -> Int # hash :: SelectAggregateResourceConfig -> Int #
type AWSResponse SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig type AWSResponse SelectAggregateResourceConfig = SelectAggregateResourceConfigResponse
type Rep SelectAggregateResourceConfig Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig type Rep SelectAggregateResourceConfig = D1 ('MetaData "SelectAggregateResourceConfig" "Amazonka.Config.SelectAggregateResourceConfig" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "SelectAggregateResourceConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "configurationAggregatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSelectAggregateResourceConfig Source #

Arguments

:: Text	`SelectAggregateResourceConfig`
-> Text	`SelectAggregateResourceConfig`
-> 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: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.

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.

SelectAggregateResourceConfig, selectAggregateResourceConfig_expression - The SQL query SELECT command.

SelectAggregateResourceConfig, selectAggregateResourceConfig_configurationAggregatorName - The name of the configuration aggregator.

Request Lenses

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_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_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.

Constructors

SelectAggregateResourceConfigResponse'
Fields nextToken :: Maybe Text The nextToken string returned in a previous request that you use to request the next page of results in a paginated response. queryInfo :: Maybe QueryInfo results :: Maybe [Text] Returns the results for the SQL query. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Associated Types type Rep SelectAggregateResourceConfigResponse :: Type -> Type # Methods from :: SelectAggregateResourceConfigResponse -> Rep SelectAggregateResourceConfigResponse x # to :: Rep SelectAggregateResourceConfigResponse x -> SelectAggregateResourceConfigResponse #
Read SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods readsPrec :: Int -> ReadS SelectAggregateResourceConfigResponse # readList :: ReadS [SelectAggregateResourceConfigResponse] # readPrec :: ReadPrec SelectAggregateResourceConfigResponse # readListPrec :: ReadPrec [SelectAggregateResourceConfigResponse] #
Show SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods showsPrec :: Int -> SelectAggregateResourceConfigResponse -> ShowS # show :: SelectAggregateResourceConfigResponse -> String # showList :: [SelectAggregateResourceConfigResponse] -> ShowS #
NFData SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods rnf :: SelectAggregateResourceConfigResponse -> () #
Eq SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig Methods (==) :: SelectAggregateResourceConfigResponse -> SelectAggregateResourceConfigResponse -> Bool # (/=) :: SelectAggregateResourceConfigResponse -> SelectAggregateResourceConfigResponse -> Bool #
type Rep SelectAggregateResourceConfigResponse Source #
Instance details Defined in Amazonka.Config.SelectAggregateResourceConfig type Rep SelectAggregateResourceConfigResponse = D1 ('MetaData "SelectAggregateResourceConfigResponse" "Amazonka.Config.SelectAggregateResourceConfig" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "SelectAggregateResourceConfigResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryInfo))) :: (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSelectAggregateResourceConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:SelectAggregateResourceConfigResponse'`
-> SelectAggregateResourceConfigResponse

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:

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:queryInfo:SelectAggregateResourceConfigResponse', selectAggregateResourceConfigResponse_queryInfo - Undocumented member.

$sel:results:SelectAggregateResourceConfigResponse', selectAggregateResourceConfigResponse_results - Returns the results for the SQL query.

$sel:httpStatus:SelectAggregateResourceConfigResponse', selectAggregateResourceConfigResponse_httpStatus - The response's http status code.

Response Lenses

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_queryInfo :: Lens' SelectAggregateResourceConfigResponse (Maybe QueryInfo) Source #

Undocumented member.

selectAggregateResourceConfigResponse_results :: Lens' SelectAggregateResourceConfigResponse (Maybe [Text]) Source #

Returns the results for the SQL query.

selectAggregateResourceConfigResponse_httpStatus :: Lens' SelectAggregateResourceConfigResponse Int Source #

The response's http status code.