aws_sdk_bedrockagentruntime/client/

get_agent_memory.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetAgentMemory`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_next_token):<br>required: **false**<br><p>If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p><br>
    ///   - [`max_items(i32)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::max_items) / [`set_max_items(Option<i32>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_max_items):<br>required: **false**<br><p>The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p><br>
    ///   - [`agent_id(impl Into<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::agent_id) / [`set_agent_id(Option<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_agent_id):<br>required: **true**<br><p>The unique identifier of the agent to which the alias belongs.</p><br>
    ///   - [`agent_alias_id(impl Into<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::agent_alias_id) / [`set_agent_alias_id(Option<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_agent_alias_id):<br>required: **true**<br><p>The unique identifier of an alias of an agent.</p><br>
    ///   - [`memory_type(MemoryType)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::memory_type) / [`set_memory_type(Option<MemoryType>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_memory_type):<br>required: **true**<br><p>The type of memory.</p><br>
    ///   - [`memory_id(impl Into<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::memory_id) / [`set_memory_id(Option<String>)`](crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::set_memory_id):<br>required: **true**<br><p>The unique identifier of the memory.</p><br>
    /// - On success, responds with [`GetAgentMemoryOutput`](crate::operation::get_agent_memory::GetAgentMemoryOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::get_agent_memory::GetAgentMemoryOutput::next_token): <p>If the total number of results is greater than the maxItems value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
    ///   - [`memory_contents(Option<Vec::<Memory>>)`](crate::operation::get_agent_memory::GetAgentMemoryOutput::memory_contents): <p>Contains details of the sessions stored in the memory</p>
    /// - On failure, responds with [`SdkError<GetAgentMemoryError>`](crate::operation::get_agent_memory::GetAgentMemoryError)
    pub fn get_agent_memory(&self) -> crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder {
        crate::operation::get_agent_memory::builders::GetAgentMemoryFluentBuilder::new(self.handle.clone())
    }
}