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 |
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
- data ListDiscoveredResources = ListDiscoveredResources' {}
- newListDiscoveredResources :: ResourceType -> ListDiscoveredResources
- listDiscoveredResources_includeDeletedResources :: Lens' ListDiscoveredResources (Maybe Bool)
- listDiscoveredResources_limit :: Lens' ListDiscoveredResources (Maybe Natural)
- listDiscoveredResources_nextToken :: Lens' ListDiscoveredResources (Maybe Text)
- listDiscoveredResources_resourceIds :: Lens' ListDiscoveredResources (Maybe [Text])
- listDiscoveredResources_resourceName :: Lens' ListDiscoveredResources (Maybe Text)
- listDiscoveredResources_resourceType :: Lens' ListDiscoveredResources ResourceType
- data ListDiscoveredResourcesResponse = ListDiscoveredResourcesResponse' {}
- newListDiscoveredResourcesResponse :: Int -> ListDiscoveredResourcesResponse
- listDiscoveredResourcesResponse_nextToken :: Lens' ListDiscoveredResourcesResponse (Maybe Text)
- listDiscoveredResourcesResponse_resourceIdentifiers :: Lens' ListDiscoveredResourcesResponse (Maybe [ResourceIdentifier])
- listDiscoveredResourcesResponse_httpStatus :: Lens' ListDiscoveredResourcesResponse Int
Creating a Request
data ListDiscoveredResources Source #
See: newListDiscoveredResources
smart constructor.
ListDiscoveredResources' | |
|
Instances
newListDiscoveredResources Source #
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.
ListDiscoveredResourcesResponse' | |
|
Instances
newListDiscoveredResourcesResponse Source #
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.