Struct Client

pub struct Client { /* private fields */ }

Client for Agents for Amazon Bedrock

Client for invoking operations on Agents for Amazon Bedrock. Each operation on Agents for Amazon Bedrock is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_bedrockagent::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_bedrockagent::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateAgentCollaborator operation has a Client::associate_agent_collaborator, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_agent_collaborator()
    .agent_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_agent_collaborator( &self, ) -> AssociateAgentCollaboratorFluentBuilder

Constructs a fluent builder for the AssociateAgentCollaborator operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The agent’s ID.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    An agent version.

    
    
  • agent_descriptor(AgentDescriptor) / set_agent_descriptor(Option<AgentDescriptor>):
    required: true
    

    The alias of the collaborator agent.

    
    
  • collaborator_name(impl Into<String>) / set_collaborator_name(Option<String>):
    required: true
    

    A name for the collaborator.

    
    
  • collaboration_instruction(impl Into<String>) / set_collaboration_instruction(Option<String>):
    required: true
    

    Instruction for the collaborator.

    
    
  • relay_conversation_history(RelayConversationHistory) / set_relay_conversation_history(Option<RelayConversationHistory>):
    required: false
    

    A relay conversation history for the collaborator.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A client token.

    
    
• On success, responds with AssociateAgentCollaboratorOutput with field(s):
  • agent_collaborator(Option<AgentCollaborator>):

    Details about the collaborator.

• On failure, responds with SdkError<AssociateAgentCollaboratorError>

impl Client

pub fn associate_agent_knowledge_base( &self, ) -> AssociateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the AssociateAgentKnowledgeBase operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent with which you want to associate the knowledge base.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent with which you want to associate the knowledge base.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to associate with the agent.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description of what the agent should use the knowledge base for.

    
    
  • knowledge_base_state(KnowledgeBaseState) / set_knowledge_base_state(Option<KnowledgeBaseState>):
    required: false
    

    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

    
    
• On success, responds with AssociateAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>):

    Contains details about the knowledge base that has been associated with the agent.

• On failure, responds with SdkError<AssociateAgentKnowledgeBaseError>

impl Client

pub fn create_agent(&self) -> CreateAgentFluentBuilder

Constructs a fluent builder for the CreateAgent operation.

• The fluent builder is configurable:
  • agent_name(impl Into<String>) / set_agent_name(Option<String>):
    required: true
    

    A name for the agent that you create.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • instruction(impl Into<String>) / set_instruction(Option<String>):
    required: false
    

    Instructions that tell the agent what it should do and how it should interact with users.

    
    
  • foundation_model(impl Into<String>) / set_foundation_model(Option<String>):
    required: false
    

    The identifier for the model that you want to be used for orchestration by the agent you create.

    The modelId to provide depends on the type of model or throughput that you use:

    • If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

    • If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

    • If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

    • If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

    • If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the agent.

    
    
  • orchestration_type(OrchestrationType) / set_orchestration_type(Option<OrchestrationType>):
    required: false
    

    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

    
    
  • custom_orchestration(CustomOrchestration) / set_custom_orchestration(Option<CustomOrchestration>):
    required: false
    

    Contains details of the custom orchestration configured for the agent.

    
    
  • idle_session_ttl_in_seconds(i32) / set_idle_session_ttl_in_seconds(Option<i32>):
    required: false
    

    The number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

    
    
  • agent_resource_role_arn(impl Into<String>) / set_agent_resource_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the agent.

    
    
  • prompt_override_configuration(PromptOverrideConfiguration) / set_prompt_override_configuration(Option<PromptOverrideConfiguration>):
    required: false
    

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

    
    
  • guardrail_configuration(GuardrailConfiguration) / set_guardrail_configuration(Option<GuardrailConfiguration>):
    required: false
    

    The unique Guardrail configuration assigned to the agent when it is created.

    
    
  • memory_configuration(MemoryConfiguration) / set_memory_configuration(Option<MemoryConfiguration>):
    required: false
    

    Contains the details of the memory configured for the agent.

    
    
  • agent_collaboration(AgentCollaboration) / set_agent_collaboration(Option<AgentCollaboration>):
    required: false
    

    The agent’s collaboration role.

    
    
• On success, responds with CreateAgentOutput with field(s):
  • agent(Option<Agent>):

    Contains details about the agent created.

• On failure, responds with SdkError<CreateAgentError>

impl Client

pub fn create_agent_action_group(&self) -> CreateAgentActionGroupFluentBuilder

Constructs a fluent builder for the CreateAgentActionGroup operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent for which to create the action group.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent for which to create the action group.

    
    
  • action_group_name(impl Into<String>) / set_action_group_name(Option<String>):
    required: true
    

    The name to give the action group.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the action group.

    
    
  • parent_action_group_signature(ActionGroupSignature) / set_parent_action_group_signature(Option<ActionGroupSignature>):
    required: false
    

    Specify a built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

    • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

    • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

    • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

      Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

      • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

      • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

      • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

    
    
  • parent_action_group_signature_params(impl Into<String>, impl Into<String>) / set_parent_action_group_signature_params(Option<HashMap::<String, String>>):
    required: false
    

    The configuration settings for a computer use action.

    Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

    
    
  • action_group_executor(ActionGroupExecutor) / set_action_group_executor(Option<ActionGroupExecutor>):
    required: false
    

    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

    
    
  • api_schema(ApiSchema) / set_api_schema(Option<ApiSchema>):
    required: false
    

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

    
    
  • action_group_state(ActionGroupState) / set_action_group_state(Option<ActionGroupState>):
    required: false
    

    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

    
    
  • function_schema(FunctionSchema) / set_function_schema(Option<FunctionSchema>):
    required: false
    

    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

    
    
• On success, responds with CreateAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>):

    Contains details about the action group that was created.

• On failure, responds with SdkError<CreateAgentActionGroupError>

impl Client

pub fn create_agent_alias(&self) -> CreateAgentAliasFluentBuilder

Constructs a fluent builder for the CreateAgentAlias operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • agent_alias_name(impl Into<String>) / set_agent_alias_name(Option<String>):
    required: true
    

    The name of the alias.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the alias of the agent.

    
    
  • routing_configuration(AgentAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>):
    required: false
    

    Contains details about the routing configuration of the alias.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the alias of the agent.

    
    
• On success, responds with CreateAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>):

    Contains details about the alias that was created.

• On failure, responds with SdkError<CreateAgentAliasError>

impl Client

pub fn create_data_source(&self) -> CreateDataSourceFluentBuilder

