Struct aws_sdk_resourcegroups::client::fluent_builders::SearchResources

pub struct SearchResources<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to SearchResources.

Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

Minimum permissions

To run this command, you must have the following permissions:

• resource-groups:SearchResources

• cloudformation:DescribeStacks

• cloudformation:ListStackResources

• tag:GetResources

Implementations

impl<C, M, R> SearchResources<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<SearchResourcesOutput, SdkError<SearchResourcesError>> where
    R::Policy: SmithyRetryPolicy<SearchResourcesInputOperationOutputAlias, SearchResourcesOutput, SearchResourcesError, SearchResourcesInputOperationRetryAlias>, 

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.

pub fn resource_query(self, inp: ResourceQuery) -> Self

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

pub fn set_resource_query(self, input: Option<ResourceQuery>) -> Self

The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.

pub fn max_results(self, inp: i32) -> Self

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.

pub fn set_max_results(self, input: Option<i32>) -> Self

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.

pub fn next_token(self, inp: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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

impl<C: Debug, M: Debug, R: Debug> Debug for SearchResources<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.