bedrockagent

package module
v0.0.0-...-9fc2571 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Overview

Package bedrockagent provides the API client, operations, and parameter types for Agents for Amazon Bedrock.

Describes the API operations for creating and managing Amazon Bedrock agents.

Index

Constants

View Source 
const ServiceAPIVersion = "2023-06-05"
View Source 
const ServiceID = "Bedrock Agent"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AssociateAgentKnowledgeBaseInput 

type AssociateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent with which you want to associate the
	// knowledge base.
	//
	// This member is required.
	AgentId *string

	// The version of the agent with which you want to associate the knowledge base.
	//
	// This member is required.
	AgentVersion *string

	// A description of what the agent should use the knowledge base for.
	//
	// This member is required.
	Description *string

	// The unique identifier of the knowledge base to associate with the agent.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies whether to use the knowledge base or not when sending an [InvokeAgent] request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	KnowledgeBaseState types.KnowledgeBaseState
	// contains filtered or unexported fields
}

type AssociateAgentKnowledgeBaseOutput 

type AssociateAgentKnowledgeBaseOutput struct {

	// Contains details about the knowledge base that has been associated with the
	// agent.
	//
	// This member is required.
	AgentKnowledgeBase *types.AgentKnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Agents for Amazon Bedrock.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateAgentKnowledgeBase 

func (c *Client) AssociateAgentKnowledgeBase(ctx context.Context, params *AssociateAgentKnowledgeBaseInput, optFns ...func(*Options)) (*AssociateAgentKnowledgeBaseOutput, error)

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled , the agent queries the knowledge base for information to augment its response to the user.

func (*Client) CreateAgent 

func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

  • Specify the following fields for security purposes.

  • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

  • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

  • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

  • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

  • If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

func (*Client) CreateAgentActionGroup 

func (c *Client) CreateAgentActionGroup(ctx context.Context, params *CreateAgentActionGroupInput, optFns ...func(*Options)) (*CreateAgentActionGroupOutput, error)

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput . You must leave the description , apiSchema , and actionGroupExecutor fields blank for this action group. 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 Observationreprompting the user for more information.

func (*Client) CreateAgentAlias 

func (c *Client) CreateAgentAlias(ctx context.Context, params *CreateAgentAliasInput, optFns ...func(*Options)) (*CreateAgentAliasOutput, error)

Creates an alias of an agent that can be used to deploy the agent.

func (*Client) CreateDataSource 

func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)

Sets up a data source to be added to a knowledge base.

You can't change the chunkingConfiguration after you create the data source.

func (*Client) CreateKnowledgeBase 

func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error)

Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.

If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

  • Provide the name and an optional description .

  • Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

  • Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

  • Provide the configuration for your vector store in the storageConfiguration object.

  • For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.

  • For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.

  • For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.

  • For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.

func (*Client) DeleteAgent 

func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)

Deletes an agent.

func (*Client) DeleteAgentActionGroup 

func (c *Client) DeleteAgentActionGroup(ctx context.Context, params *DeleteAgentActionGroupInput, optFns ...func(*Options)) (*DeleteAgentActionGroupOutput, error)

Deletes an action group in an agent.

func (*Client) DeleteAgentAlias 

func (c *Client) DeleteAgentAlias(ctx context.Context, params *DeleteAgentAliasInput, optFns ...func(*Options)) (*DeleteAgentAliasOutput, error)

Deletes an alias of an agent.

func (*Client) DeleteAgentVersion 

func (c *Client) DeleteAgentVersion(ctx context.Context, params *DeleteAgentVersionInput, optFns ...func(*Options)) (*DeleteAgentVersionOutput, error)

Deletes a version of an agent.

func (*Client) DeleteDataSource 

func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)

Deletes a data source from a knowledge base.

func (*Client) DeleteKnowledgeBase 

func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error)

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBaserequest.

func (*Client) DisassociateAgentKnowledgeBase 

func (c *Client) DisassociateAgentKnowledgeBase(ctx context.Context, params *DisassociateAgentKnowledgeBaseInput, optFns ...func(*Options)) (*DisassociateAgentKnowledgeBaseOutput, error)

Disassociates a knowledge base from an agent.

func (*Client) GetAgent 

func (c *Client) GetAgent(ctx context.Context, params *GetAgentInput, optFns ...func(*Options)) (*GetAgentOutput, error)

Gets information about an agent.

func (*Client) GetAgentActionGroup 

func (c *Client) GetAgentActionGroup(ctx context.Context, params *GetAgentActionGroupInput, optFns ...func(*Options)) (*GetAgentActionGroupOutput, error)

Gets information about an action group for an agent.

func (*Client) GetAgentAlias 

func (c *Client) GetAgentAlias(ctx context.Context, params *GetAgentAliasInput, optFns ...func(*Options)) (*GetAgentAliasOutput, error)

Gets information about an alias of an agent.

func (*Client) GetAgentKnowledgeBase 

func (c *Client) GetAgentKnowledgeBase(ctx context.Context, params *GetAgentKnowledgeBaseInput, optFns ...func(*Options)) (*GetAgentKnowledgeBaseOutput, error)

Gets information about a knowledge base associated with an agent.

func (*Client) GetAgentVersion 