Constructs a fluent builder for the CreateDataSource operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to which to add the data source.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the data source.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the data source.

    
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: true
    

    The connection configuration for the data source.

    
    
  • data_deletion_policy(DataDeletionPolicy) / set_data_deletion_policy(Option<DataDeletionPolicy>):
    required: false
    

    The data deletion policy for the data source.

    You can set the data deletion policy to:

    • DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted, only the data. This flag is ignored if an Amazon Web Services account is deleted.

    • RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the vector store itself is not deleted if you delete a knowledge base or data source resource.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    

    Contains details about the server-side encryption for the data source.

    
    
  • vector_ingestion_configuration(VectorIngestionConfiguration) / set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>):
    required: false
    

    Contains details about how to ingest the documents in the data source.

    
    
• On success, responds with CreateDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    Contains details about the data source.

• On failure, responds with SdkError<CreateDataSourceError>

impl Client

pub fn create_flow(&self) -> CreateFlowFluentBuilder

Constructs a fluent builder for the CreateFlow operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the flow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the flow.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

    
    
  • definition(FlowDefinition) / set_definition(Option<FlowDefinition>):
    required: false
    

    A definition of the nodes and connections between nodes in the flow.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the flow. For more information, see Tagging resources in Amazon Bedrock.

    
    
• On success, responds with CreateFlowOutput with field(s):
  • name(String):

    The name of the flow.

  • description(Option<String>):

    The description of the flow.

  • execution_role_arn(String):

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.

  • id(String):

    The unique identifier of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • status(FlowStatus):

    The status of the flow. When you submit this request, the status will be NotPrepared. If creation fails, the status becomes Failed.

  • created_at(DateTime):

    The time at which the flow was created.

  • updated_at(DateTime):

    The time at which the flow was last updated.

  • version(String):

    The version of the flow. When you create a flow, the version created is the DRAFT version.

  • definition(Option<FlowDefinition>):

    A definition of the nodes and connections between nodes in the flow.

• On failure, responds with SdkError<CreateFlowError>

impl Client

pub fn create_flow_alias(&self) -> CreateFlowAliasFluentBuilder

Constructs a fluent builder for the CreateFlowAlias operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the alias.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the alias.

    
    
  • routing_configuration(FlowAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<FlowAliasRoutingConfigurationListItem>>):
    required: true
    

    Contains information about the version to which to map the alias.

    
    
  • concurrency_configuration(FlowAliasConcurrencyConfiguration) / set_concurrency_configuration(Option<FlowAliasConcurrencyConfiguration>):
    required: false
    

    The configuration that specifies how nodes in the flow are executed in parallel.

    
    
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow for which to create an alias.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the alias of the flow. For more information, see Tagging resources in Amazon Bedrock.

    
    
• On success, responds with CreateFlowAliasOutput with field(s):
  • name(String):

    The name of the alias.

  • description(Option<String>):

    The description of the alias.

  • routing_configuration(Vec::<FlowAliasRoutingConfigurationListItem>):

    Contains information about the version that the alias is mapped to.

  • concurrency_configuration(Option<FlowAliasConcurrencyConfiguration>):

    The configuration that specifies how nodes in the flow are executed in parallel.

  • flow_id(String):

    The unique identifier of the flow that the alias belongs to.

  • id(String):

    The unique identifier of the alias.

  • arn(String):

    The Amazon Resource Name (ARN) of the alias.

  • created_at(DateTime):

    The time at which the alias was created.

  • updated_at(DateTime):

    The time at which the alias of the flow was last updated.

• On failure, responds with SdkError<CreateFlowAliasError>

impl Client

pub fn create_flow_version(&self) -> CreateFlowVersionFluentBuilder

Constructs a fluent builder for the CreateFlowVersion operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow that you want to create a version of.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the version of the flow.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
• On success, responds with CreateFlowVersionOutput with field(s):
  • name(String):

    The name of the version.

  • description(Option<String>):

    The description of the version.

  • execution_role_arn(String):

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

  • customer_encryption_key_arn(Option<String>):

    The KMS key that the flow is encrypted with.

  • id(String):

    The unique identifier of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • status(FlowStatus):

    The status of the flow.

  • created_at(DateTime):

    The time at which the flow was created.

  • version(String):

    The version of the flow that was created. Versions are numbered incrementally, starting from 1.

  • definition(Option<FlowDefinition>):

    A definition of the nodes and connections in the flow.

• On failure, responds with SdkError<CreateFlowVersionError>

impl Client

pub fn create_knowledge_base(&self) -> CreateKnowledgeBaseFluentBuilder

Constructs a fluent builder for the CreateKnowledgeBase operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the knowledge base.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the knowledge base.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

    
    
  • knowledge_base_configuration(KnowledgeBaseConfiguration) / set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>):
    required: true
    

    Contains details about the embeddings model used for the knowledge base.

    
    
  • storage_configuration(StorageConfiguration) / set_storage_configuration(Option<StorageConfiguration>):
    required: false
    

    Contains details about the configuration of the vector database used for the knowledge base.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

    
    
• On success, responds with CreateKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>):

    Contains details about the knowledge base.

• On failure, responds with SdkError<CreateKnowledgeBaseError>

impl Client

pub fn create_prompt(&self) -> CreatePromptFluentBuilder

Constructs a fluent builder for the CreatePrompt operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the prompt.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the prompt.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

    
    
  • default_variant(impl Into<String>) / set_default_variant(Option<String>):
    required: false
    

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

    
    
  • variants(PromptVariant) / set_variants(Option<Vec::<PromptVariant>>):
    required: false
    

    A list of objects, each containing details about a variant of the prompt.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the prompt. For more information, see Tagging resources in Amazon Bedrock.

    
    
• On success, responds with CreatePromptOutput with field(s):
  • name(String):

    The name of the prompt.

  • description(Option<String>):

    The description of the prompt.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.

  • default_variant(Option<String>):

    The name of the default variant for your prompt.

  • variants(Option<Vec::<PromptVariant>>):

    A list of objects, each containing details about a variant of the prompt.

  • id(String):

    The unique identifier of the prompt.

  • arn(String):

    The Amazon Resource Name (ARN) of the prompt.

  • version(String):

    The version of the prompt. When you create a prompt, the version created is the DRAFT version.

  • created_at(DateTime):

    The time at which the prompt was created.

  • updated_at(DateTime):

    The time at which the prompt was last updated.

• On failure, responds with SdkError<CreatePromptError>

impl Client

pub fn create_prompt_version(&self) -> CreatePromptVersionFluentBuilder

Constructs a fluent builder for the CreatePromptVersion operation.

• The fluent builder is configurable:
  • prompt_identifier(impl Into<String>) / set_prompt_identifier(Option<String>):
    required: true
    

    The unique identifier of the prompt that you want to create a version of.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the version of the prompt.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Any tags that you want to attach to the version of the prompt. For more information, see Tagging resources in Amazon Bedrock.

    
    
