libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.SelectAggregateResourceConfig

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

Instances

Instances details
Eq SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Read SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Show SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Generic SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Associated Types

type Rep SelectAggregateResourceConfig :: Type -> Type #

NFData SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Hashable SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

ToJSON SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

AWSPager SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

AWSRequest SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

ToHeaders SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

ToPath SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

ToQuery SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

type Rep SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

type Rep SelectAggregateResourceConfig = D1 ('MetaData "SelectAggregateResourceConfig" "Amazonka.Config.SelectAggregateResourceConfig" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "SelectAggregateResourceConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "expression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "configurationAggregatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse SelectAggregateResourceConfig Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

newSelectAggregateResourceConfig Source #

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.

Destructuring the Response

data SelectAggregateResourceConfigResponse Source #

Constructors

SelectAggregateResourceConfigResponse' 

Fields

Instances

Instances details
Eq SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Read SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Show SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

Generic SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

NFData SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

type Rep SelectAggregateResourceConfigResponse Source # 
Instance details

Defined in Amazonka.Config.SelectAggregateResourceConfig

type Rep SelectAggregateResourceConfigResponse = D1 ('MetaData "SelectAggregateResourceConfigResponse" "Amazonka.Config.SelectAggregateResourceConfig" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "SelectAggregateResourceConfigResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "queryInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryInfo))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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