You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ResourceGroups::Types::ListGroupResourcesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ResourceGroups::Types::ListGroupResourcesInput
- Defined in:
- (unknown)
Overview
When passing ListGroupResourcesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
group_name: "GroupName",
group: "GroupString",
filters: [
{
name: "resource-type", # required, accepts resource-type
values: ["ResourceFilterValue"], # required
},
],
max_results: 1,
next_token: "NextToken",
}
Instance Attribute Summary collapse
-
#filters ⇒ Array<Types::ResourceFilter>
Filters, formatted as ResourceFilter objects, that you want to apply to a
ListGroupResources
operation. -
#group ⇒ String
The name or the ARN of the resource group.
-
#group_name ⇒ String
Don\'t use this parameter.
-
#max_results ⇒ Integer
The total number of results that you want included on each page of the response.
-
#next_token ⇒ String
The parameter for receiving additional results if you receive a
NextToken
response in a previous request.
Instance Attribute Details
#filters ⇒ Array<Types::ResourceFilter>
Filters, formatted as ResourceFilter objects, that you want to
apply to a ListGroupResources
operation. Filters the results to
include only those of the specified resource types.
resource-type
- Filter resources by their type. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
.
^
When you specify a resource-type
filter for ListGroupResources
, AWS
Resource Groups validates your filter resource types against the types
that are defined in the query associated with the group. For example, if
a group contains only S3 buckets because its query specifies only that
resource type, but your resource-type
filter includes EC2 instances,
AWS Resource Groups does not filter for EC2 instances. In this case, a
ListGroupResources
request returns a BadRequestException
error with
a message similar to the following:
The resource types specified as filters in the request are not valid.
The error includes a list of resource types that failed the validation
because they are not part of the query associated with the group. This
validation doesn\'t occur when the group query specifies
AWS::AllSupported
, because a group based on such a query can contain
any of the allowed resource types for the query type (tag-based or AWS
CloudFormation stack-based queries).
#group ⇒ String
The name or the ARN of the resource group
#group_name ⇒ String
Don\'t use this parameter. Use Group
instead.
#max_results ⇒ Integer
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.
#next_token ⇒ String
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.