• On success, responds with CreatePromptVersionOutput with field(s):
  • name(String):

    The name of the prompt.

  • description(Option<String>):

    A description for the version.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.

  • default_variant(Option<String>):

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

  • variants(Option<Vec::<PromptVariant>>):

    A list of objects, each containing details about a variant of the prompt.

  • id(String):

    The unique identifier of the prompt.

  • arn(String):

    The Amazon Resource Name (ARN) of the version of the prompt.

  • version(String):

    The version of the prompt that was created. Versions are numbered incrementally, starting from 1.

  • created_at(DateTime):

    The time at which the prompt was created.

  • updated_at(DateTime):

    The time at which the prompt was last updated.

• On failure, responds with SdkError<CreatePromptVersionError>

impl Client

pub fn delete_agent(&self) -> DeleteAgentFluentBuilder

Constructs a fluent builder for the DeleteAgent operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

    
    
• On success, responds with DeleteAgentOutput with field(s):
  • agent_id(String):

    The unique identifier of the agent that was deleted.

  • agent_status(AgentStatus):

    The status of the agent.

• On failure, responds with SdkError<DeleteAgentError>

impl Client

pub fn delete_agent_action_group(&self) -> DeleteAgentActionGroupFluentBuilder

Constructs a fluent builder for the DeleteAgentActionGroup operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent that the action group belongs to.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent that the action group belongs to.

    
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    

    The unique identifier of the action group to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

    
    
• On success, responds with DeleteAgentActionGroupOutput
• On failure, responds with SdkError<DeleteAgentActionGroupError>

impl Client

pub fn delete_agent_alias(&self) -> DeleteAgentAliasFluentBuilder

Constructs a fluent builder for the DeleteAgentAlias operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent that the alias belongs to.

    
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    

    The unique identifier of the alias to delete.

    
    
• On success, responds with DeleteAgentAliasOutput with field(s):
  • agent_id(String):

    The unique identifier of the agent that the alias belongs to.

  • agent_alias_id(String):

    The unique identifier of the alias that was deleted.

  • agent_alias_status(AgentAliasStatus):

    The status of the alias.

• On failure, responds with SdkError<DeleteAgentAliasError>

impl Client

pub fn delete_agent_version(&self) -> DeleteAgentVersionFluentBuilder

Constructs a fluent builder for the DeleteAgentVersion operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent that the version belongs to.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

    
    
• On success, responds with DeleteAgentVersionOutput with field(s):
  • agent_id(String):

    The unique identifier of the agent that the version belongs to.

  • agent_version(String):

    The version that was deleted.

  • agent_status(AgentStatus):

    The status of the agent version.

• On failure, responds with SdkError<DeleteAgentVersionError>

impl Client

pub fn delete_data_source(&self) -> DeleteDataSourceFluentBuilder

Constructs a fluent builder for the DeleteDataSource operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base from which to delete the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source to delete.

    
    
• On success, responds with DeleteDataSourceOutput with field(s):
  • knowledge_base_id(String):

    The unique identifier of the knowledge base to which the data source that was deleted belonged.

  • data_source_id(String):

    The unique identifier of the data source that was deleted.

  • status(DataSourceStatus):

    The status of the data source.

• On failure, responds with SdkError<DeleteDataSourceError>

impl Client

pub fn delete_flow(&self) -> DeleteFlowFluentBuilder

Constructs a fluent builder for the DeleteFlow operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

    
    
• On success, responds with DeleteFlowOutput with field(s):
  • id(String):

    The unique identifier of the flow.

• On failure, responds with SdkError<DeleteFlowError>

impl Client

pub fn delete_flow_alias(&self) -> DeleteFlowAliasFluentBuilder

Constructs a fluent builder for the DeleteFlowAlias operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow that the alias belongs to.

    
    
  • alias_identifier(impl Into<String>) / set_alias_identifier(Option<String>):
    required: true
    

    The unique identifier of the alias to be deleted.

    
    
• On success, responds with DeleteFlowAliasOutput with field(s):
  • flow_id(String):

    The unique identifier of the flow that the alias belongs to.

  • id(String):

    The unique identifier of the flow.

• On failure, responds with SdkError<DeleteFlowAliasError>

impl Client

pub fn delete_flow_version(&self) -> DeleteFlowVersionFluentBuilder

Constructs a fluent builder for the DeleteFlowVersion operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow whose version that you want to delete

    
    
  • flow_version(impl Into<String>) / set_flow_version(Option<String>):
    required: true
    

    The version of the flow that you want to delete.

    
    
  • skip_resource_in_use_check(bool) / set_skip_resource_in_use_check(Option<bool>):
    required: false
    

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

    
    
• On success, responds with DeleteFlowVersionOutput with field(s):
  • id(String):

    The unique identifier of the flow.

  • version(String):

    The version of the flow being deleted.

• On failure, responds with SdkError<DeleteFlowVersionError>

impl Client

pub fn delete_knowledge_base(&self) -> DeleteKnowledgeBaseFluentBuilder

Constructs a fluent builder for the DeleteKnowledgeBase operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to delete.

    
    
• On success, responds with DeleteKnowledgeBaseOutput with field(s):
  • knowledge_base_id(String):

    The unique identifier of the knowledge base that was deleted.

  • status(KnowledgeBaseStatus):

    The status of the knowledge base and whether it has been successfully deleted.

• On failure, responds with SdkError<DeleteKnowledgeBaseError>

impl Client

pub fn delete_knowledge_base_documents( &self, ) -> DeleteKnowledgeBaseDocumentsFluentBuilder

Constructs a fluent builder for the DeleteKnowledgeBaseDocuments operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base that is connected to the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source that contains the documents.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • document_identifiers(DocumentIdentifier) / set_document_identifiers(Option<Vec::<DocumentIdentifier>>):
    required: true
    

    A list of objects, each of which contains information to identify a document to delete.

    
    
• On success, responds with DeleteKnowledgeBaseDocumentsOutput with field(s):
  • document_details(Option<Vec::<KnowledgeBaseDocumentDetail>>):

    A list of objects, each of which contains information about the documents that were deleted.

• On failure, responds with SdkError<DeleteKnowledgeBaseDocumentsError>

impl Client

pub fn delete_prompt(&self) -> DeletePromptFluentBuilder

Constructs a fluent builder for the DeletePrompt operation.

• The fluent builder is configurable:
  • prompt_identifier(impl Into<String>) / set_prompt_identifier(Option<String>):
    required: true
    

    The unique identifier of the prompt.

    
    
  • prompt_version(impl Into<String>) / set_prompt_version(Option<String>):
    required: false
    

    The version of the prompt to delete. To delete the prompt, omit this field.

    
    
• On success, responds with DeletePromptOutput with field(s):
  • id(String):

    The unique identifier of the prompt that was deleted.

  • version(Option<String>):

    The version of the prompt that was deleted.

• On failure, responds with SdkError<DeletePromptError>

impl Client

pub fn disassociate_agent_collaborator( &self, ) -> DisassociateAgentCollaboratorFluentBuilder