func (c *Client) GetAgentVersion(ctx context.Context, params *GetAgentVersionInput, optFns ...func(*Options)) (*GetAgentVersionOutput, error)

Gets details about a version of an agent.

func (*Client) GetDataSource 

func (c *Client) GetDataSource(ctx context.Context, params *GetDataSourceInput, optFns ...func(*Options)) (*GetDataSourceOutput, error)

Gets information about a data source.

func (*Client) GetIngestionJob 

func (c *Client) GetIngestionJob(ctx context.Context, params *GetIngestionJobInput, optFns ...func(*Options)) (*GetIngestionJobOutput, error)

Gets information about a ingestion job, in which a data source is added to a knowledge base.

func (*Client) GetKnowledgeBase 

func (c *Client) GetKnowledgeBase(ctx context.Context, params *GetKnowledgeBaseInput, optFns ...func(*Options)) (*GetKnowledgeBaseOutput, error)

Gets information about a knoweldge base.

func (*Client) ListAgentActionGroups 

func (c *Client) ListAgentActionGroups(ctx context.Context, params *ListAgentActionGroupsInput, optFns ...func(*Options)) (*ListAgentActionGroupsOutput, error)

Lists the action groups for an agent and information about each one.

func (*Client) ListAgentAliases 

func (c *Client) ListAgentAliases(ctx context.Context, params *ListAgentAliasesInput, optFns ...func(*Options)) (*ListAgentAliasesOutput, error)

Lists the aliases of an agent and information about each one.

func (*Client) ListAgentKnowledgeBases 

func (c *Client) ListAgentKnowledgeBases(ctx context.Context, params *ListAgentKnowledgeBasesInput, optFns ...func(*Options)) (*ListAgentKnowledgeBasesOutput, error)

Lists knowledge bases associated with an agent and information about each one.

func (*Client) ListAgentVersions 

func (c *Client) ListAgentVersions(ctx context.Context, params *ListAgentVersionsInput, optFns ...func(*Options)) (*ListAgentVersionsOutput, error)

Lists the versions of an agent and information about each version.

func (*Client) ListAgents 

func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)

Lists the agents belonging to an account and information about each agent.

func (*Client) ListDataSources 

func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

Lists the data sources in a knowledge base and information about each one.

func (*Client) ListIngestionJobs 

func (c *Client) ListIngestionJobs(ctx context.Context, params *ListIngestionJobsInput, optFns ...func(*Options)) (*ListIngestionJobsOutput, error)

Lists the ingestion jobs for a data source and information about each of them.

func (*Client) ListKnowledgeBases 

func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)

Lists the knowledge bases in an account and information about each of them.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List all the tags for the resource you specify.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) PrepareAgent 

func (c *Client) PrepareAgent(ctx context.Context, params *PrepareAgentInput, optFns ...func(*Options)) (*PrepareAgentOutput, error)

Creates a DRAFT version of the agent that can be used for internal testing.

func (*Client) StartIngestionJob 

func (c *Client) StartIngestionJob(ctx context.Context, params *StartIngestionJobInput, optFns ...func(*Options)) (*StartIngestionJobOutput, error)

Begins an ingestion job, in which a data source is added to a knowledge base.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Remove tags from a resource.

func (*Client) UpdateAgent 

func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)

Updates the configuration of an agent.

func (*Client) UpdateAgentActionGroup 

func (c *Client) UpdateAgentActionGroup(ctx context.Context, params *UpdateAgentActionGroupInput, optFns ...func(*Options)) (*UpdateAgentActionGroupOutput, error)

Updates the configuration for an action group for an agent.

func (*Client) UpdateAgentAlias 

func (c *Client) UpdateAgentAlias(ctx context.Context, params *UpdateAgentAliasInput, optFns ...func(*Options)) (*UpdateAgentAliasOutput, error)

Updates configurations for an alias of an agent.

func (*Client) UpdateAgentKnowledgeBase 

func (c *Client) UpdateAgentKnowledgeBase(ctx context.Context, params *UpdateAgentKnowledgeBaseInput, optFns ...func(*Options)) (*UpdateAgentKnowledgeBaseOutput, error)

Updates the configuration for a knowledge base that has been associated with an agent.

func (*Client) UpdateDataSource 

func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)

Updates configurations for a data source.

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration .

func (*Client) UpdateKnowledgeBase 

func (c *Client) UpdateKnowledgeBase(ctx context.Context, params *UpdateKnowledgeBaseInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseOutput, error)

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

You can change the following fields:

  • name

  • description

  • roleArn

You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBaserequest and copy the same configurations.

type CreateAgentActionGroupInput 

type CreateAgentActionGroupInput struct {

	// The name to give the action group.
	//
	// This member is required.
	ActionGroupName *string

	// The unique identifier of the agent for which to create the action group.
	//
	// This member is required.
	AgentId *string

	// The version of the agent for which to create the action group.
	//
	// This member is required.
	AgentVersion *string

	// 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.
	ActionGroupExecutor types.ActionGroupExecutor

	// Specifies whether the action group is available for the agent to invoke or not
	// when sending an [InvokeAgent]request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	ActionGroupState types.ActionGroupState

	// 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 OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
	ApiSchema types.APISchema

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// A description of the action group.
	Description *string

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

	// To allow your agent to request the user for additional information when trying
	// to complete a task, set this field to AMAZON.UserInput . You must leave the
	// description , apiSchema , and actionGroupExecutor fields blank for this action
	// group.
	//
	// 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.
	//
	// [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
	ParentActionGroupSignature types.ActionGroupSignature
	// contains filtered or unexported fields
}

