aws-sdk-bedrockagentcore 1.45.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 [`InvokeAgentRuntimeCommand`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`content_type(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::content_type) / [`set_content_type(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_content_type):<br>required: **false**<br><p>The MIME type of the input data in the request payload. This tells the agent runtime how to interpret the payload data. Common values include application/json for JSON data.</p><br>
    ///   - [`accept(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::accept) / [`set_accept(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_accept):<br>required: **false**<br><p>The desired MIME type for the response from the agent runtime command. This tells the agent runtime what format to use for the response data. Common values include application/json for JSON data.</p><br>
    ///   - [`runtime_session_id(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::runtime_session_id) / [`set_runtime_session_id(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_runtime_session_id):<br>required: **false**<br><p>The unique identifier of the runtime session in which to execute the command. This session ID is used to maintain state and context across multiple command invocations.</p><br>
    ///   - [`trace_id(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::trace_id) / [`set_trace_id(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_trace_id):<br>required: **false**<br><p>The trace identifier for request tracking.</p><br>
    ///   - [`trace_parent(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::trace_parent) / [`set_trace_parent(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_trace_parent):<br>required: **false**<br><p>The parent trace information for distributed tracing.</p><br>
    ///   - [`trace_state(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::trace_state) / [`set_trace_state(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_trace_state):<br>required: **false**<br><p>The trace state information for distributed tracing.</p><br>
    ///   - [`baggage(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::baggage) / [`set_baggage(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_baggage):<br>required: **false**<br><p>Additional context information for distributed tracing.</p><br>
    ///   - [`agent_runtime_arn(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::agent_runtime_arn) / [`set_agent_runtime_arn(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_agent_runtime_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the agent runtime on which to execute the command. This identifies the specific agent runtime environment where the command will run.</p><br>
    ///   - [`qualifier(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::qualifier) / [`set_qualifier(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_qualifier):<br>required: **false**<br><p>The qualifier to use for the agent runtime. This is an endpoint name that points to a specific version. If not specified, Amazon Bedrock AgentCore uses the default endpoint of the agent runtime.</p><br>
    ///   - [`account_id(impl Into<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_account_id):<br>required: **false**<br><p>The identifier of the Amazon Web Services account for the agent runtime resource. This parameter is required when you specify an agent ID instead of the full ARN for <code>agentRuntimeArn</code>.</p><br>
    ///   - [`body(InvokeAgentRuntimeCommandRequestBody)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::body) / [`set_body(Option<InvokeAgentRuntimeCommandRequestBody>)`](crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::set_body):<br>required: **true**<br><p>The request body containing the command to execute and optional configuration parameters such as timeout settings.</p><br>
    /// - On success, responds with [`InvokeAgentRuntimeCommandOutput`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput) with field(s):
    ///   - [`runtime_session_id(Option<String>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::runtime_session_id): <p>The unique identifier of the runtime session in which the command was executed.</p>
    ///   - [`trace_id(Option<String>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::trace_id): <p>The trace identifier for request tracking.</p>
    ///   - [`trace_parent(Option<String>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::trace_parent): <p>The parent trace information for distributed tracing.</p>
    ///   - [`trace_state(Option<String>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::trace_state): <p>The trace state information for distributed tracing.</p>
    ///   - [`baggage(Option<String>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::baggage): <p>Additional context information for distributed tracing.</p>
    ///   - [`content_type(String)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::content_type): <p>The MIME type of the response data. This indicates how to interpret the response data. Common values include application/json for JSON data.</p>
    ///   - [`status_code(Option<i32>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::status_code): <p>The HTTP status code of the response. A status code of 200 indicates a successful operation. Other status codes indicate various error conditions.</p>
    ///   - [`stream(EventReceiver<InvokeAgentRuntimeCommandStreamOutput, InvokeAgentRuntimeCommandStreamOutputError>)`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandOutput::stream): <p>The streaming output from the command execution. This stream contains events that provide real-time updates including standard output, standard error, and completion status.</p>
    /// - On failure, responds with [`SdkError<InvokeAgentRuntimeCommandError>`](crate::operation::invoke_agent_runtime_command::InvokeAgentRuntimeCommandError)
    pub fn invoke_agent_runtime_command(&self) -> crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder {
        crate::operation::invoke_agent_runtime_command::builders::InvokeAgentRuntimeCommandFluentBuilder::new(self.handle.clone())
    }
}