Constructs a fluent builder for the DisassociateAgentCollaborator operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    An agent ID.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The agent’s version.

    
    
  • collaborator_id(impl Into<String>) / set_collaborator_id(Option<String>):
    required: true
    

    The collaborator’s ID.

    
    
• On success, responds with DisassociateAgentCollaboratorOutput
• On failure, responds with SdkError<DisassociateAgentCollaboratorError>

impl Client

pub fn disassociate_agent_knowledge_base( &self, ) -> DisassociateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the DisassociateAgentKnowledgeBase operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent from which to disassociate the knowledge base.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent from which to disassociate the knowledge base.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to disassociate.

    
    
• On success, responds with DisassociateAgentKnowledgeBaseOutput
• On failure, responds with SdkError<DisassociateAgentKnowledgeBaseError>

impl Client

pub fn get_agent(&self) -> GetAgentFluentBuilder

Constructs a fluent builder for the GetAgent operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
• On success, responds with GetAgentOutput with field(s):
  • agent(Option<Agent>):

    Contains details about the agent.

• On failure, responds with SdkError<GetAgentError>

impl Client

pub fn get_agent_action_group(&self) -> GetAgentActionGroupFluentBuilder

Constructs a fluent builder for the GetAgentActionGroup operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent that the action group belongs to.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent that the action group belongs to.

    
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    

    The unique identifier of the action group for which to get information.

    
    
• On success, responds with GetAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>):

    Contains details about the action group.

• On failure, responds with SdkError<GetAgentActionGroupError>

impl Client

pub fn get_agent_alias(&self) -> GetAgentAliasFluentBuilder

Constructs a fluent builder for the GetAgentAlias operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent to which the alias to get information belongs.

    
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    

    The unique identifier of the alias for which to get information.

    
    
• On success, responds with GetAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>):

    Contains information about the alias.

• On failure, responds with SdkError<GetAgentAliasError>

impl Client

pub fn get_agent_collaborator(&self) -> GetAgentCollaboratorFluentBuilder

Constructs a fluent builder for the GetAgentCollaborator operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The agent’s ID.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The agent’s version.

    
    
  • collaborator_id(impl Into<String>) / set_collaborator_id(Option<String>):
    required: true
    

    The collaborator’s ID.

    
    
• On success, responds with GetAgentCollaboratorOutput with field(s):
  • agent_collaborator(Option<AgentCollaborator>):

    Details about the collaborator.

• On failure, responds with SdkError<GetAgentCollaboratorError>

impl Client

pub fn get_agent_knowledge_base(&self) -> GetAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the GetAgentKnowledgeBase operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent with which the knowledge base is associated.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent with which the knowledge base is associated.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base associated with the agent.

    
    
• On success, responds with GetAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>):

    Contains details about a knowledge base attached to an agent.

• On failure, responds with SdkError<GetAgentKnowledgeBaseError>

impl Client

pub fn get_agent_version(&self) -> GetAgentVersionFluentBuilder

Constructs a fluent builder for the GetAgentVersion operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent.

    
    
• On success, responds with GetAgentVersionOutput with field(s):
  • agent_version(Option<AgentVersion>):

    Contains details about the version of the agent.

• On failure, responds with SdkError<GetAgentVersionError>

impl Client

pub fn get_data_source(&self) -> GetDataSourceFluentBuilder

Constructs a fluent builder for the GetDataSource operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source.

    
    
• On success, responds with GetDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    Contains details about the data source.

• On failure, responds with SdkError<GetDataSourceError>

impl Client

pub fn get_flow(&self) -> GetFlowFluentBuilder

Constructs a fluent builder for the GetFlow operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
• On success, responds with GetFlowOutput with field(s):
  • name(String):

    The name of the flow.

  • description(Option<String>):

    The description of the flow.

  • execution_role_arn(String):

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

  • id(String):

    The unique identifier of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • status(FlowStatus):

    The status of the flow. The following statuses are possible:

    • NotPrepared – The flow has been created or updated, but hasn’t been prepared. If you just created the flow, you can’t test it. If you updated the flow, the DRAFT version won’t contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

    • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

    • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

    • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

  • created_at(DateTime):

    The time at which the flow was created.

  • updated_at(DateTime):

    The time at which the flow was last updated.

  • version(String):

    The version of the flow for which information was retrieved.

  • definition(Option<FlowDefinition>):

    The definition of the nodes and connections between the nodes in the flow.

  • validations(Option<Vec::<FlowValidation>>):

    A list of validation error messages related to the last failed operation on the flow.

• On failure, responds with SdkError<GetFlowError>

impl Client

pub fn get_flow_alias(&self) -> GetFlowAliasFluentBuilder

Constructs a fluent builder for the GetFlowAlias operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow that the alias belongs to.

    
    
  • alias_identifier(impl Into<String>) / set_alias_identifier(Option<String>):
    required: true
    

    The unique identifier of the alias for which to retrieve information.

    
    
• On success, responds with GetFlowAliasOutput with field(s):
  • name(String):

    The name of the alias.

  • description(Option<String>):

    The description of the flow.

  • routing_configuration(Vec::<FlowAliasRoutingConfigurationListItem>):

    Contains information about the version that the alias is mapped to.

  • concurrency_configuration(Option<FlowAliasConcurrencyConfiguration>):

    The configuration that specifies how nodes in the flow are executed in parallel.

  • flow_id(String):

    The unique identifier of the flow that the alias belongs to.

  • id(String):

    The unique identifier of the alias of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • created_at(DateTime):

    The time at which the flow was created.

  • updated_at(DateTime):

    The time at which the alias was last updated.

• On failure, responds with SdkError<GetFlowAliasError>

impl Client

pub fn get_flow_version(&self) -> GetFlowVersionFluentBuilder

Constructs a fluent builder for the GetFlowVersion operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow for which to get information.

    
    
  • flow_version(impl Into<String>) / set_flow_version(Option<String>):
    required: true
    

    The version of the flow for which to get information.

    
    
• On success, responds with GetFlowVersionOutput with field(s):
  • name(String):

    The name of the version.

  • description(Option<String>):

    The description of the flow.

  • execution_role_arn(String):

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.

  • id(String):

    The unique identifier of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • status(FlowStatus):

    The status of the flow.

  • created_at(DateTime):

    The time at which the flow was created.

  • version(String):

    The version of the flow for which information was retrieved.

  • definition(Option<FlowDefinition>):

    The definition of the nodes and connections between nodes in the flow.

• On failure, responds with SdkError<GetFlowVersionError>

impl Client

pub fn get_ingestion_job(&self) -> GetIngestionJobFluentBuilder