type CreateAgentActionGroupOutput 

type CreateAgentActionGroupOutput struct {

	// Contains details about the action group that was created.
	//
	// This member is required.
	AgentActionGroup *types.AgentActionGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAgentAliasInput 

type CreateAgentAliasInput struct {

	// The name of the alias.
	//
	// This member is required.
	AgentAliasName *string

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// A description of the alias of the agent.
	Description *string

	// Contains details about the routing configuration of the alias.
	RoutingConfiguration []types.AgentAliasRoutingConfigurationListItem

	// Any tags that you want to attach to the alias of the agent.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAgentAliasOutput 

type CreateAgentAliasOutput struct {

	// Contains details about the alias that was created.
	//
	// This member is required.
	AgentAlias *types.AgentAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateAgentInput 

type CreateAgentInput struct {

	// A name for the agent that you create.
	//
	// This member is required.
	AgentName *string

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

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

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

	// A description of the agent.
	Description *string

	// The foundation model to be used for orchestration by the agent you create.
	FoundationModel *string

	// The unique Guardrail configuration assigned to the agent when it is created.
	GuardrailConfiguration *types.GuardrailConfiguration

	// 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.
	IdleSessionTTLInSeconds *int32

	// Instructions that tell the agent what it should do and how it should interact
	// with users.
	Instruction *string

	// Contains configurations to override prompts in different parts of an agent
	// sequence. For more information, see [Advanced prompts].
	//
	// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
	PromptOverrideConfiguration *types.PromptOverrideConfiguration

	// Any tags that you want to attach to the agent.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateAgentOutput 

type CreateAgentOutput struct {

	// Contains details about the agent created.
	//
	// This member is required.
	Agent *types.Agent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateDataSourceInput 

type CreateDataSourceInput struct {

	// Contains metadata about where the data source is stored.
	//
	// This member is required.
	DataSourceConfiguration *types.DataSourceConfiguration

	// The unique identifier of the knowledge base to which to add the data source.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The name of the data source.
	//
	// This member is required.
	Name *string

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// The data deletion policy assigned to the data source.
	DataDeletionPolicy types.DataDeletionPolicy

	// A description of the data source.
	Description *string

	// Contains details about the server-side encryption for the data source.
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *types.VectorIngestionConfiguration
	// contains filtered or unexported fields
}

type CreateDataSourceOutput 

type CreateDataSourceOutput struct {

	// Contains details about the data source.
	//
	// This member is required.
	DataSource *types.DataSource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateKnowledgeBaseInput 

type CreateKnowledgeBaseInput struct {

	// Contains details about the embeddings model used for the knowledge base.
	//
	// This member is required.
	KnowledgeBaseConfiguration *types.KnowledgeBaseConfiguration

	// A name for the knowledge base.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API
	// operations on the knowledge base.
	//
	// This member is required.
	RoleArn *string

	// Contains details about the configuration of the vector database used for the
	// knowledge base.
	//
	// This member is required.
	StorageConfiguration *types.StorageConfiguration

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// A description of the knowledge base.
	Description *string

	// Specify the key-value pairs for the tags that you want to attach to your
	// knowledge base in this object.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateKnowledgeBaseOutput 

type CreateKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// This member is required.
	KnowledgeBase *types.KnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAgentActionGroupInput 

type DeleteAgentActionGroupInput struct {

	// The unique identifier of the action group to delete.
	//
	// This member is required.
	ActionGroupId *string

	// The unique identifier of the agent that the action group belongs to.
	//
	// This member is required.
	AgentId *string

	// The version of the agent that the action group belongs to.
	//
	// This member is required.
	AgentVersion *string

	// 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.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteAgentActionGroupOutput 

type DeleteAgentActionGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAgentAliasInput 

type DeleteAgentAliasInput struct {

	// The unique identifier of the alias to delete.
	//
	// This member is required.
	AgentAliasId *string

	// The unique identifier of the agent that the alias belongs to.
	//
	// This member is required.
	AgentId *string
	// contains filtered or unexported fields
}

type DeleteAgentAliasOutput 

type DeleteAgentAliasOutput struct {

	// The unique identifier of the alias that was deleted.
	//
	// This member is required.
	AgentAliasId *string

	// The status of the alias.
	//
	// This member is required.
	AgentAliasStatus types.AgentAliasStatus

	// The unique identifier of the agent that the alias belongs to.
	//
	// This member is required.
	AgentId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAgentInput 

type DeleteAgentInput struct {

	// The unique identifier of the agent to delete.
	//
	// This member is required.
	AgentId *string

	// 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.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteAgentOutput 

type DeleteAgentOutput struct {

	// The unique identifier of the agent that was deleted.
	//
	// This member is required.
	AgentId *string

	// The status of the agent.
	//
	// This member is required.
	AgentStatus types.AgentStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAgentVersionInput 

type DeleteAgentVersionInput struct {

	// The unique identifier of the agent that the version belongs to.
	//
	// This member is required.
	AgentId *string

	// The version of the agent to delete.
	//
	// This member is required.
	AgentVersion *string

	// 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.
	SkipResourceInUseCheck bool
	// contains filtered or unexported fields
}

type DeleteAgentVersionOutput 

type DeleteAgentVersionOutput struct {

	// The unique identifier of the agent that the version belongs to.
	//
	// This member is required.
	AgentId *string

	// The status of the agent version.
	//
	// This member is required.
	AgentStatus types.AgentStatus

	// The version that was deleted.
	//
	// This member is required.
	AgentVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDataSourceInput 

type DeleteDataSourceInput struct {

	// The unique identifier of the data source to delete.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base from which to delete the data
	// source.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteDataSourceOutput 

type DeleteDataSourceOutput struct {

	// The unique identifier of the data source that was deleted.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base to which the data source that was
	// deleted belonged.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The status of the data source.
	//
	// This member is required.
	Status types.DataSourceStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteKnowledgeBaseInput 

type DeleteKnowledgeBaseInput struct {

	// The unique identifier of the knowledge base to delete.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DeleteKnowledgeBaseOutput 

type DeleteKnowledgeBaseOutput struct {

	// The unique identifier of the knowledge base that was deleted.
	//
	// This member is required.
	KnowledgeBaseId *string

	// The status of the knowledge base and whether it has been successfully deleted.
	//
	// This member is required.
	Status types.KnowledgeBaseStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateAgentKnowledgeBaseInput 

type DisassociateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent from which to disassociate the knowledge
	// base.
	//
	// This member is required.
	AgentId *string

	// The version of the agent from which to disassociate the knowledge base.
	//
	// This member is required.
	AgentVersion *string

	// The unique identifier of the knowledge base to disassociate.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type DisassociateAgentKnowledgeBaseOutput 

type DisassociateAgentKnowledgeBaseOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAgentActionGroupInput 

type GetAgentActionGroupInput struct {

	// The unique identifier of the action group for which to get information.
	//
	// This member is required.
	ActionGroupId *string

	// The unique identifier of the agent that the action group belongs to.
	//
	// This member is required.
	AgentId *string

	// The version of the agent that the action group belongs to.
	//
	// This member is required.
	AgentVersion *string
	// contains filtered or unexported fields
}

type GetAgentActionGroupOutput 

type GetAgentActionGroupOutput struct {

	// Contains details about the action group.
	//
	// This member is required.
	AgentActionGroup *types.AgentActionGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAgentAliasInput 

type GetAgentAliasInput struct {

	// The unique identifier of the alias for which to get information.
	//
	// This member is required.
	AgentAliasId *string

	// The unique identifier of the agent to which the alias to get information
	// belongs.
	//
	// This member is required.
	AgentId *string
	// contains filtered or unexported fields
}

type GetAgentAliasOutput 

type GetAgentAliasOutput struct {

	// Contains information about the alias.
	//
	// This member is required.
	AgentAlias *types.AgentAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAgentInput 

type GetAgentInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string
	// contains filtered or unexported fields
}

type GetAgentKnowledgeBaseInput 

type GetAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent with which the knowledge base is associated.
	//
	// This member is required.
	AgentId *string

	// The version of the agent with which the knowledge base is associated.
	//
	// This member is required.
	AgentVersion *string

	// The unique identifier of the knowledge base associated with the agent.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetAgentKnowledgeBaseOutput 

type GetAgentKnowledgeBaseOutput struct {

	// Contains details about a knowledge base attached to an agent.
	//
	// This member is required.
	AgentKnowledgeBase *types.AgentKnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAgentOutput 

type GetAgentOutput struct {

	// Contains details about the agent.
	//
	// This member is required.
	Agent *types.Agent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetAgentVersionInput 

type GetAgentVersionInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// The version of the agent.
	//
	// This member is required.
	AgentVersion *string
	// contains filtered or unexported fields
}

type GetAgentVersionOutput 

type GetAgentVersionOutput struct {

	// Contains details about the version of the agent.
	//
	// This member is required.
	AgentVersion *types.AgentVersion

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetDataSourceInput 

type GetDataSourceInput struct {

	// The unique identifier of the data source.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base that the data source was added to.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetDataSourceOutput 

type GetDataSourceOutput struct {

	// Contains details about the data source.
	//
	// This member is required.
	DataSource *types.DataSource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetIngestionJobInput 

type GetIngestionJobInput struct {

	// The unique identifier of the data source in the ingestion job.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the ingestion job.
	//
	// This member is required.
	IngestionJobId *string

	// The unique identifier of the knowledge base for which the ingestion job applies.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetIngestionJobOutput 

type GetIngestionJobOutput struct {

	// Contains details about the ingestion job.
	//
	// This member is required.
	IngestionJob *types.IngestionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetKnowledgeBaseInput 

type GetKnowledgeBaseInput struct {

	// The unique identifier of the knowledge base for which to get information.
	//
	// This member is required.
	KnowledgeBaseId *string
	// contains filtered or unexported fields
}

type GetKnowledgeBaseOutput 

type GetKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// This member is required.
	KnowledgeBase *types.KnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAgentActionGroupsAPIClient 

type ListAgentActionGroupsAPIClient interface {
	ListAgentActionGroups(context.Context, *ListAgentActionGroupsInput, ...func(*Options)) (*ListAgentActionGroupsOutput, error)
}

ListAgentActionGroupsAPIClient is a client that implements the ListAgentActionGroups operation.

type ListAgentActionGroupsInput 

type ListAgentActionGroupsInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// The version of the agent.
	//
	// This member is required.
	AgentVersion *string

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentActionGroupsOutput 

type ListAgentActionGroupsOutput struct {

	// A list of objects, each of which contains information about an action group.
	//
	// This member is required.
	ActionGroupSummaries []types.ActionGroupSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAgentActionGroupsPaginator 

type ListAgentActionGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListAgentActionGroupsPaginator is a paginator for ListAgentActionGroups

func NewListAgentActionGroupsPaginator 

func NewListAgentActionGroupsPaginator(client ListAgentActionGroupsAPIClient, params *ListAgentActionGroupsInput, optFns ...func(*ListAgentActionGroupsPaginatorOptions)) *ListAgentActionGroupsPaginator

NewListAgentActionGroupsPaginator returns a new ListAgentActionGroupsPaginator

func (*ListAgentActionGroupsPaginator) HasMorePages 

func (p *ListAgentActionGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentActionGroupsPaginator) NextPage 

func (p *ListAgentActionGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentActionGroupsOutput, error)

NextPage retrieves the next ListAgentActionGroups page.

type ListAgentActionGroupsPaginatorOptions 

type ListAgentActionGroupsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentActionGroupsPaginatorOptions is the paginator options for ListAgentActionGroups

type ListAgentAliasesAPIClient 

type ListAgentAliasesAPIClient interface {
	ListAgentAliases(context.Context, *ListAgentAliasesInput, ...func(*Options)) (*ListAgentAliasesOutput, error)
}

ListAgentAliasesAPIClient is a client that implements the ListAgentAliases operation.

type ListAgentAliasesInput 

type ListAgentAliasesInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentAliasesOutput 

type ListAgentAliasesOutput struct {

	// A list of objects, each of which contains information about an alias of the
	// agent.
	//
	// This member is required.
	AgentAliasSummaries []types.AgentAliasSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAgentAliasesPaginator 

type ListAgentAliasesPaginator struct {
	// contains filtered or unexported fields
}

ListAgentAliasesPaginator is a paginator for ListAgentAliases

func NewListAgentAliasesPaginator 

func NewListAgentAliasesPaginator(client ListAgentAliasesAPIClient, params *ListAgentAliasesInput, optFns ...func(*ListAgentAliasesPaginatorOptions)) *ListAgentAliasesPaginator

NewListAgentAliasesPaginator returns a new ListAgentAliasesPaginator

func (*ListAgentAliasesPaginator) HasMorePages 

func (p *ListAgentAliasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentAliasesPaginator) NextPage 

func (p *ListAgentAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentAliasesOutput, error)

NextPage retrieves the next ListAgentAliases page.

type ListAgentAliasesPaginatorOptions 

type ListAgentAliasesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentAliasesPaginatorOptions is the paginator options for ListAgentAliases

type ListAgentKnowledgeBasesAPIClient 

type ListAgentKnowledgeBasesAPIClient interface {
	ListAgentKnowledgeBases(context.Context, *ListAgentKnowledgeBasesInput, ...func(*Options)) (*ListAgentKnowledgeBasesOutput, error)
}

ListAgentKnowledgeBasesAPIClient is a client that implements the ListAgentKnowledgeBases operation.

type ListAgentKnowledgeBasesInput 

type ListAgentKnowledgeBasesInput struct {

	// The unique identifier of the agent for which to return information about
	// knowledge bases associated with it.
	//
	// This member is required.
	AgentId *string

	// The version of the agent for which to return information about knowledge bases
	// associated with it.
	//
	// This member is required.
	AgentVersion *string

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentKnowledgeBasesOutput 

type ListAgentKnowledgeBasesOutput struct {

	// A list of objects, each of which contains information about a knowledge base
	// associated with the agent.
	//
	// This member is required.
	AgentKnowledgeBaseSummaries []types.AgentKnowledgeBaseSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAgentKnowledgeBasesPaginator 

type ListAgentKnowledgeBasesPaginator struct {
	// contains filtered or unexported fields
}

ListAgentKnowledgeBasesPaginator is a paginator for ListAgentKnowledgeBases

func NewListAgentKnowledgeBasesPaginator 

func NewListAgentKnowledgeBasesPaginator(client ListAgentKnowledgeBasesAPIClient, params *ListAgentKnowledgeBasesInput, optFns ...func(*ListAgentKnowledgeBasesPaginatorOptions)) *ListAgentKnowledgeBasesPaginator

NewListAgentKnowledgeBasesPaginator returns a new ListAgentKnowledgeBasesPaginator

func (*ListAgentKnowledgeBasesPaginator) HasMorePages 

func (p *ListAgentKnowledgeBasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentKnowledgeBasesPaginator) NextPage 

func (p *ListAgentKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentKnowledgeBasesOutput, error)

NextPage retrieves the next ListAgentKnowledgeBases page.

type ListAgentKnowledgeBasesPaginatorOptions 

type ListAgentKnowledgeBasesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentKnowledgeBasesPaginatorOptions is the paginator options for ListAgentKnowledgeBases

type ListAgentVersionsAPIClient 

type ListAgentVersionsAPIClient interface {
	ListAgentVersions(context.Context, *ListAgentVersionsInput, ...func(*Options)) (*ListAgentVersionsOutput, error)
}

ListAgentVersionsAPIClient is a client that implements the ListAgentVersions operation.

type ListAgentVersionsInput 

type ListAgentVersionsInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentVersionsOutput 

type ListAgentVersionsOutput struct {

	// A list of objects, each of which contains information about a version of the
	// agent.
	//
	// This member is required.
	AgentVersionSummaries []types.AgentVersionSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAgentVersionsPaginator 

type ListAgentVersionsPaginator struct {
	// contains filtered or unexported fields
}

ListAgentVersionsPaginator is a paginator for ListAgentVersions

func NewListAgentVersionsPaginator 

func NewListAgentVersionsPaginator(client ListAgentVersionsAPIClient, params *ListAgentVersionsInput, optFns ...func(*ListAgentVersionsPaginatorOptions)) *ListAgentVersionsPaginator

NewListAgentVersionsPaginator returns a new ListAgentVersionsPaginator

func (*ListAgentVersionsPaginator) HasMorePages 

func (p *ListAgentVersionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentVersionsPaginator) NextPage 

func (p *ListAgentVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentVersionsOutput, error)

NextPage retrieves the next ListAgentVersions page.

type ListAgentVersionsPaginatorOptions 

type ListAgentVersionsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentVersionsPaginatorOptions is the paginator options for ListAgentVersions

type ListAgentsAPIClient 

type ListAgentsAPIClient interface {
	ListAgents(context.Context, *ListAgentsInput, ...func(*Options)) (*ListAgentsOutput, error)
}

ListAgentsAPIClient is a client that implements the ListAgents operation.

type ListAgentsInput 

type ListAgentsInput struct {

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAgentsOutput 

type ListAgentsOutput struct {

	// A list of objects, each of which contains information about an agent.
	//
	// This member is required.
	AgentSummaries []types.AgentSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAgentsPaginator 

type ListAgentsPaginator struct {
	// contains filtered or unexported fields
}

ListAgentsPaginator is a paginator for ListAgents

func NewListAgentsPaginator 

func NewListAgentsPaginator(client ListAgentsAPIClient, params *ListAgentsInput, optFns ...func(*ListAgentsPaginatorOptions)) *ListAgentsPaginator

NewListAgentsPaginator returns a new ListAgentsPaginator

func (*ListAgentsPaginator) HasMorePages 

func (p *ListAgentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentsPaginator) NextPage 

func (p *ListAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentsOutput, error)

NextPage retrieves the next ListAgents page.

type ListAgentsPaginatorOptions 

type ListAgentsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentsPaginatorOptions is the paginator options for ListAgents

type ListDataSourcesAPIClient 

type ListDataSourcesAPIClient interface {
	ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}

ListDataSourcesAPIClient is a client that implements the ListDataSources operation.

type ListDataSourcesInput 

type ListDataSourcesInput struct {

	// The unique identifier of the knowledge base for which to return a list of
	// information.
	//
	// This member is required.
	KnowledgeBaseId *string

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListDataSourcesOutput 

type ListDataSourcesOutput struct {

	// A list of objects, each of which contains information about a data source.
	//
	// This member is required.
	DataSourceSummaries []types.DataSourceSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListDataSourcesPaginator 

type ListDataSourcesPaginator struct {
	// contains filtered or unexported fields
}

ListDataSourcesPaginator is a paginator for ListDataSources

func NewListDataSourcesPaginator 

func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator

NewListDataSourcesPaginator returns a new ListDataSourcesPaginator

func (*ListDataSourcesPaginator) HasMorePages 

func (p *ListDataSourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDataSourcesPaginator) NextPage 

func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)

NextPage retrieves the next ListDataSources page.

type ListDataSourcesPaginatorOptions 

type ListDataSourcesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDataSourcesPaginatorOptions is the paginator options for ListDataSources

type ListIngestionJobsAPIClient 

type ListIngestionJobsAPIClient interface {
	ListIngestionJobs(context.Context, *ListIngestionJobsInput, ...func(*Options)) (*ListIngestionJobsOutput, error)
}

ListIngestionJobsAPIClient is a client that implements the ListIngestionJobs operation.

type ListIngestionJobsInput 

type ListIngestionJobsInput struct {

	// The unique identifier of the data source for which to return ingestion jobs.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base for which to return ingestion jobs.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Contains a definition of a filter for which to filter the results.
	Filters []types.IngestionJobFilter

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string

	// Contains details about how to sort the results.
	SortBy *types.IngestionJobSortBy
	// contains filtered or unexported fields
}

type ListIngestionJobsOutput 

type ListIngestionJobsOutput struct {

	// A list of objects, each of which contains information about an ingestion job.
	//
	// This member is required.
	IngestionJobSummaries []types.IngestionJobSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListIngestionJobsPaginator 

type ListIngestionJobsPaginator struct {
	// contains filtered or unexported fields
}

ListIngestionJobsPaginator is a paginator for ListIngestionJobs

func NewListIngestionJobsPaginator 

func NewListIngestionJobsPaginator(client ListIngestionJobsAPIClient, params *ListIngestionJobsInput, optFns ...func(*ListIngestionJobsPaginatorOptions)) *ListIngestionJobsPaginator

NewListIngestionJobsPaginator returns a new ListIngestionJobsPaginator

func (*ListIngestionJobsPaginator) HasMorePages 

func (p *ListIngestionJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIngestionJobsPaginator) NextPage 

func (p *ListIngestionJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestionJobsOutput, error)

NextPage retrieves the next ListIngestionJobs page.

type ListIngestionJobsPaginatorOptions 

type ListIngestionJobsPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIngestionJobsPaginatorOptions is the paginator options for ListIngestionJobs

type ListKnowledgeBasesAPIClient 

type ListKnowledgeBasesAPIClient interface {
	ListKnowledgeBases(context.Context, *ListKnowledgeBasesInput, ...func(*Options)) (*ListKnowledgeBasesOutput, error)
}

ListKnowledgeBasesAPIClient is a client that implements the ListKnowledgeBases operation.

type ListKnowledgeBasesInput 

type ListKnowledgeBasesInput struct {

	// 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.
	MaxResults *int32

	// 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.
	NextToken *string
	// contains filtered or unexported fields
}

type ListKnowledgeBasesOutput 

type ListKnowledgeBasesOutput struct {

	// A list of objects, each of which contains information about a knowledge base.
	//
	// This member is required.
	KnowledgeBaseSummaries []types.KnowledgeBaseSummary

	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListKnowledgeBasesPaginator 

type ListKnowledgeBasesPaginator struct {
	// contains filtered or unexported fields
}

ListKnowledgeBasesPaginator is a paginator for ListKnowledgeBases

func NewListKnowledgeBasesPaginator 

func NewListKnowledgeBasesPaginator(client ListKnowledgeBasesAPIClient, params *ListKnowledgeBasesInput, optFns ...func(*ListKnowledgeBasesPaginatorOptions)) *ListKnowledgeBasesPaginator

NewListKnowledgeBasesPaginator returns a new ListKnowledgeBasesPaginator

func (*ListKnowledgeBasesPaginator) HasMorePages 

func (p *ListKnowledgeBasesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListKnowledgeBasesPaginator) NextPage 

func (p *ListKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)

NextPage retrieves the next ListKnowledgeBases page.

type ListKnowledgeBasesPaginatorOptions 

type ListKnowledgeBasesPaginatorOptions struct {
	// 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.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListKnowledgeBasesPaginatorOptions is the paginator options for ListKnowledgeBases

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which to list tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The key-value pairs for the tags associated with the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PrepareAgentInput 

type PrepareAgentInput struct {

	// The unique identifier of the agent for which to create a DRAFT version.
	//
	// This member is required.
	AgentId *string
	// contains filtered or unexported fields
}

type PrepareAgentOutput 

type PrepareAgentOutput struct {

	// The unique identifier of the agent for which the DRAFT version was created.
	//
	// This member is required.
	AgentId *string

	// The status of the DRAFT version and whether it is ready for use.
	//
	// This member is required.
	AgentStatus types.AgentStatus

	// The version of the agent.
	//
	// This member is required.
	AgentVersion *string

	// The time at which the DRAFT version of the agent was last prepared.
	//
	// This member is required.
	PreparedAt *time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartIngestionJobInput 

type StartIngestionJobInput struct {

	// The unique identifier of the data source to ingest.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base to which to add the data source.
	//
	// This member is required.
	KnowledgeBaseId *string

	// 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].
	//
	// [Ensuring idempotency]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
	ClientToken *string

	// A description of the ingestion job.
	Description *string
	// contains filtered or unexported fields
}

type StartIngestionJobOutput 

type StartIngestionJobOutput struct {

	// An object containing information about the ingestion job.
	//
	// This member is required.
	IngestionJob *types.IngestionJob

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// This member is required.
	ResourceArn *string

	// An object containing key-value pairs that define the tags to attach to the
	// resource.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to remove tags.
	//
	// This member is required.
	ResourceArn *string

	// A list of keys of the tags to remove from the resource.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAgentActionGroupInput 

type UpdateAgentActionGroupInput struct {

	// The unique identifier of the action group.
	//
	// This member is required.
	ActionGroupId *string

	// Specifies a new name for the action group.
	//
	// This member is required.
	ActionGroupName *string

	// The unique identifier of the agent for which to update the action group.
	//
	// This member is required.
	AgentId *string

	// The unique identifier of the agent version for which to update the action group.
	//
	// This member is required.
	AgentVersion *string

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

	// Specifies whether the action group is available for the agent to invoke or not
	// when sending an [InvokeAgent]request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	ActionGroupState types.ActionGroupState

	// 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 OpenAPI schemas]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
	ApiSchema types.APISchema

	// Specifies a new name for the action group.
	Description *string

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

	// To allow your agent to request the user for additional information when trying
	// to complete a task, set this field to AMAZON.UserInput . You must leave the
	// description , apiSchema , and actionGroupExecutor fields blank for this action
	// group.
	//
	// 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.
	//
	// [Observation]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
	ParentActionGroupSignature types.ActionGroupSignature
	// contains filtered or unexported fields
}

type UpdateAgentActionGroupOutput 

type UpdateAgentActionGroupOutput struct {

	// Contains details about the action group that was updated.
	//
	// This member is required.
	AgentActionGroup *types.AgentActionGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAgentAliasInput 

type UpdateAgentAliasInput struct {

	// The unique identifier of the alias.
	//
	// This member is required.
	AgentAliasId *string

	// Specifies a new name for the alias.
	//
	// This member is required.
	AgentAliasName *string

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// Specifies a new description for the alias.
	Description *string

	// Contains details about the routing configuration of the alias.
	RoutingConfiguration []types.AgentAliasRoutingConfigurationListItem
	// contains filtered or unexported fields
}

type UpdateAgentAliasOutput 

type UpdateAgentAliasOutput struct {

	// Contains details about the alias that was updated.
	//
	// This member is required.
	AgentAlias *types.AgentAlias

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAgentInput 

type UpdateAgentInput struct {

	// The unique identifier of the agent.
	//
	// This member is required.
	AgentId *string

	// Specifies a new name for the agent.
	//
	// This member is required.
	AgentName *string

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API
	// operations on the agent.
	//
	// This member is required.
	AgentResourceRoleArn *string

	// Specifies a new foundation model to be used for orchestration by the agent.
	//
	// This member is required.
	FoundationModel *string

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

	// Specifies a new description of the agent.
	Description *string

	// The unique Guardrail configuration assigned to the agent when it is updated.
	GuardrailConfiguration *types.GuardrailConfiguration

	// 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.
	IdleSessionTTLInSeconds *int32

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

	// Contains configurations to override prompts in different parts of an agent
	// sequence. For more information, see [Advanced prompts].
	//
	// [Advanced prompts]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
	PromptOverrideConfiguration *types.PromptOverrideConfiguration
	// contains filtered or unexported fields
}

type UpdateAgentKnowledgeBaseInput 

type UpdateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent associated with the knowledge base that you
	// want to update.
	//
	// This member is required.
	AgentId *string

	// The version of the agent associated with the knowledge base that you want to
	// update.
	//
	// This member is required.
	AgentVersion *string

	// The unique identifier of the knowledge base that has been associated with an
	// agent.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies a new description for the knowledge base associated with an agent.
	Description *string

	// Specifies whether the agent uses the knowledge base or not when sending an [InvokeAgent]
	// request.
	//
	// [InvokeAgent]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
	KnowledgeBaseState types.KnowledgeBaseState
	// contains filtered or unexported fields
}

type UpdateAgentKnowledgeBaseOutput 

type UpdateAgentKnowledgeBaseOutput struct {

	// Contains details about the knowledge base that has been associated with an
	// agent.
	//
	// This member is required.
	AgentKnowledgeBase *types.AgentKnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAgentOutput 

type UpdateAgentOutput struct {

	// Contains details about the agent that was updated.
	//
	// This member is required.
	Agent *types.Agent

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateDataSourceInput 

type UpdateDataSourceInput struct {

	// Contains details about the storage configuration of the data source.
	//
	// This member is required.
	DataSourceConfiguration *types.DataSourceConfiguration

	// The unique identifier of the data source.
	//
	// This member is required.
	DataSourceId *string

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies a new name for the data source.
	//
	// This member is required.
	Name *string

	// The data deletion policy of the updated data source.
	DataDeletionPolicy types.DataDeletionPolicy

	// Specifies a new description for the data source.
	Description *string

	// Contains details about server-side encryption of the data source.
	ServerSideEncryptionConfiguration *types.ServerSideEncryptionConfiguration

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *types.VectorIngestionConfiguration
	// contains filtered or unexported fields
}

type UpdateDataSourceOutput 

type UpdateDataSourceOutput struct {

	// Contains details about the data source.
	//
	// This member is required.
	DataSource *types.DataSource

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateKnowledgeBaseInput 

type UpdateKnowledgeBaseInput struct {

	// 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.
	//
	// This member is required.
	KnowledgeBaseConfiguration *types.KnowledgeBaseConfiguration

	// The unique identifier of the knowledge base to update.
	//
	// This member is required.
	KnowledgeBaseId *string

	// Specifies a new name for the knowledge base.
	//
	// This member is required.
	Name *string

	// Specifies a different Amazon Resource Name (ARN) of the IAM role with
	// permissions to invoke API operations on the knowledge base.
	//
	// This member is required.
	RoleArn *string

	// 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.
	//
	// This member is required.
	StorageConfiguration *types.StorageConfiguration

	// Specifies a new description for the knowledge base.
	Description *string
	// contains filtered or unexported fields
}

type UpdateKnowledgeBaseOutput 

type UpdateKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// This member is required.
	KnowledgeBase *types.KnowledgeBase

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.