Struct aws_sdk_resourcegroups::client::fluent_builders::ListGroups [−][src]
pub struct ListGroups<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to ListGroups
.
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
Implementations
impl<C, M, R> ListGroups<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> ListGroups<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(self) -> Result<ListGroupsOutput, SdkError<ListGroupsError>> where
R::Policy: SmithyRetryPolicy<ListGroupsInputOperationOutputAlias, ListGroupsOutput, ListGroupsError, ListGroupsInputOperationRetryAlias>,
pub async fn send(self) -> Result<ListGroupsOutput, SdkError<ListGroupsError>> where
R::Policy: SmithyRetryPolicy<ListGroupsInputOperationOutputAlias, ListGroupsOutput, ListGroupsError, ListGroupsInputOperationRetryAlias>,
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.
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
Filters, formatted as GroupFilter objects, that you want to apply to
a ListGroups
operation.
-
resource-type
- Filter the results to include only those of the specified resource types. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
. -
configuration-type
- Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:-
AWS:EC2::CapacityReservationPool
-
AWS:EC2::HostManagement
-
Filters, formatted as GroupFilter objects, that you want to apply to
a ListGroups
operation.
-
resource-type
- Filter the results to include only those of the specified resource types. Specify up to five resource types in the formatAWS::ServiceCode::ResourceType
. For example,AWS::EC2::Instance
, orAWS::S3::Bucket
. -
configuration-type
- Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:-
AWS:EC2::CapacityReservationPool
-
AWS:EC2::HostManagement
-
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 ListGroups<C, M, R>
impl<C, M, R> Unpin for ListGroups<C, M, R>
impl<C = DynConnector, M = AwsMiddleware, R = Standard> !UnwindSafe for ListGroups<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