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

Amazonka.Config.GetDiscoveredResourceCounts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

Example

Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.
Config returns the following:
- The resource types (EC2 instances, IAM users, and S3 buckets).
- The number of each resource type (25, 20, and 15).
- The total number of all resources (60).

The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

You are a new Config customer.
You just enabled resource recording.

It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

Synopsis

Creating a Request

data GetDiscoveredResourceCounts Source #

See: newGetDiscoveredResourceCounts smart constructor.

Constructors

GetDiscoveredResourceCounts'

Fields

nextToken :: Maybe Text
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
limit :: Maybe Natural
The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
resourceTypes :: Maybe [Text]
The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").
If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.
If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

Instances

Instances details

Eq GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods (==) :: GetDiscoveredResourceCounts -> GetDiscoveredResourceCounts -> Bool # (/=) :: GetDiscoveredResourceCounts -> GetDiscoveredResourceCounts -> Bool #
Read GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods readsPrec :: Int -> ReadS GetDiscoveredResourceCounts # readList :: ReadS [GetDiscoveredResourceCounts] # readPrec :: ReadPrec GetDiscoveredResourceCounts # readListPrec :: ReadPrec [GetDiscoveredResourceCounts] #
Show GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods showsPrec :: Int -> GetDiscoveredResourceCounts -> ShowS # show :: GetDiscoveredResourceCounts -> String # showList :: [GetDiscoveredResourceCounts] -> ShowS #
Generic GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Associated Types type Rep GetDiscoveredResourceCounts :: Type -> Type # Methods from :: GetDiscoveredResourceCounts -> Rep GetDiscoveredResourceCounts x # to :: Rep GetDiscoveredResourceCounts x -> GetDiscoveredResourceCounts #
NFData GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods rnf :: GetDiscoveredResourceCounts -> () #
Hashable GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods hashWithSalt :: Int -> GetDiscoveredResourceCounts -> Int # hash :: GetDiscoveredResourceCounts -> Int #
ToJSON GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods toJSON :: GetDiscoveredResourceCounts -> Value # toEncoding :: GetDiscoveredResourceCounts -> Encoding # toJSONList :: [GetDiscoveredResourceCounts] -> Value # toEncodingList :: [GetDiscoveredResourceCounts] -> Encoding #
AWSRequest GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Associated Types type AWSResponse GetDiscoveredResourceCounts # Methods request :: GetDiscoveredResourceCounts -> Request GetDiscoveredResourceCounts # response :: MonadResource m => Logger -> Service -> Proxy GetDiscoveredResourceCounts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDiscoveredResourceCounts))) #
ToHeaders GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods toHeaders :: GetDiscoveredResourceCounts -> [Header] #
ToPath GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods toPath :: GetDiscoveredResourceCounts -> ByteString #
ToQuery GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts Methods toQuery :: GetDiscoveredResourceCounts -> QueryString #
type Rep GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts type Rep GetDiscoveredResourceCounts = D1 ('MetaData "GetDiscoveredResourceCounts" "Amazonka.Config.GetDiscoveredResourceCounts" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "GetDiscoveredResourceCounts'" '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 "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))
type AWSResponse GetDiscoveredResourceCounts Source #
Instance details Defined in Amazonka.Config.GetDiscoveredResourceCounts type AWSResponse GetDiscoveredResourceCounts = GetDiscoveredResourceCountsResponse

newGetDiscoveredResourceCounts :: GetDiscoveredResourceCounts Source #

Create a value of GetDiscoveredResourceCounts 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:GetDiscoveredResourceCounts', getDiscoveredResourceCounts_nextToken - The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

$sel:limit:GetDiscoveredResourceCounts', getDiscoveredResourceCounts_limit - The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

$sel:resourceTypes:GetDiscoveredResourceCounts', getDiscoveredResourceCounts_resourceTypes - The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

Request Lenses

getDiscoveredResourceCounts_nextToken :: Lens' GetDiscoveredResourceCounts (Maybe Text) Source #

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

getDiscoveredResourceCounts_limit :: Lens' GetDiscoveredResourceCounts (Maybe Natural) Source #

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

getDiscoveredResourceCounts_resourceTypes :: Lens' GetDiscoveredResourceCounts (Maybe [Text]) Source #

The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

Destructuring the Response

data GetDiscoveredResourceCountsResponse Source #

See: newGetDiscoveredResourceCountsResponse smart constructor.

Constructors

GetDiscoveredResourceCountsResponse'

Fields

totalDiscoveredResources :: Maybe Integer
The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.
Example
1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.
3. Config returns 25 for totalDiscoveredResources.
nextToken :: Maybe Text
The string that you use in a subsequent request to get the next page of results in a paginated response.
resourceCounts :: Maybe [ResourceCount]
The list of ResourceCount objects. Each object is listed in descending order by the number of resources.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetDiscoveredResourceCountsResponse Source #

Arguments

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

Create a value of GetDiscoveredResourceCountsResponse 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:totalDiscoveredResources:GetDiscoveredResourceCountsResponse', getDiscoveredResourceCountsResponse_totalDiscoveredResources - The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.
Config returns 25 for totalDiscoveredResources.

$sel:nextToken:GetDiscoveredResourceCounts', getDiscoveredResourceCountsResponse_nextToken - The string that you use in a subsequent request to get the next page of results in a paginated response.

$sel:resourceCounts:GetDiscoveredResourceCountsResponse', getDiscoveredResourceCountsResponse_resourceCounts - The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

$sel:httpStatus:GetDiscoveredResourceCountsResponse', getDiscoveredResourceCountsResponse_httpStatus - The response's http status code.

Response Lenses

getDiscoveredResourceCountsResponse_totalDiscoveredResources :: Lens' GetDiscoveredResourceCountsResponse (Maybe Integer) Source #

The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.
Config returns 25 for totalDiscoveredResources.

getDiscoveredResourceCountsResponse_nextToken :: Lens' GetDiscoveredResourceCountsResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

getDiscoveredResourceCountsResponse_resourceCounts :: Lens' GetDiscoveredResourceCountsResponse (Maybe [ResourceCount]) Source #

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

getDiscoveredResourceCountsResponse_httpStatus :: Lens' GetDiscoveredResourceCountsResponse Int Source #

The response's http status code.