Constructs a fluent builder for the GetIngestionJob operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the data ingestion job you want to get information on.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source for the data ingestion job you want to get information on.

    
    
  • ingestion_job_id(impl Into<String>) / set_ingestion_job_id(Option<String>):
    required: true
    

    The unique identifier of the data ingestion job you want to get information on.

    
    
• On success, responds with GetIngestionJobOutput with field(s):
  • ingestion_job(Option<IngestionJob>):

    Contains details about the data ingestion job.

• On failure, responds with SdkError<GetIngestionJobError>

impl Client

pub fn get_knowledge_base(&self) -> GetKnowledgeBaseFluentBuilder

Constructs a fluent builder for the GetKnowledgeBase operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base you want to get information on.

    
    
• On success, responds with GetKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>):

    Contains details about the knowledge base.

• On failure, responds with SdkError<GetKnowledgeBaseError>

impl Client

pub fn get_knowledge_base_documents( &self, ) -> GetKnowledgeBaseDocumentsFluentBuilder

Constructs a fluent builder for the GetKnowledgeBaseDocuments operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base that is connected to the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source that contains the documents.

    
    
  • document_identifiers(DocumentIdentifier) / set_document_identifiers(Option<Vec::<DocumentIdentifier>>):
    required: true
    

    A list of objects, each of which contains information to identify a document for which to retrieve information.

    
    
• On success, responds with GetKnowledgeBaseDocumentsOutput with field(s):
  • document_details(Option<Vec::<KnowledgeBaseDocumentDetail>>):

    A list of objects, each of which contains information about the documents that were retrieved.

• On failure, responds with SdkError<GetKnowledgeBaseDocumentsError>

impl Client

pub fn get_prompt(&self) -> GetPromptFluentBuilder

Constructs a fluent builder for the GetPrompt operation.

• The fluent builder is configurable:
  • prompt_identifier(impl Into<String>) / set_prompt_identifier(Option<String>):
    required: true
    

    The unique identifier of the prompt.

    
    
  • prompt_version(impl Into<String>) / set_prompt_version(Option<String>):
    required: false
    

    The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.

    
    
• On success, responds with GetPromptOutput with field(s):
  • name(String):

    The name of the prompt.

  • description(Option<String>):

    The descriptino of the prompt.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.

  • default_variant(Option<String>):

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

  • variants(Option<Vec::<PromptVariant>>):

    A list of objects, each containing details about a variant of the prompt.

  • id(String):

    The unique identifier of the prompt.

  • arn(String):

    The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

  • version(String):

    The version of the prompt.

  • created_at(DateTime):

    The time at which the prompt was created.

  • updated_at(DateTime):

    The time at which the prompt was last updated.

• On failure, responds with SdkError<GetPromptError>

impl Client

pub fn ingest_knowledge_base_documents( &self, ) -> IngestKnowledgeBaseDocumentsFluentBuilder

Constructs a fluent builder for the IngestKnowledgeBaseDocuments operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to ingest the documents into.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source connected to the knowledge base that you’re adding documents to.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • documents(KnowledgeBaseDocument) / set_documents(Option<Vec::<KnowledgeBaseDocument>>):
    required: true
    

    A list of objects, each of which contains information about the documents to add.

    
    
• On success, responds with IngestKnowledgeBaseDocumentsOutput with field(s):
  • document_details(Option<Vec::<KnowledgeBaseDocumentDetail>>):

    A list of objects, each of which contains information about the documents that were ingested.

• On failure, responds with SdkError<IngestKnowledgeBaseDocumentsError>

impl Client

pub fn list_agent_action_groups(&self) -> ListAgentActionGroupsFluentBuilder

Constructs a fluent builder for the ListAgentActionGroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListAgentActionGroupsOutput with field(s):
  • action_group_summaries(Vec::<ActionGroupSummary>):

    A list of objects, each of which contains information about an action group.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListAgentActionGroupsError>

impl Client

pub fn list_agent_aliases(&self) -> ListAgentAliasesFluentBuilder

Constructs a fluent builder for the ListAgentAliases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListAgentAliasesOutput with field(s):
  • agent_alias_summaries(Vec::<AgentAliasSummary>):

    A list of objects, each of which contains information about an alias of the agent.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListAgentAliasesError>

impl Client

pub fn list_agent_collaborators(&self) -> ListAgentCollaboratorsFluentBuilder

Constructs a fluent builder for the ListAgentCollaborators operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The agent’s ID.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The agent’s version.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of agent collaborators to return in one page of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Specify the pagination token from a previous request to retrieve the next page of results.

    
    
• On success, responds with ListAgentCollaboratorsOutput with field(s):
  • agent_collaborator_summaries(Vec::<AgentCollaboratorSummary>):

    A list of collaborator summaries.

  • next_token(Option<String>):

    Specify the pagination token from a previous request to retrieve the next page of results.

• On failure, responds with SdkError<ListAgentCollaboratorsError>

impl Client

pub fn list_agent_knowledge_bases(&self) -> ListAgentKnowledgeBasesFluentBuilder

Constructs a fluent builder for the ListAgentKnowledgeBases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent for which to return information about knowledge bases associated with it.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent for which to return information about knowledge bases associated with it.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListAgentKnowledgeBasesOutput with field(s):
  • agent_knowledge_base_summaries(Vec::<AgentKnowledgeBaseSummary>):

    A list of objects, each of which contains information about a knowledge base associated with the agent.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListAgentKnowledgeBasesError>

impl Client

pub fn list_agent_versions(&self) -> ListAgentVersionsFluentBuilder

Constructs a fluent builder for the ListAgentVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListAgentVersionsOutput with field(s):
  • agent_version_summaries(Vec::<AgentVersionSummary>):

    A list of objects, each of which contains information about a version of the agent.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListAgentVersionsError>

impl Client

pub fn list_agents(&self) -> ListAgentsFluentBuilder

Constructs a fluent builder for the ListAgents operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListAgentsOutput with field(s):
  • agent_summaries(Vec::<AgentSummary>):

    A list of objects, each of which contains information about an agent.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListAgentsError>

impl Client

pub fn list_data_sources(&self) -> ListDataSourcesFluentBuilder

Constructs a fluent builder for the ListDataSources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for which to return a list of information.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListDataSourcesOutput with field(s):
  • data_source_summaries(Vec::<DataSourceSummary>):

    A list of objects, each of which contains information about a data source.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListDataSourcesError>

impl Client

pub fn list_flow_aliases(&self) -> ListFlowAliasesFluentBuilder

Constructs a fluent builder for the ListFlowAliases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow for which aliases are being returned.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListFlowAliasesOutput with field(s):
  • flow_alias_summaries(Vec::<FlowAliasSummary>):

    A list, each member of which contains information about an alias.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListFlowAliasesError>

impl Client

pub fn list_flow_versions(&self) -> ListFlowVersionsFluentBuilder

