| 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.ResourceGroups.SearchResources
Description
Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:SearchResources
cloudformation:DescribeStacks
cloudformation:ListStackResources
tag:GetResources
This operation returns paginated results.
Synopsis
- data SearchResources = SearchResources' {}
- newSearchResources :: ResourceQuery -> SearchResources
- searchResources_nextToken :: Lens' SearchResources (Maybe Text)
- searchResources_maxResults :: Lens' SearchResources (Maybe Natural)
- searchResources_resourceQuery :: Lens' SearchResources ResourceQuery
- data SearchResourcesResponse = SearchResourcesResponse' {}
- newSearchResourcesResponse :: Int -> SearchResourcesResponse
- searchResourcesResponse_queryErrors :: Lens' SearchResourcesResponse (Maybe [QueryError])
- searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (Maybe Text)
- searchResourcesResponse_resourceIdentifiers :: Lens' SearchResourcesResponse (Maybe [ResourceIdentifier])
- searchResourcesResponse_httpStatus :: Lens' SearchResourcesResponse Int
Creating a Request
data SearchResources Source #
See: newSearchResources smart constructor.
Constructors
| SearchResources' | |
Fields
| |
Instances
Create a value of SearchResources 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:SearchResources', searchResources_nextToken - The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
provided by a previous call's NextToken response to indicate where
the output should continue from.
$sel:maxResults:SearchResources', searchResources_maxResults - The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the NextToken response element is present and has
a value (is not null). Include that value as the NextToken request
parameter in the next call to the operation to get the next part of the
results. Note that the service might return fewer results than the
maximum even when there are more results available. You should check
NextToken after every operation to ensure that you receive all of the
results.
$sel:resourceQuery:SearchResources', searchResources_resourceQuery - The search query, using the same formats that are supported for resource
group definition. For more information, see CreateGroup.
Request Lenses
searchResources_nextToken :: Lens' SearchResources (Maybe Text) Source #
The parameter for receiving additional results if you receive a
NextToken response in a previous request. A NextToken response
indicates that more output is available. Set this parameter to the value
provided by a previous call's NextToken response to indicate where
the output should continue from.
searchResources_maxResults :: Lens' SearchResources (Maybe Natural) Source #
The total number of results that you want included on each page of the
response. If you do not include this parameter, it defaults to a value
that is specific to the operation. If additional items exist beyond the
maximum you specify, the NextToken response element is present and has
a value (is not null). Include that value as the NextToken request
parameter in the next call to the operation to get the next part of the
results. Note that the service might return fewer results than the
maximum even when there are more results available. You should check
NextToken after every operation to ensure that you receive all of the
results.
searchResources_resourceQuery :: Lens' SearchResources ResourceQuery Source #
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
Destructuring the Response
data SearchResourcesResponse Source #
See: newSearchResourcesResponse smart constructor.
Constructors
| SearchResourcesResponse' | |
Fields
| |
Instances
newSearchResourcesResponse Source #
Create a value of SearchResourcesResponse 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:queryErrors:SearchResourcesResponse', searchResourcesResponse_queryErrors - A list of QueryError objects. Each error is an object that contains
ErrorCode and Message structures. Possible values for ErrorCode
are CLOUDFORMATION_STACK_INACTIVE and
CLOUDFORMATION_STACK_NOT_EXISTING.
$sel:nextToken:SearchResources', searchResourcesResponse_nextToken - If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
$sel:resourceIdentifiers:SearchResourcesResponse', searchResourcesResponse_resourceIdentifiers - The ARNs and resource types of resources that are members of the group
that you specified.
$sel:httpStatus:SearchResourcesResponse', searchResourcesResponse_httpStatus - The response's http status code.
Response Lenses
searchResourcesResponse_queryErrors :: Lens' SearchResourcesResponse (Maybe [QueryError]) Source #
A list of QueryError objects. Each error is an object that contains
ErrorCode and Message structures. Possible values for ErrorCode
are CLOUDFORMATION_STACK_INACTIVE and
CLOUDFORMATION_STACK_NOT_EXISTING.
searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (Maybe Text) Source #
If present, indicates that more output is available than is included in
the current response. Use this value in the NextToken request
parameter in a subsequent call to the operation to get the next part of
the output. You should repeat this until the NextToken response
element comes back as null.
searchResourcesResponse_resourceIdentifiers :: Lens' SearchResourcesResponse (Maybe [ResourceIdentifier]) Source #
The ARNs and resource types of resources that are members of the group that you specified.
searchResourcesResponse_httpStatus :: Lens' SearchResourcesResponse Int Source #
The response's http status code.