Skip to main content

aws_sdk_agentregistry/client/
search_discoverable_registry_records.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`SearchDiscoverableRegistryRecords`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`search_query(impl Into<String>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::search_query) / [`set_search_query(Option<String>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::set_search_query):<br>required: **true**<br><p>The natural language query to search for matching registry records.</p><br>
7    ///   - [`registry_ids(impl Into<String>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::registry_ids) / [`set_registry_ids(Option<Vec::<String>>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::set_registry_ids):<br>required: **true**<br><p>The registry identifiers to search within. Currently, you must specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the registry ID.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return. Valid values are 1 through 20. The default value is 10.</p><br>
9    ///   - [`filters(Document)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::filters) / [`set_filters(Option<Document>)`](crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::set_filters):<br>required: **false**<br><p>An optional structured JSON metadata filter that narrows the search results. Supports the field-level operators <code>$eq</code>, <code>$ne</code>, and <code>$in</code>, and the logical operators <code>$and</code> and <code>$or</code> on filterable fields.</p><br>
10    /// - On success, responds with [`SearchDiscoverableRegistryRecordsOutput`](crate::operation::search_discoverable_registry_records::SearchDiscoverableRegistryRecordsOutput) with field(s):
11    ///   - [`registry_records(Vec::<RegistryRecordSummary>)`](crate::operation::search_discoverable_registry_records::SearchDiscoverableRegistryRecordsOutput::registry_records): <p>The registry records that match the search query, ordered by relevance.</p>
12    /// - On failure, responds with [`SdkError<SearchDiscoverableRegistryRecordsError>`](crate::operation::search_discoverable_registry_records::SearchDiscoverableRegistryRecordsError)
13    pub fn search_discoverable_registry_records(
14        &self,
15    ) -> crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder {
16        crate::operation::search_discoverable_registry_records::builders::SearchDiscoverableRegistryRecordsFluentBuilder::new(self.handle.clone())
17    }
18}