Constructs a fluent builder for the ListFlowVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListFlowVersionsOutput with field(s):
  • flow_version_summaries(Vec::<FlowVersionSummary>):

    A list, each member of which contains information about a flow.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListFlowVersionsError>

impl Client

pub fn list_flows(&self) -> ListFlowsFluentBuilder

Constructs a fluent builder for the ListFlows operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListFlowsOutput with field(s):
  • flow_summaries(Vec::<FlowSummary>):

    A list, each member of which contains information about a flow.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListFlowsError>

impl Client

pub fn list_ingestion_jobs(&self) -> ListIngestionJobsFluentBuilder

Constructs a fluent builder for the ListIngestionJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the list of data ingestion jobs.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source for the list of data ingestion jobs.

    
    
  • filters(IngestionJobFilter) / set_filters(Option<Vec::<IngestionJobFilter>>):
    required: false
    

    Contains information about the filters for filtering the data.

    
    
  • sort_by(IngestionJobSortBy) / set_sort_by(Option<IngestionJobSortBy>):
    required: false
    

    Contains details about how to sort the data.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListIngestionJobsOutput with field(s):
  • ingestion_job_summaries(Vec::<IngestionJobSummary>):

    A list of data ingestion jobs with information about each job.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListIngestionJobsError>

impl Client

pub fn list_knowledge_base_documents( &self, ) -> ListKnowledgeBaseDocumentsFluentBuilder

Constructs a fluent builder for the ListKnowledgeBaseDocuments operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base that is connected to the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source that contains the documents.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListKnowledgeBaseDocumentsOutput with field(s):
  • document_details(Vec::<KnowledgeBaseDocumentDetail>):

    A list of objects, each of which contains information about the documents that were retrieved.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListKnowledgeBaseDocumentsError>

impl Client

pub fn list_knowledge_bases(&self) -> ListKnowledgeBasesFluentBuilder

Constructs a fluent builder for the ListKnowledgeBases operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListKnowledgeBasesOutput with field(s):
  • knowledge_base_summaries(Vec::<KnowledgeBaseSummary>):

    A list of knowledge bases with information about each knowledge base.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListKnowledgeBasesError>

impl Client

pub fn list_prompts(&self) -> ListPromptsFluentBuilder

Constructs a fluent builder for the ListPrompts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • prompt_identifier(impl Into<String>) / set_prompt_identifier(Option<String>):
    required: false
    

    The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results 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 nextToken field when making another request to return the next batch of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

    
    
• On success, responds with ListPromptsOutput with field(s):
  • prompt_summaries(Vec::<PromptSummary>):

    A list, each member of which contains information about a prompt using Prompt management.

  • next_token(Option<String>):

    If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

• On failure, responds with SdkError<ListPromptsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource for which to list tags.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The key-value pairs for the tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn prepare_agent(&self) -> PrepareAgentFluentBuilder

Constructs a fluent builder for the PrepareAgent operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent for which to create a DRAFT version.

    
    
• On success, responds with PrepareAgentOutput with field(s):
  • agent_id(String):

    The unique identifier of the agent for which the DRAFT version was created.

  • agent_status(AgentStatus):

    The status of the DRAFT version and whether it is ready for use.

  • agent_version(String):

    The version of the agent.

  • prepared_at(DateTime):

    The time at which the DRAFT version of the agent was last prepared.

• On failure, responds with SdkError<PrepareAgentError>

impl Client

pub fn prepare_flow(&self) -> PrepareFlowFluentBuilder

Constructs a fluent builder for the PrepareFlow operation.

• The fluent builder is configurable:
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
• On success, responds with PrepareFlowOutput with field(s):
  • id(String):

    The unique identifier of the flow.

  • status(FlowStatus):

    The status of the flow. When you submit this request, the status will be NotPrepared. If preparation succeeds, the status becomes Prepared. If it fails, the status becomes FAILED.

• On failure, responds with SdkError<PrepareFlowError>

impl Client

pub fn start_ingestion_job(&self) -> StartIngestionJobFluentBuilder

Constructs a fluent builder for the StartIngestionJob operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the data ingestion job.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source you want to ingest into your knowledge base.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the data ingestion job.

    
    
• On success, responds with StartIngestionJobOutput with field(s):
  • ingestion_job(Option<IngestionJob>):

    Contains information about the data ingestion job.

• On failure, responds with SdkError<StartIngestionJobError>

impl Client

pub fn stop_ingestion_job(&self) -> StopIngestionJobFluentBuilder

Constructs a fluent builder for the StopIngestionJob operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the data ingestion job you want to stop.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source for the data ingestion job you want to stop.

    
    
  • ingestion_job_id(impl Into<String>) / set_ingestion_job_id(Option<String>):
    required: true
    

    The unique identifier of the data ingestion job you want to stop.

    
    
• On success, responds with StopIngestionJobOutput with field(s):
  • ingestion_job(Option<IngestionJob>):

    Contains information about the stopped data ingestion job.

• On failure, responds with SdkError<StopIngestionJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to tag.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    An object containing key-value pairs that define the tags to attach to the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    A list of keys of the tags to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_agent(&self) -> UpdateAgentFluentBuilder

Constructs a fluent builder for the UpdateAgent operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • agent_name(impl Into<String>) / set_agent_name(Option<String>):
    required: true
    

    Specifies a new name for the agent.

    
    
  • instruction(impl Into<String>) / set_instruction(Option<String>):
    required: false
    

    Specifies new instructions that tell the agent what it should do and how it should interact with users.

    
    
  • foundation_model(impl Into<String>) / set_foundation_model(Option<String>):
    required: true
    

    The identifier for the model that you want to be used for orchestration by the agent you create.

    The modelId to provide depends on the type of model or throughput that you use:

    • If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.

    • If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.

    • If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.

    • If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.

    • If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new description of the agent.

    
    
  • orchestration_type(OrchestrationType) / set_orchestration_type(Option<OrchestrationType>):
    required: false
    

    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.

    
    
  • custom_orchestration(CustomOrchestration) / set_custom_orchestration(Option<CustomOrchestration>):
    required: false
    

    Contains details of the custom orchestration configured for the agent.

    
    
  • idle_session_ttl_in_seconds(i32) / set_idle_session_ttl_in_seconds(Option<i32>):
    required: false
    

    The number of seconds for which Amazon Bedrock keeps information about a user’s conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

    
    
  • agent_resource_role_arn(impl Into<String>) / set_agent_resource_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

    
    
  • prompt_override_configuration(PromptOverrideConfiguration) / set_prompt_override_configuration(Option<PromptOverrideConfiguration>):
    required: false
    

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

    
    
  • guardrail_configuration(GuardrailConfiguration) / set_guardrail_configuration(Option<GuardrailConfiguration>):
    required: false
    

    The unique Guardrail configuration assigned to the agent when it is updated.

    
    
  • memory_configuration(MemoryConfiguration) / set_memory_configuration(Option<MemoryConfiguration>):
    required: false
    

    Specifies the new memory configuration for the agent.

    
    
  • agent_collaboration(AgentCollaboration) / set_agent_collaboration(Option<AgentCollaboration>):
    required: false
    

    The agent’s collaboration role.

    
    
