Search Resources
resourcegroups_search_resources | R Documentation |
Returns a list of Amazon Web Services resource identifiers that matches the specified query¶
Description¶
Returns a list of Amazon Web Services resource identifiers that matches
the specified query. The query uses the same format as a resource query
in a create_group
or update_group_query
operation.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:SearchResources
-
cloudformation:DescribeStacks
-
cloudformation:ListStackResources
-
tag:GetResources
Usage¶
Arguments¶
ResourceQuery
[required] The search query, using the same formats that are supported for resource group definition. For more information, see
create_group
.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 theNextToken
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 checkNextToken
after every operation to ensure that you receive all of the results.NextToken
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value provided by a previous call'sNextToken
response to indicate where the output should continue from.
Value¶
A list with the following syntax:
list(
ResourceIdentifiers = list(
list(
ResourceArn = "string",
ResourceType = "string"
)
),
NextToken = "string",
QueryErrors = list(
list(
ErrorCode = "CLOUDFORMATION_STACK_INACTIVE"|"CLOUDFORMATION_STACK_NOT_EXISTING"|"CLOUDFORMATION_STACK_UNASSUMABLE_ROLE"|"RESOURCE_TYPE_NOT_SUPPORTED",
Message = "string"
)
)
)