aws_sdk_resourceexplorer2/client/

list_resources.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListResources`](crate::operation::list_resources::builders::ListResourcesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(SearchFilter)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::filters) / [`set_filters(Option<SearchFilter>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::set_filters):<br>required: **false**<br><p>An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a <code>Search</code> operation, the filter string is combined with the search's <code>QueryString</code> parameter using a logical <code>AND</code> operator.</p> <p>For information about the supported syntax, see <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html">Search query reference for Resource Explorer</a> in the <i>Amazon Web Services Resource Explorer User Guide</i>.</p><important>  <p>This query string in the context of this operation supports only <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters">filter prefixes</a> with optional <a href="https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators">operators</a>. It doesn't support free-form text. For example, the string <code>region:us* service:ec2 -tag:stage=prod</code> includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters <code>us</code> and is <i>not</i> tagged with a key <code>Stage</code> that has the value <code>prod</code>.</p> </important><br>
    ///   - [`max_results(i32)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum 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 appropriate to the operation. If additional items exist beyond those included in the current response, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results.</p><note>  <p>An API operation can return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p> </note><br>
    ///   - [`view_arn(impl Into<String>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::view_arn) / [`set_view_arn(Option<String>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::set_view_arn):<br>required: **false**<br><p>Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the Amazon Web Services Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a 401 Unauthorized exception.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_resources::builders::ListResourcesFluentBuilder::set_next_token):<br>required: **false**<br><p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. The pagination tokens expire after 24 hours.</p><note>  <p>The <code>ListResources</code> operation does not generate a <code>NextToken</code> if you set <code>MaxResults</code> to 1000.</p> </note><br>
    /// - On success, responds with [`ListResourcesOutput`](crate::operation::list_resources::ListResourcesOutput) with field(s):
    ///   - [`resources(Option<Vec::<Resource>>)`](crate::operation::list_resources::ListResourcesOutput::resources): <p>The list of structures that describe the resources that match the query.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_resources::ListResourcesOutput::next_token): <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>. The pagination tokens expire after 24 hours.</p>
    ///   - [`view_arn(Option<String>)`](crate::operation::list_resources::ListResourcesOutput::view_arn): <p>The Amazon resource name (ARN) of the view that this operation used to perform the search.</p>
    /// - On failure, responds with [`SdkError<ListResourcesError>`](crate::operation::list_resources::ListResourcesError)
    pub fn list_resources(&self) -> crate::operation::list_resources::builders::ListResourcesFluentBuilder {
        crate::operation::list_resources::builders::ListResourcesFluentBuilder::new(self.handle.clone())
    }
}