• On success, responds with UpdateAgentOutput with field(s):
  • agent(Option<Agent>):

    Contains details about the agent that was updated.

• On failure, responds with SdkError<UpdateAgentError>

impl Client

pub fn update_agent_action_group(&self) -> UpdateAgentActionGroupFluentBuilder

Constructs a fluent builder for the UpdateAgentActionGroup operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent for which to update the action group.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The unique identifier of the agent version for which to update the action group.

    
    
  • action_group_id(impl Into<String>) / set_action_group_id(Option<String>):
    required: true
    

    The unique identifier of the action group.

    
    
  • action_group_name(impl Into<String>) / set_action_group_name(Option<String>):
    required: true
    

    Specifies a new name for the action group.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new name for the action group.

    
    
  • parent_action_group_signature(ActionGroupSignature) / set_parent_action_group_signature(Option<ActionGroupSignature>):
    required: false
    

    Update the built-in or computer use action for this action group. If you specify a value, you must leave the description, apiSchema, and actionGroupExecutor fields empty for this action group.

    • To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput.

    • To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to AMAZON.CodeInterpreter.

    • To allow your agent to use an Anthropic computer use tool, specify one of the following values.

      Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

      • ANTHROPIC.Computer - Gives the agent permission to use the mouse and keyboard and take screenshots.

      • ANTHROPIC.TextEditor - Gives the agent permission to view, create and edit files.

      • ANTHROPIC.Bash - Gives the agent permission to run commands in a bash shell.

    During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn’t have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

    
    
  • parent_action_group_signature_params(impl Into<String>, impl Into<String>) / set_parent_action_group_signature_params(Option<HashMap::<String, String>>):
    required: false
    

    The configuration settings for a computer use action.

    Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see Configure an Amazon Bedrock Agent to complete tasks with computer use tools.

    
    
  • action_group_executor(ActionGroupExecutor) / set_action_group_executor(Option<ActionGroupExecutor>):
    required: false
    

    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

    
    
  • action_group_state(ActionGroupState) / set_action_group_state(Option<ActionGroupState>):
    required: false
    

    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

    
    
  • api_schema(ApiSchema) / set_api_schema(Option<ApiSchema>):
    required: false
    

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

    
    
  • function_schema(FunctionSchema) / set_function_schema(Option<FunctionSchema>):
    required: false
    

    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

    
    
• On success, responds with UpdateAgentActionGroupOutput with field(s):
  • agent_action_group(Option<AgentActionGroup>):

    Contains details about the action group that was updated.

• On failure, responds with SdkError<UpdateAgentActionGroupError>

impl Client

pub fn update_agent_alias(&self) -> UpdateAgentAliasFluentBuilder

Constructs a fluent builder for the UpdateAgentAlias operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent.

    
    
  • agent_alias_id(impl Into<String>) / set_agent_alias_id(Option<String>):
    required: true
    

    The unique identifier of the alias.

    
    
  • agent_alias_name(impl Into<String>) / set_agent_alias_name(Option<String>):
    required: true
    

    Specifies a new name for the alias.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new description for the alias.

    
    
  • routing_configuration(AgentAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<AgentAliasRoutingConfigurationListItem>>):
    required: false
    

    Contains details about the routing configuration of the alias.

    
    
• On success, responds with UpdateAgentAliasOutput with field(s):
  • agent_alias(Option<AgentAlias>):

    Contains details about the alias that was updated.

• On failure, responds with SdkError<UpdateAgentAliasError>

impl Client

pub fn update_agent_collaborator(&self) -> UpdateAgentCollaboratorFluentBuilder

Constructs a fluent builder for the UpdateAgentCollaborator operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The agent’s ID.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The agent’s version.

    
    
  • collaborator_id(impl Into<String>) / set_collaborator_id(Option<String>):
    required: true
    

    The collaborator’s ID.

    
    
  • agent_descriptor(AgentDescriptor) / set_agent_descriptor(Option<AgentDescriptor>):
    required: true
    

    An agent descriptor for the agent collaborator.

    
    
  • collaborator_name(impl Into<String>) / set_collaborator_name(Option<String>):
    required: true
    

    The collaborator’s name.

    
    
  • collaboration_instruction(impl Into<String>) / set_collaboration_instruction(Option<String>):
    required: true
    

    Instruction for the collaborator.

    
    
  • relay_conversation_history(RelayConversationHistory) / set_relay_conversation_history(Option<RelayConversationHistory>):
    required: false
    

    A relay conversation history for the collaborator.

    
    
• On success, responds with UpdateAgentCollaboratorOutput with field(s):
  • agent_collaborator(Option<AgentCollaborator>):

    Details about the collaborator.

• On failure, responds with SdkError<UpdateAgentCollaboratorError>

impl Client

pub fn update_agent_knowledge_base( &self, ) -> UpdateAgentKnowledgeBaseFluentBuilder

Constructs a fluent builder for the UpdateAgentKnowledgeBase operation.

• The fluent builder is configurable:
  • agent_id(impl Into<String>) / set_agent_id(Option<String>):
    required: true
    

    The unique identifier of the agent associated with the knowledge base that you want to update.

    
    
  • agent_version(impl Into<String>) / set_agent_version(Option<String>):
    required: true
    

    The version of the agent associated with the knowledge base that you want to update.

    
    
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base that has been associated with an agent.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new description for the knowledge base associated with an agent.

    
    
  • knowledge_base_state(KnowledgeBaseState) / set_knowledge_base_state(Option<KnowledgeBaseState>):
    required: false
    

    Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

    
    
• On success, responds with UpdateAgentKnowledgeBaseOutput with field(s):
  • agent_knowledge_base(Option<AgentKnowledgeBase>):

    Contains details about the knowledge base that has been associated with an agent.

• On failure, responds with SdkError<UpdateAgentKnowledgeBaseError>

impl Client

pub fn update_data_source(&self) -> UpdateDataSourceFluentBuilder

Constructs a fluent builder for the UpdateDataSource operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base for the data source.

    
    
  • data_source_id(impl Into<String>) / set_data_source_id(Option<String>):
    required: true
    

    The unique identifier of the data source.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies a new name for the data source.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new description for the data source.

    
    
  • data_source_configuration(DataSourceConfiguration) / set_data_source_configuration(Option<DataSourceConfiguration>):
    required: true
    

    The connection configuration for the data source that you want to update.

    
    
  • data_deletion_policy(DataDeletionPolicy) / set_data_deletion_policy(Option<DataDeletionPolicy>):
    required: false
    

    The data deletion policy for the data source that you want to update.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: false
    

    Contains details about server-side encryption of the data source.

    
    
  • vector_ingestion_configuration(VectorIngestionConfiguration) / set_vector_ingestion_configuration(Option<VectorIngestionConfiguration>):
    required: false
    

    Contains details about how to ingest the documents in the data source.

    
    
