bedrockagent

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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html)
	// request.
	KnowledgeBaseState types.KnowledgeBaseState
	// contains filtered or unexported fields
}

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 struct {
	// The name of the operation being invoked.
	Operation string

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

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

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

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

	// Specifies whether the action group is available for the agent to invoke or not
	// when sending an InvokeAgent (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html)
	// request.
	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 (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 (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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html)
	// reprompting the user for more information.
	ParentActionGroupSignature types.ActionGroupSignature
	// contains filtered or unexported fields
}

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

	// The deletion policy for the requested 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 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 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 (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 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 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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 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 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 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 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 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 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 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 struct {

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

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 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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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
}

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

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

type EndpointResolverOptions = internalendpoints.Options

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,
	)
}

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 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 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 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 struct {

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

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 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 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 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 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 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 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 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 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 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 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 interface {
	Do(*http.Request) (*http.Response, error)
}

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 interface {
	GetIdempotencyToken() (string, error)
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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

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 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 struct {
	// contains filtered or unexported fields
}

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
}

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 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 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
}

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 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 struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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 (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 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 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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html)
	// request.
	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 (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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html)
	// reprompting the user for more information.
	ParentActionGroupSignature types.ActionGroupSignature
	// contains filtered or unexported fields
}

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 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 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 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 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 (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html)
	// .
	PromptOverrideConfiguration *types.PromptOverrideConfiguration
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html)
	// request.
	KnowledgeBaseState types.KnowledgeBaseState
	// contains filtered or unexported fields
}

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 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 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 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 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 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
}