Struct aws_sdk_resourcegroups::client::fluent_builders::ListGroupResources [−][src]
pub struct ListGroupResources<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to ListGroupResources
.
Returns a list of ARNs of the resources that are members of a specified resource group.
Minimum permissions
To run this command, you must have the following permissions:
-
resource-groups:ListGroupResources
-
cloudformation:DescribeStacks
-
cloudformation:ListStackResources
-
tag:GetResources
Implementations
impl<C, M, R> ListGroupResources<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> ListGroupResources<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<ListGroupResourcesOutput, SdkError<ListGroupResourcesError>> where
R::Policy: SmithyRetryPolicy<ListGroupResourcesInputOperationOutputAlias, ListGroupResourcesOutput, ListGroupResourcesError, ListGroupResourcesInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<ListGroupResourcesOutput, SdkError<ListGroupResourcesError>> where
R::Policy: SmithyRetryPolicy<ListGroupResourcesInputOperationOutputAlias, ListGroupResourcesOutput, ListGroupResourcesError, ListGroupResourcesInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Deprecated - don't use this parameter. Use the
Group
request field instead.
Deprecated - don't use this parameter. Use the
Group
request field instead.
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
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).
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).
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.
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.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !RefUnwindSafe for ListGroupResources<C, M, R>
impl<C, M, R> Send for ListGroupResources<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for ListGroupResources<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for ListGroupResources<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for ListGroupResources<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more