aws-sdk-bedrockagentcore 1.16.0

AWS SDK for Amazon Bedrock AgentCore
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`RetrieveMemoryRecords`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`memory_id(impl Into<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::memory_id) / [`set_memory_id(Option<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::set_memory_id):<br>required: **true**<br><p>The identifier of the AgentCore Memory resource from which to retrieve memory records.</p><br>
    ///   - [`namespace(impl Into<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::set_namespace):<br>required: **true**<br><p>The namespace to filter memory records by. If specified, only memory records in this namespace are searched.</p><br>
    ///   - [`search_criteria(SearchCriteria)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::search_criteria) / [`set_search_criteria(Option<SearchCriteria>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::set_search_criteria):<br>required: **true**<br><p>The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call. Minimum value of 1, maximum value of 100. Default is 20.</p><br>
    /// - On success, responds with [`RetrieveMemoryRecordsOutput`](crate::operation::retrieve_memory_records::RetrieveMemoryRecordsOutput) with field(s):
    ///   - [`memory_record_summaries(Vec::<MemoryRecordSummary>)`](crate::operation::retrieve_memory_records::RetrieveMemoryRecordsOutput::memory_record_summaries): <p>The list of memory record summaries that match the search criteria, ordered by relevance.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::retrieve_memory_records::RetrieveMemoryRecordsOutput::next_token): <p>The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<RetrieveMemoryRecordsError>`](crate::operation::retrieve_memory_records::RetrieveMemoryRecordsError)
    pub fn retrieve_memory_records(&self) -> crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder {
        crate::operation::retrieve_memory_records::builders::RetrieveMemoryRecordsFluentBuilder::new(self.handle.clone())
    }
}