List Groups
resourcegroups_list_groups | R Documentation |
Returns a list of existing Resource Groups in your account¶
Description¶
Returns a list of existing Resource Groups in your account.
Minimum permissions
To run this command, you must have the following permissions:
resource-groups:ListGroups
Usage¶
Arguments¶
Filters
Filters, formatted as GroupFilter objects, that you want to apply to a
list_groups
operation.resource-type
- Filter the results to include only those resource groups that have the specified resource type in theirResourceTypeFilter
. For example,AWS::EC2::Instance
would return any resource group with aResourceTypeFilter
that includesAWS::EC2::Instance
.configuration-type
- Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:AWS::AppRegistry::Application
AWS::AppRegistry::ApplicationResourceGroups
AWS::CloudFormation::Stack
AWS::EC2::CapacityReservationPool
AWS::EC2::HostManagement
AWS::NetworkFirewall::RuleGroup
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(
GroupIdentifiers = list(
list(
GroupName = "string",
GroupArn = "string"
)
),
Groups = list(
list(
GroupArn = "string",
Name = "string",
Description = "string"
)
),
NextToken = "string"
)