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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, Config lists 100 resource identifiers 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.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDiscoveredResources Source #

See: newListDiscoveredResources smart constructor.

Constructors

ListDiscoveredResources'

Fields

includeDeletedResources :: Maybe Bool
Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.
limit :: Maybe Natural
The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.
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.
resourceIds :: Maybe [Text]
The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
resourceName :: Maybe Text
The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
resourceType :: ResourceType
The type of resources that you want Config to list in the response.

Instances

Instances details

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

newListDiscoveredResources Source #

Arguments

:: ResourceType	`ListDiscoveredResources`
-> ListDiscoveredResources

Create a value of ListDiscoveredResources 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:includeDeletedResources:ListDiscoveredResources', listDiscoveredResources_includeDeletedResources - Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

$sel:limit:ListDiscoveredResources', listDiscoveredResources_limit - The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

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

ListDiscoveredResources, listDiscoveredResources_resourceIds - The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

ListDiscoveredResources, listDiscoveredResources_resourceName - The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

ListDiscoveredResources, listDiscoveredResources_resourceType - The type of resources that you want Config to list in the response.

Request Lenses

listDiscoveredResources_includeDeletedResources :: Lens' ListDiscoveredResources (Maybe Bool) Source #

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

listDiscoveredResources_limit :: Lens' ListDiscoveredResources (Maybe Natural) Source #

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

listDiscoveredResources_nextToken :: Lens' ListDiscoveredResources (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.

listDiscoveredResources_resourceIds :: Lens' ListDiscoveredResources (Maybe [Text]) Source #

The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

listDiscoveredResources_resourceName :: Lens' ListDiscoveredResources (Maybe Text) Source #

The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

listDiscoveredResources_resourceType :: Lens' ListDiscoveredResources ResourceType Source #

The type of resources that you want Config to list in the response.

Destructuring the Response

data ListDiscoveredResourcesResponse Source #

See: newListDiscoveredResourcesResponse smart constructor.

Constructors

ListDiscoveredResourcesResponse'
Fields nextToken :: Maybe Text The string that you use in a subsequent request to get the next page of results in a paginated response. resourceIdentifiers :: Maybe [ResourceIdentifier] The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListDiscoveredResourcesResponse Source #

Arguments

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

Create a value of ListDiscoveredResourcesResponse 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:

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

$sel:resourceIdentifiers:ListDiscoveredResourcesResponse', listDiscoveredResourcesResponse_resourceIdentifiers - The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

$sel:httpStatus:ListDiscoveredResourcesResponse', listDiscoveredResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listDiscoveredResourcesResponse_nextToken :: Lens' ListDiscoveredResourcesResponse (Maybe Text) Source #

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

listDiscoveredResourcesResponse_resourceIdentifiers :: Lens' ListDiscoveredResourcesResponse (Maybe [ResourceIdentifier]) Source #

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

listDiscoveredResourcesResponse_httpStatus :: Lens' ListDiscoveredResourcesResponse Int Source #

The response's http status code.