• On success, responds with UpdateDataSourceOutput with field(s):
  • data_source(Option<DataSource>):

    Contains details about the data source.

• On failure, responds with SdkError<UpdateDataSourceError>

impl Client

pub fn update_flow(&self) -> UpdateFlowFluentBuilder

Constructs a fluent builder for the UpdateFlow operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the flow.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the flow.

    
    
  • execution_role_arn(impl Into<String>) / set_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.

    
    
  • definition(FlowDefinition) / set_definition(Option<FlowDefinition>):
    required: false
    

    A definition of the nodes and the connections between the nodes in the flow.

    
    
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
• On success, responds with UpdateFlowOutput with field(s):
  • name(String):

    The name of the flow.

  • description(Option<String>):

    The description of the flow.

  • execution_role_arn(String):

    The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service role for flows in Amazon Bedrock in the Amazon Bedrock User Guide.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.

  • id(String):

    The unique identifier of the flow.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • status(FlowStatus):

    The status of the flow. When you submit this request, the status will be NotPrepared. If updating fails, the status becomes Failed.

  • created_at(DateTime):

    The time at which the flow was created.

  • updated_at(DateTime):

    The time at which the flow was last updated.

  • version(String):

    The version of the flow. When you update a flow, the version updated is the DRAFT version.

  • definition(Option<FlowDefinition>):

    A definition of the nodes and the connections between nodes in the flow.

• On failure, responds with SdkError<UpdateFlowError>

impl Client

pub fn update_flow_alias(&self) -> UpdateFlowAliasFluentBuilder

Constructs a fluent builder for the UpdateFlowAlias operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the alias.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the alias.

    
    
  • routing_configuration(FlowAliasRoutingConfigurationListItem) / set_routing_configuration(Option<Vec::<FlowAliasRoutingConfigurationListItem>>):
    required: true
    

    Contains information about the version to which to map the alias.

    
    
  • concurrency_configuration(FlowAliasConcurrencyConfiguration) / set_concurrency_configuration(Option<FlowAliasConcurrencyConfiguration>):
    required: false
    

    The configuration that specifies how nodes in the flow are executed in parallel.

    
    
  • flow_identifier(impl Into<String>) / set_flow_identifier(Option<String>):
    required: true
    

    The unique identifier of the flow.

    
    
  • alias_identifier(impl Into<String>) / set_alias_identifier(Option<String>):
    required: true
    

    The unique identifier of the alias.

    
    
• On success, responds with UpdateFlowAliasOutput with field(s):
  • name(String):

    The name of the alias.

  • description(Option<String>):

    The description of the flow.

  • routing_configuration(Vec::<FlowAliasRoutingConfigurationListItem>):

    Contains information about the version that the alias is mapped to.

  • concurrency_configuration(Option<FlowAliasConcurrencyConfiguration>):

    The configuration that specifies how nodes in the flow are executed in parallel.

  • flow_id(String):

    The unique identifier of the flow.

  • id(String):

    The unique identifier of the alias.

  • arn(String):

    The Amazon Resource Name (ARN) of the flow.

  • created_at(DateTime):

    The time at which the flow was created.

  • updated_at(DateTime):

    The time at which the alias was last updated.

• On failure, responds with SdkError<UpdateFlowAliasError>

impl Client

pub fn update_knowledge_base(&self) -> UpdateKnowledgeBaseFluentBuilder

Constructs a fluent builder for the UpdateKnowledgeBase operation.

• The fluent builder is configurable:
  • knowledge_base_id(impl Into<String>) / set_knowledge_base_id(Option<String>):
    required: true
    

    The unique identifier of the knowledge base to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Specifies a new name for the knowledge base.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Specifies a new description for the knowledge base.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

    
    
  • knowledge_base_configuration(KnowledgeBaseConfiguration) / set_knowledge_base_configuration(Option<KnowledgeBaseConfiguration>):
    required: true
    

    Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

    
    
  • storage_configuration(StorageConfiguration) / set_storage_configuration(Option<StorageConfiguration>):
    required: false
    

    Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

    
    
• On success, responds with UpdateKnowledgeBaseOutput with field(s):
  • knowledge_base(Option<KnowledgeBase>):

    Contains details about the knowledge base.

• On failure, responds with SdkError<UpdateKnowledgeBaseError>

impl Client

pub fn update_prompt(&self) -> UpdatePromptFluentBuilder

Constructs a fluent builder for the UpdatePrompt operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A name for the prompt.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the prompt.

    
    
  • customer_encryption_key_arn(impl Into<String>) / set_customer_encryption_key_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

    
    
  • default_variant(impl Into<String>) / set_default_variant(Option<String>):
    required: false
    

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

    
    
  • variants(PromptVariant) / set_variants(Option<Vec::<PromptVariant>>):
    required: false
    

    A list of objects, each containing details about a variant of the prompt.

    
    
  • prompt_identifier(impl Into<String>) / set_prompt_identifier(Option<String>):
    required: true
    

    The unique identifier of the prompt.

    
    
• On success, responds with UpdatePromptOutput with field(s):
  • name(String):

    The name of the prompt.

  • description(Option<String>):

    The description of the prompt.

  • customer_encryption_key_arn(Option<String>):

    The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.

  • default_variant(Option<String>):

    The name of the default variant for the prompt. This value must match the name field in the relevant PromptVariant object.

  • variants(Option<Vec::<PromptVariant>>):

    A list of objects, each containing details about a variant of the prompt.

  • id(String):

    The unique identifier of the prompt.

  • arn(String):

    The Amazon Resource Name (ARN) of the prompt.

  • version(String):

    The version of the prompt. When you update a prompt, the version updated is the DRAFT version.

  • created_at(DateTime):

    The time at which the prompt was created.

  • updated_at(DateTime):

    The time at which the prompt was last updated.

• On failure, responds with SdkError<UpdatePromptError>

impl Client

pub fn validate_flow_definition(&self) -> ValidateFlowDefinitionFluentBuilder

Constructs a fluent builder for the ValidateFlowDefinition operation.

• The fluent builder is configurable:
  • definition(FlowDefinition) / set_definition(Option<FlowDefinition>):
    required: true
    

    The definition of a flow to validate.

    
    
• On success, responds with ValidateFlowDefinitionOutput with field(s):
  • validations(Vec::<FlowValidation>):

    Contains an array of objects, each of which contains an error identified by validation.

• On failure, responds with SdkError<ValidateFlowDefinitionError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.