Module aws_sdk_bedrockagent::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Agents for Amazon Bedrock can respond with.

Structs

• ActionGroupSummary

  Contains details about an action group.

• Agent

  Contains details about an agent.

• AgentActionGroup

  Contains details about an action group.

• AgentAlias

  Contains details about an alias of an agent.

• AgentAliasHistoryEvent

  Contains details about the history of the alias.

• AgentAliasRoutingConfigurationListItem

  Contains details about the routing configuration of the alias.

• AgentAliasSummary

  Contains details about an alias of an agent.

• AgentKnowledgeBase

  Contains details about a knowledge base that is associated with an agent.

• AgentKnowledgeBaseSummary

  Contains details about a knowledge base associated with an agent.

• AgentSummary

  Contains details about an agent.

• AgentVersion

  Contains details about a version of an agent.

• AgentVersionSummary

  Contains details about a version of an agent.

• BedrockEmbeddingModelConfiguration

  The vector configuration details for the Bedrock embeddings model.

• ChunkingConfiguration

  Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

• DataSource

  Contains details about a data source.

• DataSourceConfiguration

  Contains details about how a data source is stored.

• DataSourceSummary

  Contains details about a data source.

• EmbeddingModelConfiguration

  The configuration details for the embeddings model.

• FixedSizeChunkingConfiguration

  Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

• Function

  Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.

• GuardrailConfiguration

  The details of the guardrails configuration.

• InferenceConfiguration

  Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

• IngestionJob

  Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

• IngestionJobFilter

  Defines a filter by which to filter the results.

• IngestionJobSortBy

  Parameters by which to sort the results.

• IngestionJobStatistics

  Contains the statistics for the ingestion job.

• IngestionJobSummary

  Contains details about an ingestion job.

• KnowledgeBase

  Contains information about a knowledge base.

• KnowledgeBaseConfiguration

  Contains details about the embeddings configuration of the knowledge base.

• KnowledgeBaseSummary

  Contains details about a knowledge base.

• MongoDbAtlasConfiguration

  Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

• MongoDbAtlasFieldMapping

  Contains the names of the fields to which to map information about the vector store.

• OpenSearchServerlessConfiguration

  Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

• OpenSearchServerlessFieldMapping

  Contains the names of the fields to which to map information about the vector store.

• ParameterDetail

  Contains details about a parameter in a function for an action group.

• PineconeConfiguration

  Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

• PineconeFieldMapping

  Contains the names of the fields to which to map information about the vector store.

• PromptConfiguration

  Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

• PromptOverrideConfiguration

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

• RdsConfiguration

  Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

• RdsFieldMapping

  Contains the names of the fields to which to map information about the vector store.

• RedisEnterpriseCloudConfiguration

  Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.

• RedisEnterpriseCloudFieldMapping

  Contains the names of the fields to which to map information about the vector store.

• S3DataSourceConfiguration

  Contains information about the S3 configuration of the data source.

• S3Identifier

  Contains information about the S3 object containing the resource.

• ServerSideEncryptionConfiguration

  Contains the configuration for server-side encryption.

• StorageConfiguration

  Contains the storage configuration of the knowledge base.

• ValidationExceptionField

  Stores information about a field passed inside a request that resulted in an validation error.

• VectorIngestionConfiguration

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

• VectorKnowledgeBaseConfiguration

  Contains details about the model used to create vector embeddings for the knowledge base.

Enums

• ActionGroupExecutor

  Contains details about 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.

• ActionGroupSignature
  When writing a match expression against ActionGroupSignature, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ActionGroupState
  When writing a match expression against ActionGroupState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AgentAliasStatus
  When writing a match expression against AgentAliasStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AgentStatus
  When writing a match expression against AgentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ApiSchema

  Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

• ChunkingStrategy
  When writing a match expression against ChunkingStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CreationMode
  When writing a match expression against CreationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CustomControlMethod
  When writing a match expression against CustomControlMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataDeletionPolicy
  When writing a match expression against DataDeletionPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataSourceStatus
  When writing a match expression against DataSourceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DataSourceType
  When writing a match expression against DataSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• FunctionSchema

  Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

• IngestionJobFilterAttribute
  When writing a match expression against IngestionJobFilterAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IngestionJobFilterOperator
  When writing a match expression against IngestionJobFilterOperator, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IngestionJobSortByAttribute
  When writing a match expression against IngestionJobSortByAttribute, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• IngestionJobStatus
  When writing a match expression against IngestionJobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseState
  When writing a match expression against KnowledgeBaseState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseStatus
  When writing a match expression against KnowledgeBaseStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseStorageType
  When writing a match expression against KnowledgeBaseStorageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• KnowledgeBaseType
  When writing a match expression against KnowledgeBaseType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PromptState
  When writing a match expression against PromptState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PromptType
  When writing a match expression against PromptType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• SortOrder
  When writing a match expression against SortOrder, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• Type
  When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.