bedrockagent

package
v1.0.3 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package bedrockagent provides the client and types for making API requests to Agents for Amazon Bedrock.

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

See https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05 for more information on this service.

See bedrockagent package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagent/

Using the Client

To contact Agents for Amazon Bedrock with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Agents for Amazon Bedrock client BedrockAgent for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagent/#New

Index

Constants

View Source
const (
	// ActionGroupStateEnabled is a ActionGroupState enum value
	ActionGroupStateEnabled = "ENABLED"

	// ActionGroupStateDisabled is a ActionGroupState enum value
	ActionGroupStateDisabled = "DISABLED"
)
View Source
const (
	// AgentAliasStatusCreating is a AgentAliasStatus enum value
	AgentAliasStatusCreating = "CREATING"

	// AgentAliasStatusPrepared is a AgentAliasStatus enum value
	AgentAliasStatusPrepared = "PREPARED"

	// AgentAliasStatusFailed is a AgentAliasStatus enum value
	AgentAliasStatusFailed = "FAILED"

	// AgentAliasStatusUpdating is a AgentAliasStatus enum value
	AgentAliasStatusUpdating = "UPDATING"

	// AgentAliasStatusDeleting is a AgentAliasStatus enum value
	AgentAliasStatusDeleting = "DELETING"
)
View Source
const (
	// AgentStatusCreating is a AgentStatus enum value
	AgentStatusCreating = "CREATING"

	// AgentStatusPreparing is a AgentStatus enum value
	AgentStatusPreparing = "PREPARING"

	// AgentStatusPrepared is a AgentStatus enum value
	AgentStatusPrepared = "PREPARED"

	// AgentStatusNotPrepared is a AgentStatus enum value
	AgentStatusNotPrepared = "NOT_PREPARED"

	// AgentStatusDeleting is a AgentStatus enum value
	AgentStatusDeleting = "DELETING"

	// AgentStatusFailed is a AgentStatus enum value
	AgentStatusFailed = "FAILED"

	// AgentStatusVersioning is a AgentStatus enum value
	AgentStatusVersioning = "VERSIONING"

	// AgentStatusUpdating is a AgentStatus enum value
	AgentStatusUpdating = "UPDATING"
)
View Source
const (
	// ChunkingStrategyFixedSize is a ChunkingStrategy enum value
	ChunkingStrategyFixedSize = "FIXED_SIZE"

	// ChunkingStrategyNone is a ChunkingStrategy enum value
	ChunkingStrategyNone = "NONE"
)
View Source
const (
	// CreationModeDefault is a CreationMode enum value
	CreationModeDefault = "DEFAULT"

	// CreationModeOverridden is a CreationMode enum value
	CreationModeOverridden = "OVERRIDDEN"
)
View Source
const (
	// DataDeletionPolicyRetain is a DataDeletionPolicy enum value
	DataDeletionPolicyRetain = "RETAIN"

	// DataDeletionPolicyDelete is a DataDeletionPolicy enum value
	DataDeletionPolicyDelete = "DELETE"
)
View Source
const (
	// DataSourceStatusAvailable is a DataSourceStatus enum value
	DataSourceStatusAvailable = "AVAILABLE"

	// DataSourceStatusDeleting is a DataSourceStatus enum value
	DataSourceStatusDeleting = "DELETING"

	// DataSourceStatusDeleteUnsuccessful is a DataSourceStatus enum value
	DataSourceStatusDeleteUnsuccessful = "DELETE_UNSUCCESSFUL"
)
View Source
const (
	// IngestionJobSortByAttributeStatus is a IngestionJobSortByAttribute enum value
	IngestionJobSortByAttributeStatus = "STATUS"

	// IngestionJobSortByAttributeStartedAt is a IngestionJobSortByAttribute enum value
	IngestionJobSortByAttributeStartedAt = "STARTED_AT"
)
View Source
const (
	// IngestionJobStatusStarting is a IngestionJobStatus enum value
	IngestionJobStatusStarting = "STARTING"

	// IngestionJobStatusInProgress is a IngestionJobStatus enum value
	IngestionJobStatusInProgress = "IN_PROGRESS"

	// IngestionJobStatusComplete is a IngestionJobStatus enum value
	IngestionJobStatusComplete = "COMPLETE"

	// IngestionJobStatusFailed is a IngestionJobStatus enum value
	IngestionJobStatusFailed = "FAILED"
)
View Source
const (
	// KnowledgeBaseStateEnabled is a KnowledgeBaseState enum value
	KnowledgeBaseStateEnabled = "ENABLED"

	// KnowledgeBaseStateDisabled is a KnowledgeBaseState enum value
	KnowledgeBaseStateDisabled = "DISABLED"
)
View Source
const (
	// KnowledgeBaseStatusCreating is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusCreating = "CREATING"

	// KnowledgeBaseStatusActive is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusActive = "ACTIVE"

	// KnowledgeBaseStatusDeleting is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusDeleting = "DELETING"

	// KnowledgeBaseStatusUpdating is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusUpdating = "UPDATING"

	// KnowledgeBaseStatusFailed is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusFailed = "FAILED"

	// KnowledgeBaseStatusDeleteUnsuccessful is a KnowledgeBaseStatus enum value
	KnowledgeBaseStatusDeleteUnsuccessful = "DELETE_UNSUCCESSFUL"
)
View Source
const (
	// KnowledgeBaseStorageTypeOpensearchServerless is a KnowledgeBaseStorageType enum value
	KnowledgeBaseStorageTypeOpensearchServerless = "OPENSEARCH_SERVERLESS"

	// KnowledgeBaseStorageTypePinecone is a KnowledgeBaseStorageType enum value
	KnowledgeBaseStorageTypePinecone = "PINECONE"

	// KnowledgeBaseStorageTypeRedisEnterpriseCloud is a KnowledgeBaseStorageType enum value
	KnowledgeBaseStorageTypeRedisEnterpriseCloud = "REDIS_ENTERPRISE_CLOUD"

	// KnowledgeBaseStorageTypeRds is a KnowledgeBaseStorageType enum value
	KnowledgeBaseStorageTypeRds = "RDS"

	// KnowledgeBaseStorageTypeMongoDbAtlas is a KnowledgeBaseStorageType enum value
	KnowledgeBaseStorageTypeMongoDbAtlas = "MONGO_DB_ATLAS"
)
View Source
const (
	// PromptStateEnabled is a PromptState enum value
	PromptStateEnabled = "ENABLED"

	// PromptStateDisabled is a PromptState enum value
	PromptStateDisabled = "DISABLED"
)
View Source
const (
	// PromptTypePreProcessing is a PromptType enum value
	PromptTypePreProcessing = "PRE_PROCESSING"

	// PromptTypeOrchestration is a PromptType enum value
	PromptTypeOrchestration = "ORCHESTRATION"

	// PromptTypePostProcessing is a PromptType enum value
	PromptTypePostProcessing = "POST_PROCESSING"

	// PromptTypeKnowledgeBaseResponseGeneration is a PromptType enum value
	PromptTypeKnowledgeBaseResponseGeneration = "KNOWLEDGE_BASE_RESPONSE_GENERATION"
)
View Source
const (
	// SortOrderAscending is a SortOrder enum value
	SortOrderAscending = "ASCENDING"

	// SortOrderDescending is a SortOrder enum value
	SortOrderDescending = "DESCENDING"
)
View Source
const (
	// TypeString is a Type enum value
	TypeString = "string"

	// TypeNumber is a Type enum value
	TypeNumber = "number"

	// TypeInteger is a Type enum value
	TypeInteger = "integer"

	// TypeBoolean is a Type enum value
	TypeBoolean = "boolean"

	// TypeArray is a Type enum value
	TypeArray = "array"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The request is denied because of missing access permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// There was a conflict performing an operation.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal server error occurred. Retry your request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource Amazon Resource Name (ARN) was not found. Check the
	// Amazon Resource Name (ARN) and try your request again.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The number of requests exceeds the service quota. Resubmit your request later.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The number of requests exceeds the limit. Resubmit your request later.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Input validation failed. Check your request parameters and retry the request.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "Bedrock Agent" // Name of service.
	EndpointsID = "bedrock-agent" // ID to lookup a service endpoint with.
	ServiceID   = "Bedrock Agent" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ActionGroupSignatureAmazonUserInput is a ActionGroupSignature enum value
	ActionGroupSignatureAmazonUserInput = "AMAZON.UserInput"
)
View Source
const (
	// CustomControlMethodReturnControl is a CustomControlMethod enum value
	CustomControlMethodReturnControl = "RETURN_CONTROL"
)
View Source
const (
	// DataSourceTypeS3 is a DataSourceType enum value
	DataSourceTypeS3 = "S3"
)
View Source
const (
	// IngestionJobFilterAttributeStatus is a IngestionJobFilterAttribute enum value
	IngestionJobFilterAttributeStatus = "STATUS"
)
View Source
const (
	// IngestionJobFilterOperatorEq is a IngestionJobFilterOperator enum value
	IngestionJobFilterOperatorEq = "EQ"
)
View Source
const (
	// KnowledgeBaseTypeVector is a KnowledgeBaseType enum value
	KnowledgeBaseTypeVector = "VECTOR"
)

Variables

This section is empty.

Functions

func ActionGroupSignature_Values

func ActionGroupSignature_Values() []string

ActionGroupSignature_Values returns all elements of the ActionGroupSignature enum

func ActionGroupState_Values

func ActionGroupState_Values() []string

ActionGroupState_Values returns all elements of the ActionGroupState enum

func AgentAliasStatus_Values

func AgentAliasStatus_Values() []string

AgentAliasStatus_Values returns all elements of the AgentAliasStatus enum

func AgentStatus_Values

func AgentStatus_Values() []string

AgentStatus_Values returns all elements of the AgentStatus enum

func ChunkingStrategy_Values

func ChunkingStrategy_Values() []string

ChunkingStrategy_Values returns all elements of the ChunkingStrategy enum

func CreationMode_Values

func CreationMode_Values() []string

CreationMode_Values returns all elements of the CreationMode enum

func CustomControlMethod_Values

func CustomControlMethod_Values() []string

CustomControlMethod_Values returns all elements of the CustomControlMethod enum

func DataDeletionPolicy_Values

func DataDeletionPolicy_Values() []string

DataDeletionPolicy_Values returns all elements of the DataDeletionPolicy enum

func DataSourceStatus_Values

func DataSourceStatus_Values() []string

DataSourceStatus_Values returns all elements of the DataSourceStatus enum

func DataSourceType_Values

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func IngestionJobFilterAttribute_Values

func IngestionJobFilterAttribute_Values() []string

IngestionJobFilterAttribute_Values returns all elements of the IngestionJobFilterAttribute enum

func IngestionJobFilterOperator_Values

func IngestionJobFilterOperator_Values() []string

IngestionJobFilterOperator_Values returns all elements of the IngestionJobFilterOperator enum

func IngestionJobSortByAttribute_Values

func IngestionJobSortByAttribute_Values() []string

IngestionJobSortByAttribute_Values returns all elements of the IngestionJobSortByAttribute enum

func IngestionJobStatus_Values

func IngestionJobStatus_Values() []string

IngestionJobStatus_Values returns all elements of the IngestionJobStatus enum

func KnowledgeBaseState_Values

func KnowledgeBaseState_Values() []string

KnowledgeBaseState_Values returns all elements of the KnowledgeBaseState enum

func KnowledgeBaseStatus_Values

func KnowledgeBaseStatus_Values() []string

KnowledgeBaseStatus_Values returns all elements of the KnowledgeBaseStatus enum

func KnowledgeBaseStorageType_Values

func KnowledgeBaseStorageType_Values() []string

KnowledgeBaseStorageType_Values returns all elements of the KnowledgeBaseStorageType enum

func KnowledgeBaseType_Values

func KnowledgeBaseType_Values() []string

KnowledgeBaseType_Values returns all elements of the KnowledgeBaseType enum

func PromptState_Values

func PromptState_Values() []string

PromptState_Values returns all elements of the PromptState enum

func PromptType_Values

func PromptType_Values() []string

PromptType_Values returns all elements of the PromptType enum

func SortOrder_Values

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func Type_Values

func Type_Values() []string

Type_Values returns all elements of the Type enum

Types

type APISchema

type APISchema struct {

	// The JSON or YAML-formatted payload defining the OpenAPI schema for the action
	// group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
	//
	// Payload is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by APISchema's
	// String and GoString methods.
	Payload *string `locationName:"payload" type:"string" sensitive:"true"`

	// Contains details about the S3 object containing the OpenAPI schema for the
	// action group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
	S3 *S3Identifier `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

func (APISchema) GoString

func (s APISchema) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APISchema) SetPayload

func (s *APISchema) SetPayload(v string) *APISchema

SetPayload sets the Payload field's value.

func (*APISchema) SetS3

func (s *APISchema) SetS3(v *S3Identifier) *APISchema

SetS3 sets the S3 field's value.

func (APISchema) String

func (s APISchema) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*APISchema) Validate

func (s *APISchema) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request is denied because of missing access permissions.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionGroupExecutor

type ActionGroupExecutor struct {

	// To return the action group invocation results directly in the InvokeAgent
	// response, specify RETURN_CONTROL.
	CustomControl *string `locationName:"customControl" type:"string" enum:"CustomControlMethod"`

	// The Amazon Resource Name (ARN) of the Lambda function containing the business
	// logic that is carried out upon invoking the action.
	Lambda *string `locationName:"lambda" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

func (ActionGroupExecutor) GoString

func (s ActionGroupExecutor) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionGroupExecutor) SetCustomControl

func (s *ActionGroupExecutor) SetCustomControl(v string) *ActionGroupExecutor

SetCustomControl sets the CustomControl field's value.

func (*ActionGroupExecutor) SetLambda

SetLambda sets the Lambda field's value.

func (ActionGroupExecutor) String

func (s ActionGroupExecutor) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionGroupSummary

type ActionGroupSummary struct {

	// The unique identifier of the action group.
	//
	// ActionGroupId is a required field
	ActionGroupId *string `locationName:"actionGroupId" type:"string" required:"true"`

	// The name of the action group.
	//
	// ActionGroupName is a required field
	ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"`

	// 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 is a required field
	ActionGroupState *string `locationName:"actionGroupState" type:"string" required:"true" enum:"ActionGroupState"`

	// The description of the action group.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The time at which the action group was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an action group.

func (ActionGroupSummary) GoString

func (s ActionGroupSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionGroupSummary) SetActionGroupId

func (s *ActionGroupSummary) SetActionGroupId(v string) *ActionGroupSummary

SetActionGroupId sets the ActionGroupId field's value.

func (*ActionGroupSummary) SetActionGroupName

func (s *ActionGroupSummary) SetActionGroupName(v string) *ActionGroupSummary

SetActionGroupName sets the ActionGroupName field's value.

func (*ActionGroupSummary) SetActionGroupState

func (s *ActionGroupSummary) SetActionGroupState(v string) *ActionGroupSummary

SetActionGroupState sets the ActionGroupState field's value.

func (*ActionGroupSummary) SetDescription

func (s *ActionGroupSummary) SetDescription(v string) *ActionGroupSummary

SetDescription sets the Description field's value.

func (*ActionGroupSummary) SetUpdatedAt

func (s *ActionGroupSummary) SetUpdatedAt(v time.Time) *ActionGroupSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (ActionGroupSummary) String

func (s ActionGroupSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Agent

type Agent struct {

	// The Amazon Resource Name (ARN) of the agent.
	//
	// AgentArn is a required field
	AgentArn *string `locationName:"agentArn" type:"string" required:"true"`

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The name of the agent.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the agent.
	//
	// AgentResourceRoleArn is a required field
	AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"`

	// The status of the agent and whether it is ready for use. The following statuses
	// are possible:
	//
	//    * CREATING – The agent is being created.
	//
	//    * PREPARING – The agent is being prepared.
	//
	//    * PREPARED – The agent is prepared and ready to be invoked.
	//
	//    * NOT_PREPARED – The agent has been created but not yet prepared.
	//
	//    * FAILED – The agent API operation failed.
	//
	//    * UPDATING – The agent is being updated.
	//
	//    * DELETING – The agent is being deleted.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// 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 `locationName:"clientToken" min:"33" type:"string"`

	// The time at which the agent was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The description of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains reasons that the agent-related API that you invoked failed.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// The foundation model used for orchestration by the agent.
	FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"`

	// The guardrails configuration assigned to the agent.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// 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 is a required field
	IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer" required:"true"`

	// Instructions that tell the agent what it should do and how it should interact
	// with users.
	//
	// Instruction is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Agent's
	// String and GoString methods.
	Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"`

	// The time at which the agent was last prepared.
	PreparedAt *time.Time `locationName:"preparedAt" type:"timestamp" timestampFormat:"iso8601"`

	// Contains configurations to override prompt templates 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Agent's
	// String and GoString methods.
	PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"`

	// Contains recommended actions to take for the agent-related API that you invoked
	// to succeed.
	RecommendedActions []*string `locationName:"recommendedActions" type:"list"`

	// The time at which the agent was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an agent.

func (Agent) GoString

func (s Agent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Agent) SetAgentArn

func (s *Agent) SetAgentArn(v string) *Agent

SetAgentArn sets the AgentArn field's value.

func (*Agent) SetAgentId

func (s *Agent) SetAgentId(v string) *Agent

SetAgentId sets the AgentId field's value.

func (*Agent) SetAgentName

func (s *Agent) SetAgentName(v string) *Agent

SetAgentName sets the AgentName field's value.

func (*Agent) SetAgentResourceRoleArn

func (s *Agent) SetAgentResourceRoleArn(v string) *Agent

SetAgentResourceRoleArn sets the AgentResourceRoleArn field's value.

func (*Agent) SetAgentStatus

func (s *Agent) SetAgentStatus(v string) *Agent

SetAgentStatus sets the AgentStatus field's value.

func (*Agent) SetAgentVersion

func (s *Agent) SetAgentVersion(v string) *Agent

SetAgentVersion sets the AgentVersion field's value.

func (*Agent) SetClientToken

func (s *Agent) SetClientToken(v string) *Agent

SetClientToken sets the ClientToken field's value.

func (*Agent) SetCreatedAt

func (s *Agent) SetCreatedAt(v time.Time) *Agent

SetCreatedAt sets the CreatedAt field's value.

func (*Agent) SetCustomerEncryptionKeyArn

func (s *Agent) SetCustomerEncryptionKeyArn(v string) *Agent

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*Agent) SetDescription

func (s *Agent) SetDescription(v string) *Agent

SetDescription sets the Description field's value.

func (*Agent) SetFailureReasons

func (s *Agent) SetFailureReasons(v []*string) *Agent

SetFailureReasons sets the FailureReasons field's value.

func (*Agent) SetFoundationModel

func (s *Agent) SetFoundationModel(v string) *Agent

SetFoundationModel sets the FoundationModel field's value.

func (*Agent) SetGuardrailConfiguration

func (s *Agent) SetGuardrailConfiguration(v *GuardrailConfiguration) *Agent

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*Agent) SetIdleSessionTTLInSeconds

func (s *Agent) SetIdleSessionTTLInSeconds(v int64) *Agent

SetIdleSessionTTLInSeconds sets the IdleSessionTTLInSeconds field's value.

func (*Agent) SetInstruction

func (s *Agent) SetInstruction(v string) *Agent

SetInstruction sets the Instruction field's value.

func (*Agent) SetPreparedAt

func (s *Agent) SetPreparedAt(v time.Time) *Agent

SetPreparedAt sets the PreparedAt field's value.

func (*Agent) SetPromptOverrideConfiguration

func (s *Agent) SetPromptOverrideConfiguration(v *PromptOverrideConfiguration) *Agent

SetPromptOverrideConfiguration sets the PromptOverrideConfiguration field's value.

func (*Agent) SetRecommendedActions

func (s *Agent) SetRecommendedActions(v []*string) *Agent

SetRecommendedActions sets the RecommendedActions field's value.

func (*Agent) SetUpdatedAt

func (s *Agent) SetUpdatedAt(v time.Time) *Agent

SetUpdatedAt sets the UpdatedAt field's value.

func (Agent) String

func (s Agent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentActionGroup

type AgentActionGroup struct {

	// 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 *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"`

	// The unique identifier of the action group.
	//
	// ActionGroupId is a required field
	ActionGroupId *string `locationName:"actionGroupId" type:"string" required:"true"`

	// The name of the action group.
	//
	// ActionGroupName is a required field
	ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"`

	// 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 is a required field
	ActionGroupState *string `locationName:"actionGroupState" type:"string" required:"true" enum:"ActionGroupState"`

	// The unique identifier of the agent to which the action group belongs.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The version of the agent to which the action group belongs.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// 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 *APISchema `locationName:"apiSchema" type:"structure"`

	// 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 `locationName:"clientToken" min:"33" type:"string"`

	// The time at which the action group was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the action group.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Defines functions that each define parameters that the agent needs to invoke
	// from the user. Each function represents an action in an action group.
	FunctionSchema *FunctionSchema `locationName:"functionSchema" type:"structure"`

	// If this field is set as AMAZON.UserInput, the agent can request the user
	// for additional information when trying to complete a task. The description,
	// apiSchema, and actionGroupExecutor fields must be blank for this action group.
	//
	// During orchestration, if the 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.
	ParentActionSignature *string `locationName:"parentActionSignature" type:"string" enum:"ActionGroupSignature"`

	// The time at which the action group was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an action group.

func (AgentActionGroup) GoString

func (s AgentActionGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentActionGroup) SetActionGroupExecutor

func (s *AgentActionGroup) SetActionGroupExecutor(v *ActionGroupExecutor) *AgentActionGroup

SetActionGroupExecutor sets the ActionGroupExecutor field's value.

func (*AgentActionGroup) SetActionGroupId

func (s *AgentActionGroup) SetActionGroupId(v string) *AgentActionGroup

SetActionGroupId sets the ActionGroupId field's value.

func (*AgentActionGroup) SetActionGroupName

func (s *AgentActionGroup) SetActionGroupName(v string) *AgentActionGroup

SetActionGroupName sets the ActionGroupName field's value.

func (*AgentActionGroup) SetActionGroupState

func (s *AgentActionGroup) SetActionGroupState(v string) *AgentActionGroup

SetActionGroupState sets the ActionGroupState field's value.

func (*AgentActionGroup) SetAgentId

func (s *AgentActionGroup) SetAgentId(v string) *AgentActionGroup

SetAgentId sets the AgentId field's value.

func (*AgentActionGroup) SetAgentVersion

func (s *AgentActionGroup) SetAgentVersion(v string) *AgentActionGroup

SetAgentVersion sets the AgentVersion field's value.

func (*AgentActionGroup) SetApiSchema

func (s *AgentActionGroup) SetApiSchema(v *APISchema) *AgentActionGroup

SetApiSchema sets the ApiSchema field's value.

func (*AgentActionGroup) SetClientToken

func (s *AgentActionGroup) SetClientToken(v string) *AgentActionGroup

SetClientToken sets the ClientToken field's value.

func (*AgentActionGroup) SetCreatedAt

func (s *AgentActionGroup) SetCreatedAt(v time.Time) *AgentActionGroup

SetCreatedAt sets the CreatedAt field's value.

func (*AgentActionGroup) SetDescription

func (s *AgentActionGroup) SetDescription(v string) *AgentActionGroup

SetDescription sets the Description field's value.

func (*AgentActionGroup) SetFunctionSchema

func (s *AgentActionGroup) SetFunctionSchema(v *FunctionSchema) *AgentActionGroup

SetFunctionSchema sets the FunctionSchema field's value.

func (*AgentActionGroup) SetParentActionSignature

func (s *AgentActionGroup) SetParentActionSignature(v string) *AgentActionGroup

SetParentActionSignature sets the ParentActionSignature field's value.

func (*AgentActionGroup) SetUpdatedAt

func (s *AgentActionGroup) SetUpdatedAt(v time.Time) *AgentActionGroup

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentActionGroup) String

func (s AgentActionGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentAlias

type AgentAlias struct {

	// The Amazon Resource Name (ARN) of the alias of the agent.
	//
	// AgentAliasArn is a required field
	AgentAliasArn *string `locationName:"agentAliasArn" type:"string" required:"true"`

	// Contains details about the history of the alias.
	AgentAliasHistoryEvents []*AgentAliasHistoryEvent `locationName:"agentAliasHistoryEvents" type:"list"`

	// The unique identifier of the alias of the agent.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// The name of the alias of the agent.
	//
	// AgentAliasName is a required field
	AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"`

	// The status of the alias of the agent and whether it is ready for use. The
	// following statuses are possible:
	//
	//    * CREATING – The agent alias is being created.
	//
	//    * PREPARED – The agent alias is finished being created or updated and
	//    is ready to be invoked.
	//
	//    * FAILED – The agent alias API operation failed.
	//
	//    * UPDATING – The agent alias is being updated.
	//
	//    * DELETING – The agent alias is being deleted.
	//
	// AgentAliasStatus is a required field
	AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"`

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// 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 `locationName:"clientToken" min:"33" type:"string"`

	// The time at which the alias of the agent was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the alias of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Information on the failure of Provisioned Throughput assigned to an agent
	// alias.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// Contains details about the routing configuration of the alias.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list" required:"true"`

	// The time at which the alias was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an alias of an agent.

func (AgentAlias) GoString

func (s AgentAlias) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentAlias) SetAgentAliasArn

func (s *AgentAlias) SetAgentAliasArn(v string) *AgentAlias

SetAgentAliasArn sets the AgentAliasArn field's value.

func (*AgentAlias) SetAgentAliasHistoryEvents

func (s *AgentAlias) SetAgentAliasHistoryEvents(v []*AgentAliasHistoryEvent) *AgentAlias

SetAgentAliasHistoryEvents sets the AgentAliasHistoryEvents field's value.

func (*AgentAlias) SetAgentAliasId

func (s *AgentAlias) SetAgentAliasId(v string) *AgentAlias

SetAgentAliasId sets the AgentAliasId field's value.

func (*AgentAlias) SetAgentAliasName

func (s *AgentAlias) SetAgentAliasName(v string) *AgentAlias

SetAgentAliasName sets the AgentAliasName field's value.

func (*AgentAlias) SetAgentAliasStatus

func (s *AgentAlias) SetAgentAliasStatus(v string) *AgentAlias

SetAgentAliasStatus sets the AgentAliasStatus field's value.

func (*AgentAlias) SetAgentId

func (s *AgentAlias) SetAgentId(v string) *AgentAlias

SetAgentId sets the AgentId field's value.

func (*AgentAlias) SetClientToken

func (s *AgentAlias) SetClientToken(v string) *AgentAlias

SetClientToken sets the ClientToken field's value.

func (*AgentAlias) SetCreatedAt

func (s *AgentAlias) SetCreatedAt(v time.Time) *AgentAlias

SetCreatedAt sets the CreatedAt field's value.

func (*AgentAlias) SetDescription

func (s *AgentAlias) SetDescription(v string) *AgentAlias

SetDescription sets the Description field's value.

func (*AgentAlias) SetFailureReasons

func (s *AgentAlias) SetFailureReasons(v []*string) *AgentAlias

SetFailureReasons sets the FailureReasons field's value.

func (*AgentAlias) SetRoutingConfiguration

func (s *AgentAlias) SetRoutingConfiguration(v []*AgentAliasRoutingConfigurationListItem) *AgentAlias

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*AgentAlias) SetUpdatedAt

func (s *AgentAlias) SetUpdatedAt(v time.Time) *AgentAlias

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentAlias) String

func (s AgentAlias) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentAliasHistoryEvent

type AgentAliasHistoryEvent struct {

	// The date that the alias stopped being associated to the version in the routingConfiguration
	// object
	EndDate *time.Time `locationName:"endDate" type:"timestamp" timestampFormat:"iso8601"`

	// Contains details about the version of the agent with which the alias is associated.
	RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"`

	// The date that the alias began being associated to the version in the routingConfiguration
	// object.
	StartDate *time.Time `locationName:"startDate" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Contains details about the history of the alias.

func (AgentAliasHistoryEvent) GoString

func (s AgentAliasHistoryEvent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentAliasHistoryEvent) SetEndDate

SetEndDate sets the EndDate field's value.

func (*AgentAliasHistoryEvent) SetRoutingConfiguration

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*AgentAliasHistoryEvent) SetStartDate

SetStartDate sets the StartDate field's value.

func (AgentAliasHistoryEvent) String

func (s AgentAliasHistoryEvent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentAliasRoutingConfigurationListItem

type AgentAliasRoutingConfigurationListItem struct {

	// The version of the agent with which the alias is associated.
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string"`

	// Information on the Provisioned Throughput assigned to an agent alias.
	ProvisionedThroughput *string `locationName:"provisionedThroughput" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the routing configuration of the alias.

func (AgentAliasRoutingConfigurationListItem) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentAliasRoutingConfigurationListItem) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*AgentAliasRoutingConfigurationListItem) SetProvisionedThroughput

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (AgentAliasRoutingConfigurationListItem) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentAliasRoutingConfigurationListItem) Validate

Validate inspects the fields of the type to determine if they are valid.

type AgentAliasSummary

type AgentAliasSummary struct {

	// Contains details about
	//
	// AgentAliasId is a required field
	AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// The name of the alias.
	//
	// AgentAliasName is a required field
	AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"`

	// The status of the alias.
	//
	// AgentAliasStatus is a required field
	AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"`

	// The time at which the alias of the agent was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the alias.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the version of the agent with which the alias is associated.
	RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"`

	// The time at which the alias was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an alias of an agent.

func (AgentAliasSummary) GoString

func (s AgentAliasSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentAliasSummary) SetAgentAliasId

func (s *AgentAliasSummary) SetAgentAliasId(v string) *AgentAliasSummary

SetAgentAliasId sets the AgentAliasId field's value.

func (*AgentAliasSummary) SetAgentAliasName

func (s *AgentAliasSummary) SetAgentAliasName(v string) *AgentAliasSummary

SetAgentAliasName sets the AgentAliasName field's value.

func (*AgentAliasSummary) SetAgentAliasStatus

func (s *AgentAliasSummary) SetAgentAliasStatus(v string) *AgentAliasSummary

SetAgentAliasStatus sets the AgentAliasStatus field's value.

func (*AgentAliasSummary) SetCreatedAt

func (s *AgentAliasSummary) SetCreatedAt(v time.Time) *AgentAliasSummary

SetCreatedAt sets the CreatedAt field's value.

func (*AgentAliasSummary) SetDescription

func (s *AgentAliasSummary) SetDescription(v string) *AgentAliasSummary

SetDescription sets the Description field's value.

func (*AgentAliasSummary) SetRoutingConfiguration

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*AgentAliasSummary) SetUpdatedAt

func (s *AgentAliasSummary) SetUpdatedAt(v time.Time) *AgentAliasSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentAliasSummary) String

func (s AgentAliasSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentKnowledgeBase

type AgentKnowledgeBase struct {

	// The unique identifier of the agent with which the knowledge base is associated.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The version of the agent with which the knowledge base is associated.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// The time at which the association between the agent and the knowledge base
	// was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the association between the agent and the knowledge base.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`

	// The unique identifier of the association between the agent and the knowledge
	// base.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 is a required field
	KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" required:"true" enum:"KnowledgeBaseState"`

	// The time at which the association between the agent and the knowledge base
	// was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

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

func (AgentKnowledgeBase) GoString

func (s AgentKnowledgeBase) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentKnowledgeBase) SetAgentId

func (s *AgentKnowledgeBase) SetAgentId(v string) *AgentKnowledgeBase

SetAgentId sets the AgentId field's value.

func (*AgentKnowledgeBase) SetAgentVersion

func (s *AgentKnowledgeBase) SetAgentVersion(v string) *AgentKnowledgeBase

SetAgentVersion sets the AgentVersion field's value.

func (*AgentKnowledgeBase) SetCreatedAt

func (s *AgentKnowledgeBase) SetCreatedAt(v time.Time) *AgentKnowledgeBase

SetCreatedAt sets the CreatedAt field's value.

func (*AgentKnowledgeBase) SetDescription

func (s *AgentKnowledgeBase) SetDescription(v string) *AgentKnowledgeBase

SetDescription sets the Description field's value.

func (*AgentKnowledgeBase) SetKnowledgeBaseId

func (s *AgentKnowledgeBase) SetKnowledgeBaseId(v string) *AgentKnowledgeBase

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*AgentKnowledgeBase) SetKnowledgeBaseState

func (s *AgentKnowledgeBase) SetKnowledgeBaseState(v string) *AgentKnowledgeBase

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (*AgentKnowledgeBase) SetUpdatedAt

func (s *AgentKnowledgeBase) SetUpdatedAt(v time.Time) *AgentKnowledgeBase

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentKnowledgeBase) String

func (s AgentKnowledgeBase) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentKnowledgeBaseSummary

type AgentKnowledgeBaseSummary struct {

	// The description of the knowledge base associated with an agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base associated with an agent.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 is a required field
	KnowledgeBaseState *string `locationName:"knowledgeBaseState" type:"string" required:"true" enum:"KnowledgeBaseState"`

	// The time at which the knowledge base associated with an agent was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a knowledge base associated with an agent.

func (AgentKnowledgeBaseSummary) GoString

func (s AgentKnowledgeBaseSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentKnowledgeBaseSummary) SetDescription

SetDescription sets the Description field's value.

func (*AgentKnowledgeBaseSummary) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*AgentKnowledgeBaseSummary) SetKnowledgeBaseState

func (s *AgentKnowledgeBaseSummary) SetKnowledgeBaseState(v string) *AgentKnowledgeBaseSummary

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (*AgentKnowledgeBaseSummary) SetUpdatedAt

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentKnowledgeBaseSummary) String

func (s AgentKnowledgeBaseSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentSummary

type AgentSummary struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The name of the agent.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The status of the agent.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The description of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The details of the guardrails configuration in the agent summary.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// The latest version of the agent.
	LatestAgentVersion *string `locationName:"latestAgentVersion" min:"1" type:"string"`

	// The time at which the agent was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an agent.

func (AgentSummary) GoString

func (s AgentSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentSummary) SetAgentId

func (s *AgentSummary) SetAgentId(v string) *AgentSummary

SetAgentId sets the AgentId field's value.

func (*AgentSummary) SetAgentName

func (s *AgentSummary) SetAgentName(v string) *AgentSummary

SetAgentName sets the AgentName field's value.

func (*AgentSummary) SetAgentStatus

func (s *AgentSummary) SetAgentStatus(v string) *AgentSummary

SetAgentStatus sets the AgentStatus field's value.

func (*AgentSummary) SetDescription

func (s *AgentSummary) SetDescription(v string) *AgentSummary

SetDescription sets the Description field's value.

func (*AgentSummary) SetGuardrailConfiguration

func (s *AgentSummary) SetGuardrailConfiguration(v *GuardrailConfiguration) *AgentSummary

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*AgentSummary) SetLatestAgentVersion

func (s *AgentSummary) SetLatestAgentVersion(v string) *AgentSummary

SetLatestAgentVersion sets the LatestAgentVersion field's value.

func (*AgentSummary) SetUpdatedAt

func (s *AgentSummary) SetUpdatedAt(v time.Time) *AgentSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentSummary) String

func (s AgentSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentVersion

type AgentVersion struct {

	// The Amazon Resource Name (ARN) of the agent that the version belongs to.
	//
	// AgentArn is a required field
	AgentArn *string `locationName:"agentArn" type:"string" required:"true"`

	// The unique identifier of the agent that the version belongs to.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The name of the agent that the version belongs to.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the agent.
	//
	// AgentResourceRoleArn is a required field
	AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"`

	// The status of the agent that the version belongs to.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The time at which the version was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The description of the version.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A list of reasons that the API operation on the version failed.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// The foundation model that the version invokes.
	FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"`

	// The guardrails configuration assigned to the agent version.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// 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 is a required field
	IdleSessionTTLInSeconds *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer" required:"true"`

	// The instructions provided to the agent.
	//
	// Instruction is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AgentVersion's
	// String and GoString methods.
	Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"`

	// Contains configurations to override prompt templates 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by AgentVersion's
	// String and GoString methods.
	PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"`

	// A list of recommended actions to take for the failed API operation on the
	// version to succeed.
	RecommendedActions []*string `locationName:"recommendedActions" type:"list"`

	// The time at which the version was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The version number.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a version of an agent.

func (AgentVersion) GoString

func (s AgentVersion) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentVersion) SetAgentArn

func (s *AgentVersion) SetAgentArn(v string) *AgentVersion

SetAgentArn sets the AgentArn field's value.

func (*AgentVersion) SetAgentId

func (s *AgentVersion) SetAgentId(v string) *AgentVersion

SetAgentId sets the AgentId field's value.

func (*AgentVersion) SetAgentName

func (s *AgentVersion) SetAgentName(v string) *AgentVersion

SetAgentName sets the AgentName field's value.

func (*AgentVersion) SetAgentResourceRoleArn

func (s *AgentVersion) SetAgentResourceRoleArn(v string) *AgentVersion

SetAgentResourceRoleArn sets the AgentResourceRoleArn field's value.

func (*AgentVersion) SetAgentStatus

func (s *AgentVersion) SetAgentStatus(v string) *AgentVersion

SetAgentStatus sets the AgentStatus field's value.

func (*AgentVersion) SetCreatedAt

func (s *AgentVersion) SetCreatedAt(v time.Time) *AgentVersion

SetCreatedAt sets the CreatedAt field's value.

func (*AgentVersion) SetCustomerEncryptionKeyArn

func (s *AgentVersion) SetCustomerEncryptionKeyArn(v string) *AgentVersion

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*AgentVersion) SetDescription

func (s *AgentVersion) SetDescription(v string) *AgentVersion

SetDescription sets the Description field's value.

func (*AgentVersion) SetFailureReasons

func (s *AgentVersion) SetFailureReasons(v []*string) *AgentVersion

SetFailureReasons sets the FailureReasons field's value.

func (*AgentVersion) SetFoundationModel

func (s *AgentVersion) SetFoundationModel(v string) *AgentVersion

SetFoundationModel sets the FoundationModel field's value.

func (*AgentVersion) SetGuardrailConfiguration

func (s *AgentVersion) SetGuardrailConfiguration(v *GuardrailConfiguration) *AgentVersion

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*AgentVersion) SetIdleSessionTTLInSeconds

func (s *AgentVersion) SetIdleSessionTTLInSeconds(v int64) *AgentVersion

SetIdleSessionTTLInSeconds sets the IdleSessionTTLInSeconds field's value.

func (*AgentVersion) SetInstruction

func (s *AgentVersion) SetInstruction(v string) *AgentVersion

SetInstruction sets the Instruction field's value.

func (*AgentVersion) SetPromptOverrideConfiguration

func (s *AgentVersion) SetPromptOverrideConfiguration(v *PromptOverrideConfiguration) *AgentVersion

SetPromptOverrideConfiguration sets the PromptOverrideConfiguration field's value.

func (*AgentVersion) SetRecommendedActions

func (s *AgentVersion) SetRecommendedActions(v []*string) *AgentVersion

SetRecommendedActions sets the RecommendedActions field's value.

func (*AgentVersion) SetUpdatedAt

func (s *AgentVersion) SetUpdatedAt(v time.Time) *AgentVersion

SetUpdatedAt sets the UpdatedAt field's value.

func (*AgentVersion) SetVersion

func (s *AgentVersion) SetVersion(v string) *AgentVersion

SetVersion sets the Version field's value.

func (AgentVersion) String

func (s AgentVersion) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AgentVersionSummary

type AgentVersionSummary struct {

	// The name of the agent to which the version belongs.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The status of the agent to which the version belongs.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// The time at which the version was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the version of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The details of the guardrails configuration in the agent version summary.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// The time at which the version was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a version of an agent.

func (AgentVersionSummary) GoString

func (s AgentVersionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AgentVersionSummary) SetAgentName

func (s *AgentVersionSummary) SetAgentName(v string) *AgentVersionSummary

SetAgentName sets the AgentName field's value.

func (*AgentVersionSummary) SetAgentStatus

func (s *AgentVersionSummary) SetAgentStatus(v string) *AgentVersionSummary

SetAgentStatus sets the AgentStatus field's value.

func (*AgentVersionSummary) SetAgentVersion

func (s *AgentVersionSummary) SetAgentVersion(v string) *AgentVersionSummary

SetAgentVersion sets the AgentVersion field's value.

func (*AgentVersionSummary) SetCreatedAt

func (s *AgentVersionSummary) SetCreatedAt(v time.Time) *AgentVersionSummary

SetCreatedAt sets the CreatedAt field's value.

func (*AgentVersionSummary) SetDescription

func (s *AgentVersionSummary) SetDescription(v string) *AgentVersionSummary

SetDescription sets the Description field's value.

func (*AgentVersionSummary) SetGuardrailConfiguration

func (s *AgentVersionSummary) SetGuardrailConfiguration(v *GuardrailConfiguration) *AgentVersionSummary

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*AgentVersionSummary) SetUpdatedAt

func (s *AgentVersionSummary) SetUpdatedAt(v time.Time) *AgentVersionSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (AgentVersionSummary) String

func (s AgentVersionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateAgentKnowledgeBaseInput

type AssociateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent with which you want to associate the knowledge
	// base.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent with which you want to associate the knowledge base.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// A description of what the agent should use the knowledge base for.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`

	// The unique identifier of the knowledge base to associate with the agent.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 *string `locationName:"knowledgeBaseState" type:"string" enum:"KnowledgeBaseState"`
	// contains filtered or unexported fields
}

func (AssociateAgentKnowledgeBaseInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateAgentKnowledgeBaseInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*AssociateAgentKnowledgeBaseInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*AssociateAgentKnowledgeBaseInput) SetDescription

SetDescription sets the Description field's value.

func (*AssociateAgentKnowledgeBaseInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*AssociateAgentKnowledgeBaseInput) SetKnowledgeBaseState

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (AssociateAgentKnowledgeBaseInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateAgentKnowledgeBaseInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type AssociateAgentKnowledgeBaseOutput

type AssociateAgentKnowledgeBaseOutput struct {

	// Contains details about the knowledge base that has been associated with the
	// agent.
	//
	// AgentKnowledgeBase is a required field
	AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateAgentKnowledgeBaseOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (AssociateAgentKnowledgeBaseOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BedrockAgent

type BedrockAgent struct {
	*client.Client
}

BedrockAgent provides the API operation methods for making requests to Agents for Amazon Bedrock. See this package's package overview docs for details on the service.

BedrockAgent methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *BedrockAgent

New creates a new instance of the BedrockAgent client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a BedrockAgent client from just a session.
svc := bedrockagent.New(mySession)

// Create a BedrockAgent client with additional configuration
svc := bedrockagent.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*BedrockAgent) AssociateAgentKnowledgeBase

func (c *BedrockAgent) AssociateAgentKnowledgeBase(input *AssociateAgentKnowledgeBaseInput) (*AssociateAgentKnowledgeBaseOutput, error)

AssociateAgentKnowledgeBase API operation for Agents for Amazon Bedrock.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation AssociateAgentKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase

func (*BedrockAgent) AssociateAgentKnowledgeBaseRequest

func (c *BedrockAgent) AssociateAgentKnowledgeBaseRequest(input *AssociateAgentKnowledgeBaseInput) (req *request.Request, output *AssociateAgentKnowledgeBaseOutput)

AssociateAgentKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the AssociateAgentKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateAgentKnowledgeBase for more information on using the AssociateAgentKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateAgentKnowledgeBaseRequest method.
req, resp := client.AssociateAgentKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase

func (*BedrockAgent) AssociateAgentKnowledgeBaseWithContext

func (c *BedrockAgent) AssociateAgentKnowledgeBaseWithContext(ctx aws.Context, input *AssociateAgentKnowledgeBaseInput, opts ...request.Option) (*AssociateAgentKnowledgeBaseOutput, error)

AssociateAgentKnowledgeBaseWithContext is the same as AssociateAgentKnowledgeBase with the addition of the ability to pass a context and additional request options.

See AssociateAgentKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) CreateAgent

func (c *BedrockAgent) CreateAgent(input *CreateAgentInput) (*CreateAgentOutput, error)

CreateAgent API operation for Agents for Amazon Bedrock.

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 (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation CreateAgent for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgent

func (*BedrockAgent) CreateAgentActionGroup

func (c *BedrockAgent) CreateAgentActionGroup(input *CreateAgentActionGroupInput) (*CreateAgentActionGroupOutput, error)

CreateAgentActionGroup API operation for Agents for Amazon Bedrock.

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 Observation (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation CreateAgentActionGroup for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroup

func (*BedrockAgent) CreateAgentActionGroupRequest

func (c *BedrockAgent) CreateAgentActionGroupRequest(input *CreateAgentActionGroupInput) (req *request.Request, output *CreateAgentActionGroupOutput)

CreateAgentActionGroupRequest generates a "aws/request.Request" representing the client's request for the CreateAgentActionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAgentActionGroup for more information on using the CreateAgentActionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAgentActionGroupRequest method.
req, resp := client.CreateAgentActionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroup

func (*BedrockAgent) CreateAgentActionGroupWithContext

func (c *BedrockAgent) CreateAgentActionGroupWithContext(ctx aws.Context, input *CreateAgentActionGroupInput, opts ...request.Option) (*CreateAgentActionGroupOutput, error)

CreateAgentActionGroupWithContext is the same as CreateAgentActionGroup with the addition of the ability to pass a context and additional request options.

See CreateAgentActionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) CreateAgentAlias

func (c *BedrockAgent) CreateAgentAlias(input *CreateAgentAliasInput) (*CreateAgentAliasOutput, error)

CreateAgentAlias API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation CreateAgentAlias for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAlias

func (*BedrockAgent) CreateAgentAliasRequest

func (c *BedrockAgent) CreateAgentAliasRequest(input *CreateAgentAliasInput) (req *request.Request, output *CreateAgentAliasOutput)

CreateAgentAliasRequest generates a "aws/request.Request" representing the client's request for the CreateAgentAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAgentAlias for more information on using the CreateAgentAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAgentAliasRequest method.
req, resp := client.CreateAgentAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAlias

func (*BedrockAgent) CreateAgentAliasWithContext

func (c *BedrockAgent) CreateAgentAliasWithContext(ctx aws.Context, input *CreateAgentAliasInput, opts ...request.Option) (*CreateAgentAliasOutput, error)

CreateAgentAliasWithContext is the same as CreateAgentAlias with the addition of the ability to pass a context and additional request options.

See CreateAgentAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) CreateAgentRequest

func (c *BedrockAgent) CreateAgentRequest(input *CreateAgentInput) (req *request.Request, output *CreateAgentOutput)

CreateAgentRequest generates a "aws/request.Request" representing the client's request for the CreateAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAgent for more information on using the CreateAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAgentRequest method.
req, resp := client.CreateAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgent

func (*BedrockAgent) CreateAgentWithContext

func (c *BedrockAgent) CreateAgentWithContext(ctx aws.Context, input *CreateAgentInput, opts ...request.Option) (*CreateAgentOutput, error)

CreateAgentWithContext is the same as CreateAgent with the addition of the ability to pass a context and additional request options.

See CreateAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) CreateDataSource

func (c *BedrockAgent) CreateDataSource(input *CreateDataSourceInput) (*CreateDataSourceOutput, error)

CreateDataSource API operation for Agents for Amazon Bedrock.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation CreateDataSource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSource

func (*BedrockAgent) CreateDataSourceRequest

func (c *BedrockAgent) CreateDataSourceRequest(input *CreateDataSourceInput) (req *request.Request, output *CreateDataSourceOutput)

CreateDataSourceRequest generates a "aws/request.Request" representing the client's request for the CreateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDataSource for more information on using the CreateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDataSourceRequest method.
req, resp := client.CreateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSource

func (*BedrockAgent) CreateDataSourceWithContext

func (c *BedrockAgent) CreateDataSourceWithContext(ctx aws.Context, input *CreateDataSourceInput, opts ...request.Option) (*CreateDataSourceOutput, error)

CreateDataSourceWithContext is the same as CreateDataSource with the addition of the ability to pass a context and additional request options.

See CreateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) CreateKnowledgeBase

func (c *BedrockAgent) CreateKnowledgeBase(input *CreateKnowledgeBaseInput) (*CreateKnowledgeBaseOutput, error)

CreateKnowledgeBase API operation for Agents for Amazon Bedrock.

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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html).

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 (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation CreateKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBase

func (*BedrockAgent) CreateKnowledgeBaseRequest

func (c *BedrockAgent) CreateKnowledgeBaseRequest(input *CreateKnowledgeBaseInput) (req *request.Request, output *CreateKnowledgeBaseOutput)

CreateKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the CreateKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKnowledgeBase for more information on using the CreateKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateKnowledgeBaseRequest method.
req, resp := client.CreateKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBase

func (*BedrockAgent) CreateKnowledgeBaseWithContext

func (c *BedrockAgent) CreateKnowledgeBaseWithContext(ctx aws.Context, input *CreateKnowledgeBaseInput, opts ...request.Option) (*CreateKnowledgeBaseOutput, error)

CreateKnowledgeBaseWithContext is the same as CreateKnowledgeBase with the addition of the ability to pass a context and additional request options.

See CreateKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteAgent

func (c *BedrockAgent) DeleteAgent(input *DeleteAgentInput) (*DeleteAgentOutput, error)

DeleteAgent API operation for Agents for Amazon Bedrock.

Deletes an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteAgent for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgent

func (*BedrockAgent) DeleteAgentActionGroup

func (c *BedrockAgent) DeleteAgentActionGroup(input *DeleteAgentActionGroupInput) (*DeleteAgentActionGroupOutput, error)

DeleteAgentActionGroup API operation for Agents for Amazon Bedrock.

Deletes an action group in an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteAgentActionGroup for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroup

func (*BedrockAgent) DeleteAgentActionGroupRequest

func (c *BedrockAgent) DeleteAgentActionGroupRequest(input *DeleteAgentActionGroupInput) (req *request.Request, output *DeleteAgentActionGroupOutput)

DeleteAgentActionGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteAgentActionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAgentActionGroup for more information on using the DeleteAgentActionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAgentActionGroupRequest method.
req, resp := client.DeleteAgentActionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroup

func (*BedrockAgent) DeleteAgentActionGroupWithContext

func (c *BedrockAgent) DeleteAgentActionGroupWithContext(ctx aws.Context, input *DeleteAgentActionGroupInput, opts ...request.Option) (*DeleteAgentActionGroupOutput, error)

DeleteAgentActionGroupWithContext is the same as DeleteAgentActionGroup with the addition of the ability to pass a context and additional request options.

See DeleteAgentActionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteAgentAlias

func (c *BedrockAgent) DeleteAgentAlias(input *DeleteAgentAliasInput) (*DeleteAgentAliasOutput, error)

DeleteAgentAlias API operation for Agents for Amazon Bedrock.

Deletes an alias of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteAgentAlias for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAlias

func (*BedrockAgent) DeleteAgentAliasRequest

func (c *BedrockAgent) DeleteAgentAliasRequest(input *DeleteAgentAliasInput) (req *request.Request, output *DeleteAgentAliasOutput)

DeleteAgentAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteAgentAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAgentAlias for more information on using the DeleteAgentAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAgentAliasRequest method.
req, resp := client.DeleteAgentAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAlias

func (*BedrockAgent) DeleteAgentAliasWithContext

func (c *BedrockAgent) DeleteAgentAliasWithContext(ctx aws.Context, input *DeleteAgentAliasInput, opts ...request.Option) (*DeleteAgentAliasOutput, error)

DeleteAgentAliasWithContext is the same as DeleteAgentAlias with the addition of the ability to pass a context and additional request options.

See DeleteAgentAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteAgentRequest

func (c *BedrockAgent) DeleteAgentRequest(input *DeleteAgentInput) (req *request.Request, output *DeleteAgentOutput)

DeleteAgentRequest generates a "aws/request.Request" representing the client's request for the DeleteAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAgent for more information on using the DeleteAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAgentRequest method.
req, resp := client.DeleteAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgent

func (*BedrockAgent) DeleteAgentVersion

func (c *BedrockAgent) DeleteAgentVersion(input *DeleteAgentVersionInput) (*DeleteAgentVersionOutput, error)

DeleteAgentVersion API operation for Agents for Amazon Bedrock.

Deletes a version of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteAgentVersion for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersion

func (*BedrockAgent) DeleteAgentVersionRequest

func (c *BedrockAgent) DeleteAgentVersionRequest(input *DeleteAgentVersionInput) (req *request.Request, output *DeleteAgentVersionOutput)

DeleteAgentVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteAgentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAgentVersion for more information on using the DeleteAgentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAgentVersionRequest method.
req, resp := client.DeleteAgentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersion

func (*BedrockAgent) DeleteAgentVersionWithContext

func (c *BedrockAgent) DeleteAgentVersionWithContext(ctx aws.Context, input *DeleteAgentVersionInput, opts ...request.Option) (*DeleteAgentVersionOutput, error)

DeleteAgentVersionWithContext is the same as DeleteAgentVersion with the addition of the ability to pass a context and additional request options.

See DeleteAgentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteAgentWithContext

func (c *BedrockAgent) DeleteAgentWithContext(ctx aws.Context, input *DeleteAgentInput, opts ...request.Option) (*DeleteAgentOutput, error)

DeleteAgentWithContext is the same as DeleteAgent with the addition of the ability to pass a context and additional request options.

See DeleteAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteDataSource

func (c *BedrockAgent) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error)

DeleteDataSource API operation for Agents for Amazon Bedrock.

Deletes a data source from a knowledge base.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteDataSource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSource

func (*BedrockAgent) DeleteDataSourceRequest

func (c *BedrockAgent) DeleteDataSourceRequest(input *DeleteDataSourceInput) (req *request.Request, output *DeleteDataSourceOutput)

DeleteDataSourceRequest generates a "aws/request.Request" representing the client's request for the DeleteDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDataSource for more information on using the DeleteDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDataSourceRequest method.
req, resp := client.DeleteDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSource

func (*BedrockAgent) DeleteDataSourceWithContext

func (c *BedrockAgent) DeleteDataSourceWithContext(ctx aws.Context, input *DeleteDataSourceInput, opts ...request.Option) (*DeleteDataSourceOutput, error)

DeleteDataSourceWithContext is the same as DeleteDataSource with the addition of the ability to pass a context and additional request options.

See DeleteDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DeleteKnowledgeBase

func (c *BedrockAgent) DeleteKnowledgeBase(input *DeleteKnowledgeBaseInput) (*DeleteKnowledgeBaseOutput, error)

DeleteKnowledgeBase API operation for Agents for Amazon Bedrock.

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 DisassociateAgentKnowledgeBase (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html) request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DeleteKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBase

func (*BedrockAgent) DeleteKnowledgeBaseRequest

func (c *BedrockAgent) DeleteKnowledgeBaseRequest(input *DeleteKnowledgeBaseInput) (req *request.Request, output *DeleteKnowledgeBaseOutput)

DeleteKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the DeleteKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKnowledgeBase for more information on using the DeleteKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteKnowledgeBaseRequest method.
req, resp := client.DeleteKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBase

func (*BedrockAgent) DeleteKnowledgeBaseWithContext

func (c *BedrockAgent) DeleteKnowledgeBaseWithContext(ctx aws.Context, input *DeleteKnowledgeBaseInput, opts ...request.Option) (*DeleteKnowledgeBaseOutput, error)

DeleteKnowledgeBaseWithContext is the same as DeleteKnowledgeBase with the addition of the ability to pass a context and additional request options.

See DeleteKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) DisassociateAgentKnowledgeBase

DisassociateAgentKnowledgeBase API operation for Agents for Amazon Bedrock.

Disassociates a knowledge base from an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation DisassociateAgentKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase

func (*BedrockAgent) DisassociateAgentKnowledgeBaseRequest

func (c *BedrockAgent) DisassociateAgentKnowledgeBaseRequest(input *DisassociateAgentKnowledgeBaseInput) (req *request.Request, output *DisassociateAgentKnowledgeBaseOutput)

DisassociateAgentKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the DisassociateAgentKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateAgentKnowledgeBase for more information on using the DisassociateAgentKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateAgentKnowledgeBaseRequest method.
req, resp := client.DisassociateAgentKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase

func (*BedrockAgent) DisassociateAgentKnowledgeBaseWithContext

func (c *BedrockAgent) DisassociateAgentKnowledgeBaseWithContext(ctx aws.Context, input *DisassociateAgentKnowledgeBaseInput, opts ...request.Option) (*DisassociateAgentKnowledgeBaseOutput, error)

DisassociateAgentKnowledgeBaseWithContext is the same as DisassociateAgentKnowledgeBase with the addition of the ability to pass a context and additional request options.

See DisassociateAgentKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetAgent

func (c *BedrockAgent) GetAgent(input *GetAgentInput) (*GetAgentOutput, error)

GetAgent API operation for Agents for Amazon Bedrock.

Gets information about an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetAgent for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgent

func (*BedrockAgent) GetAgentActionGroup

func (c *BedrockAgent) GetAgentActionGroup(input *GetAgentActionGroupInput) (*GetAgentActionGroupOutput, error)

GetAgentActionGroup API operation for Agents for Amazon Bedrock.

Gets information about an action group for an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetAgentActionGroup for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroup

func (*BedrockAgent) GetAgentActionGroupRequest

func (c *BedrockAgent) GetAgentActionGroupRequest(input *GetAgentActionGroupInput) (req *request.Request, output *GetAgentActionGroupOutput)

GetAgentActionGroupRequest generates a "aws/request.Request" representing the client's request for the GetAgentActionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgentActionGroup for more information on using the GetAgentActionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAgentActionGroupRequest method.
req, resp := client.GetAgentActionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroup

func (*BedrockAgent) GetAgentActionGroupWithContext

func (c *BedrockAgent) GetAgentActionGroupWithContext(ctx aws.Context, input *GetAgentActionGroupInput, opts ...request.Option) (*GetAgentActionGroupOutput, error)

GetAgentActionGroupWithContext is the same as GetAgentActionGroup with the addition of the ability to pass a context and additional request options.

See GetAgentActionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetAgentAlias

func (c *BedrockAgent) GetAgentAlias(input *GetAgentAliasInput) (*GetAgentAliasOutput, error)

GetAgentAlias API operation for Agents for Amazon Bedrock.

Gets information about an alias of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetAgentAlias for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAlias

func (*BedrockAgent) GetAgentAliasRequest

func (c *BedrockAgent) GetAgentAliasRequest(input *GetAgentAliasInput) (req *request.Request, output *GetAgentAliasOutput)

GetAgentAliasRequest generates a "aws/request.Request" representing the client's request for the GetAgentAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgentAlias for more information on using the GetAgentAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAgentAliasRequest method.
req, resp := client.GetAgentAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAlias

func (*BedrockAgent) GetAgentAliasWithContext

func (c *BedrockAgent) GetAgentAliasWithContext(ctx aws.Context, input *GetAgentAliasInput, opts ...request.Option) (*GetAgentAliasOutput, error)

GetAgentAliasWithContext is the same as GetAgentAlias with the addition of the ability to pass a context and additional request options.

See GetAgentAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetAgentKnowledgeBase

func (c *BedrockAgent) GetAgentKnowledgeBase(input *GetAgentKnowledgeBaseInput) (*GetAgentKnowledgeBaseOutput, error)

GetAgentKnowledgeBase API operation for Agents for Amazon Bedrock.

Gets information about a knowledge base associated with an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetAgentKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBase

func (*BedrockAgent) GetAgentKnowledgeBaseRequest

func (c *BedrockAgent) GetAgentKnowledgeBaseRequest(input *GetAgentKnowledgeBaseInput) (req *request.Request, output *GetAgentKnowledgeBaseOutput)

GetAgentKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the GetAgentKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgentKnowledgeBase for more information on using the GetAgentKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAgentKnowledgeBaseRequest method.
req, resp := client.GetAgentKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBase

func (*BedrockAgent) GetAgentKnowledgeBaseWithContext

func (c *BedrockAgent) GetAgentKnowledgeBaseWithContext(ctx aws.Context, input *GetAgentKnowledgeBaseInput, opts ...request.Option) (*GetAgentKnowledgeBaseOutput, error)

GetAgentKnowledgeBaseWithContext is the same as GetAgentKnowledgeBase with the addition of the ability to pass a context and additional request options.

See GetAgentKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetAgentRequest

func (c *BedrockAgent) GetAgentRequest(input *GetAgentInput) (req *request.Request, output *GetAgentOutput)

GetAgentRequest generates a "aws/request.Request" representing the client's request for the GetAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgent for more information on using the GetAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAgentRequest method.
req, resp := client.GetAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgent

func (*BedrockAgent) GetAgentVersion

func (c *BedrockAgent) GetAgentVersion(input *GetAgentVersionInput) (*GetAgentVersionOutput, error)

GetAgentVersion API operation for Agents for Amazon Bedrock.

Gets details about a version of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetAgentVersion for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersion

func (*BedrockAgent) GetAgentVersionRequest

func (c *BedrockAgent) GetAgentVersionRequest(input *GetAgentVersionInput) (req *request.Request, output *GetAgentVersionOutput)

GetAgentVersionRequest generates a "aws/request.Request" representing the client's request for the GetAgentVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAgentVersion for more information on using the GetAgentVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAgentVersionRequest method.
req, resp := client.GetAgentVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersion

func (*BedrockAgent) GetAgentVersionWithContext

func (c *BedrockAgent) GetAgentVersionWithContext(ctx aws.Context, input *GetAgentVersionInput, opts ...request.Option) (*GetAgentVersionOutput, error)

GetAgentVersionWithContext is the same as GetAgentVersion with the addition of the ability to pass a context and additional request options.

See GetAgentVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetAgentWithContext

func (c *BedrockAgent) GetAgentWithContext(ctx aws.Context, input *GetAgentInput, opts ...request.Option) (*GetAgentOutput, error)

GetAgentWithContext is the same as GetAgent with the addition of the ability to pass a context and additional request options.

See GetAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetDataSource

func (c *BedrockAgent) GetDataSource(input *GetDataSourceInput) (*GetDataSourceOutput, error)

GetDataSource API operation for Agents for Amazon Bedrock.

Gets information about a data source.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetDataSource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSource

func (*BedrockAgent) GetDataSourceRequest

func (c *BedrockAgent) GetDataSourceRequest(input *GetDataSourceInput) (req *request.Request, output *GetDataSourceOutput)

GetDataSourceRequest generates a "aws/request.Request" representing the client's request for the GetDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDataSource for more information on using the GetDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDataSourceRequest method.
req, resp := client.GetDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSource

func (*BedrockAgent) GetDataSourceWithContext

func (c *BedrockAgent) GetDataSourceWithContext(ctx aws.Context, input *GetDataSourceInput, opts ...request.Option) (*GetDataSourceOutput, error)

GetDataSourceWithContext is the same as GetDataSource with the addition of the ability to pass a context and additional request options.

See GetDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetIngestionJob

func (c *BedrockAgent) GetIngestionJob(input *GetIngestionJobInput) (*GetIngestionJobOutput, error)

GetIngestionJob API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetIngestionJob for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob

func (*BedrockAgent) GetIngestionJobRequest

func (c *BedrockAgent) GetIngestionJobRequest(input *GetIngestionJobInput) (req *request.Request, output *GetIngestionJobOutput)

GetIngestionJobRequest generates a "aws/request.Request" representing the client's request for the GetIngestionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetIngestionJob for more information on using the GetIngestionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetIngestionJobRequest method.
req, resp := client.GetIngestionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob

func (*BedrockAgent) GetIngestionJobWithContext

func (c *BedrockAgent) GetIngestionJobWithContext(ctx aws.Context, input *GetIngestionJobInput, opts ...request.Option) (*GetIngestionJobOutput, error)

GetIngestionJobWithContext is the same as GetIngestionJob with the addition of the ability to pass a context and additional request options.

See GetIngestionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) GetKnowledgeBase

func (c *BedrockAgent) GetKnowledgeBase(input *GetKnowledgeBaseInput) (*GetKnowledgeBaseOutput, error)

GetKnowledgeBase API operation for Agents for Amazon Bedrock.

Gets information about a knoweldge base.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation GetKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBase

func (*BedrockAgent) GetKnowledgeBaseRequest

func (c *BedrockAgent) GetKnowledgeBaseRequest(input *GetKnowledgeBaseInput) (req *request.Request, output *GetKnowledgeBaseOutput)

GetKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the GetKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKnowledgeBase for more information on using the GetKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKnowledgeBaseRequest method.
req, resp := client.GetKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBase

func (*BedrockAgent) GetKnowledgeBaseWithContext

func (c *BedrockAgent) GetKnowledgeBaseWithContext(ctx aws.Context, input *GetKnowledgeBaseInput, opts ...request.Option) (*GetKnowledgeBaseOutput, error)

GetKnowledgeBaseWithContext is the same as GetKnowledgeBase with the addition of the ability to pass a context and additional request options.

See GetKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentActionGroups

func (c *BedrockAgent) ListAgentActionGroups(input *ListAgentActionGroupsInput) (*ListAgentActionGroupsOutput, error)

ListAgentActionGroups API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListAgentActionGroups for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroups

func (*BedrockAgent) ListAgentActionGroupsPages

func (c *BedrockAgent) ListAgentActionGroupsPages(input *ListAgentActionGroupsInput, fn func(*ListAgentActionGroupsOutput, bool) bool) error

ListAgentActionGroupsPages iterates over the pages of a ListAgentActionGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAgentActionGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAgentActionGroups operation.
pageNum := 0
err := client.ListAgentActionGroupsPages(params,
    func(page *bedrockagent.ListAgentActionGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListAgentActionGroupsPagesWithContext

func (c *BedrockAgent) ListAgentActionGroupsPagesWithContext(ctx aws.Context, input *ListAgentActionGroupsInput, fn func(*ListAgentActionGroupsOutput, bool) bool, opts ...request.Option) error

ListAgentActionGroupsPagesWithContext same as ListAgentActionGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentActionGroupsRequest

func (c *BedrockAgent) ListAgentActionGroupsRequest(input *ListAgentActionGroupsInput) (req *request.Request, output *ListAgentActionGroupsOutput)

ListAgentActionGroupsRequest generates a "aws/request.Request" representing the client's request for the ListAgentActionGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAgentActionGroups for more information on using the ListAgentActionGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAgentActionGroupsRequest method.
req, resp := client.ListAgentActionGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentActionGroups

func (*BedrockAgent) ListAgentActionGroupsWithContext

func (c *BedrockAgent) ListAgentActionGroupsWithContext(ctx aws.Context, input *ListAgentActionGroupsInput, opts ...request.Option) (*ListAgentActionGroupsOutput, error)

ListAgentActionGroupsWithContext is the same as ListAgentActionGroups with the addition of the ability to pass a context and additional request options.

See ListAgentActionGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentAliases

func (c *BedrockAgent) ListAgentAliases(input *ListAgentAliasesInput) (*ListAgentAliasesOutput, error)

ListAgentAliases API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListAgentAliases for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliases

func (*BedrockAgent) ListAgentAliasesPages

func (c *BedrockAgent) ListAgentAliasesPages(input *ListAgentAliasesInput, fn func(*ListAgentAliasesOutput, bool) bool) error

ListAgentAliasesPages iterates over the pages of a ListAgentAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAgentAliases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAgentAliases operation.
pageNum := 0
err := client.ListAgentAliasesPages(params,
    func(page *bedrockagent.ListAgentAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListAgentAliasesPagesWithContext

func (c *BedrockAgent) ListAgentAliasesPagesWithContext(ctx aws.Context, input *ListAgentAliasesInput, fn func(*ListAgentAliasesOutput, bool) bool, opts ...request.Option) error

ListAgentAliasesPagesWithContext same as ListAgentAliasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentAliasesRequest

func (c *BedrockAgent) ListAgentAliasesRequest(input *ListAgentAliasesInput) (req *request.Request, output *ListAgentAliasesOutput)

ListAgentAliasesRequest generates a "aws/request.Request" representing the client's request for the ListAgentAliases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAgentAliases for more information on using the ListAgentAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAgentAliasesRequest method.
req, resp := client.ListAgentAliasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentAliases

func (*BedrockAgent) ListAgentAliasesWithContext

func (c *BedrockAgent) ListAgentAliasesWithContext(ctx aws.Context, input *ListAgentAliasesInput, opts ...request.Option) (*ListAgentAliasesOutput, error)

ListAgentAliasesWithContext is the same as ListAgentAliases with the addition of the ability to pass a context and additional request options.

See ListAgentAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentKnowledgeBases

func (c *BedrockAgent) ListAgentKnowledgeBases(input *ListAgentKnowledgeBasesInput) (*ListAgentKnowledgeBasesOutput, error)

ListAgentKnowledgeBases API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListAgentKnowledgeBases for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBases

func (*BedrockAgent) ListAgentKnowledgeBasesPages

func (c *BedrockAgent) ListAgentKnowledgeBasesPages(input *ListAgentKnowledgeBasesInput, fn func(*ListAgentKnowledgeBasesOutput, bool) bool) error

ListAgentKnowledgeBasesPages iterates over the pages of a ListAgentKnowledgeBases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAgentKnowledgeBases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAgentKnowledgeBases operation.
pageNum := 0
err := client.ListAgentKnowledgeBasesPages(params,
    func(page *bedrockagent.ListAgentKnowledgeBasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListAgentKnowledgeBasesPagesWithContext

func (c *BedrockAgent) ListAgentKnowledgeBasesPagesWithContext(ctx aws.Context, input *ListAgentKnowledgeBasesInput, fn func(*ListAgentKnowledgeBasesOutput, bool) bool, opts ...request.Option) error

ListAgentKnowledgeBasesPagesWithContext same as ListAgentKnowledgeBasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentKnowledgeBasesRequest

func (c *BedrockAgent) ListAgentKnowledgeBasesRequest(input *ListAgentKnowledgeBasesInput) (req *request.Request, output *ListAgentKnowledgeBasesOutput)

ListAgentKnowledgeBasesRequest generates a "aws/request.Request" representing the client's request for the ListAgentKnowledgeBases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAgentKnowledgeBases for more information on using the ListAgentKnowledgeBases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAgentKnowledgeBasesRequest method.
req, resp := client.ListAgentKnowledgeBasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentKnowledgeBases

func (*BedrockAgent) ListAgentKnowledgeBasesWithContext

func (c *BedrockAgent) ListAgentKnowledgeBasesWithContext(ctx aws.Context, input *ListAgentKnowledgeBasesInput, opts ...request.Option) (*ListAgentKnowledgeBasesOutput, error)

ListAgentKnowledgeBasesWithContext is the same as ListAgentKnowledgeBases with the addition of the ability to pass a context and additional request options.

See ListAgentKnowledgeBases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentVersions

func (c *BedrockAgent) ListAgentVersions(input *ListAgentVersionsInput) (*ListAgentVersionsOutput, error)

ListAgentVersions API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListAgentVersions for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersions

func (*BedrockAgent) ListAgentVersionsPages

func (c *BedrockAgent) ListAgentVersionsPages(input *ListAgentVersionsInput, fn func(*ListAgentVersionsOutput, bool) bool) error

ListAgentVersionsPages iterates over the pages of a ListAgentVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAgentVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAgentVersions operation.
pageNum := 0
err := client.ListAgentVersionsPages(params,
    func(page *bedrockagent.ListAgentVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListAgentVersionsPagesWithContext

func (c *BedrockAgent) ListAgentVersionsPagesWithContext(ctx aws.Context, input *ListAgentVersionsInput, fn func(*ListAgentVersionsOutput, bool) bool, opts ...request.Option) error

ListAgentVersionsPagesWithContext same as ListAgentVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentVersionsRequest

func (c *BedrockAgent) ListAgentVersionsRequest(input *ListAgentVersionsInput) (req *request.Request, output *ListAgentVersionsOutput)

ListAgentVersionsRequest generates a "aws/request.Request" representing the client's request for the ListAgentVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAgentVersions for more information on using the ListAgentVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAgentVersionsRequest method.
req, resp := client.ListAgentVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersions

func (*BedrockAgent) ListAgentVersionsWithContext

func (c *BedrockAgent) ListAgentVersionsWithContext(ctx aws.Context, input *ListAgentVersionsInput, opts ...request.Option) (*ListAgentVersionsOutput, error)

ListAgentVersionsWithContext is the same as ListAgentVersions with the addition of the ability to pass a context and additional request options.

See ListAgentVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgents

func (c *BedrockAgent) ListAgents(input *ListAgentsInput) (*ListAgentsOutput, error)

ListAgents API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListAgents for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgents

func (*BedrockAgent) ListAgentsPages

func (c *BedrockAgent) ListAgentsPages(input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool) error

ListAgentsPages iterates over the pages of a ListAgents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAgents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAgents operation.
pageNum := 0
err := client.ListAgentsPages(params,
    func(page *bedrockagent.ListAgentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListAgentsPagesWithContext

func (c *BedrockAgent) ListAgentsPagesWithContext(ctx aws.Context, input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool, opts ...request.Option) error

ListAgentsPagesWithContext same as ListAgentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListAgentsRequest

func (c *BedrockAgent) ListAgentsRequest(input *ListAgentsInput) (req *request.Request, output *ListAgentsOutput)

ListAgentsRequest generates a "aws/request.Request" representing the client's request for the ListAgents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAgents for more information on using the ListAgents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAgentsRequest method.
req, resp := client.ListAgentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgents

func (*BedrockAgent) ListAgentsWithContext

func (c *BedrockAgent) ListAgentsWithContext(ctx aws.Context, input *ListAgentsInput, opts ...request.Option) (*ListAgentsOutput, error)

ListAgentsWithContext is the same as ListAgents with the addition of the ability to pass a context and additional request options.

See ListAgents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListDataSources

func (c *BedrockAgent) ListDataSources(input *ListDataSourcesInput) (*ListDataSourcesOutput, error)

ListDataSources API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListDataSources for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSources

func (*BedrockAgent) ListDataSourcesPages

func (c *BedrockAgent) ListDataSourcesPages(input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool) error

ListDataSourcesPages iterates over the pages of a ListDataSources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDataSources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDataSources operation.
pageNum := 0
err := client.ListDataSourcesPages(params,
    func(page *bedrockagent.ListDataSourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListDataSourcesPagesWithContext

func (c *BedrockAgent) ListDataSourcesPagesWithContext(ctx aws.Context, input *ListDataSourcesInput, fn func(*ListDataSourcesOutput, bool) bool, opts ...request.Option) error

ListDataSourcesPagesWithContext same as ListDataSourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListDataSourcesRequest

func (c *BedrockAgent) ListDataSourcesRequest(input *ListDataSourcesInput) (req *request.Request, output *ListDataSourcesOutput)

ListDataSourcesRequest generates a "aws/request.Request" representing the client's request for the ListDataSources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDataSources for more information on using the ListDataSources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDataSourcesRequest method.
req, resp := client.ListDataSourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListDataSources

func (*BedrockAgent) ListDataSourcesWithContext

func (c *BedrockAgent) ListDataSourcesWithContext(ctx aws.Context, input *ListDataSourcesInput, opts ...request.Option) (*ListDataSourcesOutput, error)

ListDataSourcesWithContext is the same as ListDataSources with the addition of the ability to pass a context and additional request options.

See ListDataSources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListIngestionJobs

func (c *BedrockAgent) ListIngestionJobs(input *ListIngestionJobsInput) (*ListIngestionJobsOutput, error)

ListIngestionJobs API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListIngestionJobs for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobs

func (*BedrockAgent) ListIngestionJobsPages

func (c *BedrockAgent) ListIngestionJobsPages(input *ListIngestionJobsInput, fn func(*ListIngestionJobsOutput, bool) bool) error

ListIngestionJobsPages iterates over the pages of a ListIngestionJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIngestionJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListIngestionJobs operation.
pageNum := 0
err := client.ListIngestionJobsPages(params,
    func(page *bedrockagent.ListIngestionJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListIngestionJobsPagesWithContext

func (c *BedrockAgent) ListIngestionJobsPagesWithContext(ctx aws.Context, input *ListIngestionJobsInput, fn func(*ListIngestionJobsOutput, bool) bool, opts ...request.Option) error

ListIngestionJobsPagesWithContext same as ListIngestionJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListIngestionJobsRequest

func (c *BedrockAgent) ListIngestionJobsRequest(input *ListIngestionJobsInput) (req *request.Request, output *ListIngestionJobsOutput)

ListIngestionJobsRequest generates a "aws/request.Request" representing the client's request for the ListIngestionJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIngestionJobs for more information on using the ListIngestionJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIngestionJobsRequest method.
req, resp := client.ListIngestionJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobs

func (*BedrockAgent) ListIngestionJobsWithContext

func (c *BedrockAgent) ListIngestionJobsWithContext(ctx aws.Context, input *ListIngestionJobsInput, opts ...request.Option) (*ListIngestionJobsOutput, error)

ListIngestionJobsWithContext is the same as ListIngestionJobs with the addition of the ability to pass a context and additional request options.

See ListIngestionJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListKnowledgeBases

func (c *BedrockAgent) ListKnowledgeBases(input *ListKnowledgeBasesInput) (*ListKnowledgeBasesOutput, error)

ListKnowledgeBases API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListKnowledgeBases for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBases

func (*BedrockAgent) ListKnowledgeBasesPages

func (c *BedrockAgent) ListKnowledgeBasesPages(input *ListKnowledgeBasesInput, fn func(*ListKnowledgeBasesOutput, bool) bool) error

ListKnowledgeBasesPages iterates over the pages of a ListKnowledgeBases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKnowledgeBases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListKnowledgeBases operation.
pageNum := 0
err := client.ListKnowledgeBasesPages(params,
    func(page *bedrockagent.ListKnowledgeBasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListKnowledgeBasesPagesWithContext

func (c *BedrockAgent) ListKnowledgeBasesPagesWithContext(ctx aws.Context, input *ListKnowledgeBasesInput, fn func(*ListKnowledgeBasesOutput, bool) bool, opts ...request.Option) error

ListKnowledgeBasesPagesWithContext same as ListKnowledgeBasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListKnowledgeBasesRequest

func (c *BedrockAgent) ListKnowledgeBasesRequest(input *ListKnowledgeBasesInput) (req *request.Request, output *ListKnowledgeBasesOutput)

ListKnowledgeBasesRequest generates a "aws/request.Request" representing the client's request for the ListKnowledgeBases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKnowledgeBases for more information on using the ListKnowledgeBases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListKnowledgeBasesRequest method.
req, resp := client.ListKnowledgeBasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBases

func (*BedrockAgent) ListKnowledgeBasesWithContext

func (c *BedrockAgent) ListKnowledgeBasesWithContext(ctx aws.Context, input *ListKnowledgeBasesInput, opts ...request.Option) (*ListKnowledgeBasesOutput, error)

ListKnowledgeBasesWithContext is the same as ListKnowledgeBases with the addition of the ability to pass a context and additional request options.

See ListKnowledgeBases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) ListTagsForResource

func (c *BedrockAgent) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Agents for Amazon Bedrock.

List all the tags for the resource you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResource

func (*BedrockAgent) ListTagsForResourceRequest

func (c *BedrockAgent) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListTagsForResource

func (*BedrockAgent) ListTagsForResourceWithContext

func (c *BedrockAgent) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) PrepareAgent

func (c *BedrockAgent) PrepareAgent(input *PrepareAgentInput) (*PrepareAgentOutput, error)

PrepareAgent API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation PrepareAgent for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgent

func (*BedrockAgent) PrepareAgentRequest

func (c *BedrockAgent) PrepareAgentRequest(input *PrepareAgentInput) (req *request.Request, output *PrepareAgentOutput)

PrepareAgentRequest generates a "aws/request.Request" representing the client's request for the PrepareAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PrepareAgent for more information on using the PrepareAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PrepareAgentRequest method.
req, resp := client.PrepareAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareAgent

func (*BedrockAgent) PrepareAgentWithContext

func (c *BedrockAgent) PrepareAgentWithContext(ctx aws.Context, input *PrepareAgentInput, opts ...request.Option) (*PrepareAgentOutput, error)

PrepareAgentWithContext is the same as PrepareAgent with the addition of the ability to pass a context and additional request options.

See PrepareAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) StartIngestionJob

func (c *BedrockAgent) StartIngestionJob(input *StartIngestionJobInput) (*StartIngestionJobOutput, error)

StartIngestionJob API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation StartIngestionJob for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob

func (*BedrockAgent) StartIngestionJobRequest

func (c *BedrockAgent) StartIngestionJobRequest(input *StartIngestionJobInput) (req *request.Request, output *StartIngestionJobOutput)

StartIngestionJobRequest generates a "aws/request.Request" representing the client's request for the StartIngestionJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartIngestionJob for more information on using the StartIngestionJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartIngestionJobRequest method.
req, resp := client.StartIngestionJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob

func (*BedrockAgent) StartIngestionJobWithContext

func (c *BedrockAgent) StartIngestionJobWithContext(ctx aws.Context, input *StartIngestionJobInput, opts ...request.Option) (*StartIngestionJobOutput, error)

StartIngestionJobWithContext is the same as StartIngestionJob with the addition of the ability to pass a context and additional request options.

See StartIngestionJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) TagResource

func (c *BedrockAgent) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Agents for Amazon Bedrock.

Associate tags with a resource. For more information, see Tagging resources (https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the Amazon Bedrock User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation TagResource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResource

func (*BedrockAgent) TagResourceRequest

func (c *BedrockAgent) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResource

func (*BedrockAgent) TagResourceWithContext

func (c *BedrockAgent) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UntagResource

func (c *BedrockAgent) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Agents for Amazon Bedrock.

Remove tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UntagResource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResource

func (*BedrockAgent) UntagResourceRequest

func (c *BedrockAgent) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UntagResource

func (*BedrockAgent) UntagResourceWithContext

func (c *BedrockAgent) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateAgent

func (c *BedrockAgent) UpdateAgent(input *UpdateAgentInput) (*UpdateAgentOutput, error)

UpdateAgent API operation for Agents for Amazon Bedrock.

Updates the configuration of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateAgent for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgent

func (*BedrockAgent) UpdateAgentActionGroup

func (c *BedrockAgent) UpdateAgentActionGroup(input *UpdateAgentActionGroupInput) (*UpdateAgentActionGroupOutput, error)

UpdateAgentActionGroup API operation for Agents for Amazon Bedrock.

Updates the configuration for an action group for an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateAgentActionGroup for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroup

func (*BedrockAgent) UpdateAgentActionGroupRequest

func (c *BedrockAgent) UpdateAgentActionGroupRequest(input *UpdateAgentActionGroupInput) (req *request.Request, output *UpdateAgentActionGroupOutput)

UpdateAgentActionGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateAgentActionGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAgentActionGroup for more information on using the UpdateAgentActionGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAgentActionGroupRequest method.
req, resp := client.UpdateAgentActionGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroup

func (*BedrockAgent) UpdateAgentActionGroupWithContext

func (c *BedrockAgent) UpdateAgentActionGroupWithContext(ctx aws.Context, input *UpdateAgentActionGroupInput, opts ...request.Option) (*UpdateAgentActionGroupOutput, error)

UpdateAgentActionGroupWithContext is the same as UpdateAgentActionGroup with the addition of the ability to pass a context and additional request options.

See UpdateAgentActionGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateAgentAlias

func (c *BedrockAgent) UpdateAgentAlias(input *UpdateAgentAliasInput) (*UpdateAgentAliasOutput, error)

UpdateAgentAlias API operation for Agents for Amazon Bedrock.

Updates configurations for an alias of an agent.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateAgentAlias for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

  • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAlias

func (*BedrockAgent) UpdateAgentAliasRequest

func (c *BedrockAgent) UpdateAgentAliasRequest(input *UpdateAgentAliasInput) (req *request.Request, output *UpdateAgentAliasOutput)

UpdateAgentAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateAgentAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAgentAlias for more information on using the UpdateAgentAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAgentAliasRequest method.
req, resp := client.UpdateAgentAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAlias

func (*BedrockAgent) UpdateAgentAliasWithContext

func (c *BedrockAgent) UpdateAgentAliasWithContext(ctx aws.Context, input *UpdateAgentAliasInput, opts ...request.Option) (*UpdateAgentAliasOutput, error)

UpdateAgentAliasWithContext is the same as UpdateAgentAlias with the addition of the ability to pass a context and additional request options.

See UpdateAgentAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateAgentKnowledgeBase

func (c *BedrockAgent) UpdateAgentKnowledgeBase(input *UpdateAgentKnowledgeBaseInput) (*UpdateAgentKnowledgeBaseOutput, error)

UpdateAgentKnowledgeBase API operation for Agents for Amazon Bedrock.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateAgentKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase

func (*BedrockAgent) UpdateAgentKnowledgeBaseRequest

func (c *BedrockAgent) UpdateAgentKnowledgeBaseRequest(input *UpdateAgentKnowledgeBaseInput) (req *request.Request, output *UpdateAgentKnowledgeBaseOutput)

UpdateAgentKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the UpdateAgentKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAgentKnowledgeBase for more information on using the UpdateAgentKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAgentKnowledgeBaseRequest method.
req, resp := client.UpdateAgentKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase

func (*BedrockAgent) UpdateAgentKnowledgeBaseWithContext

func (c *BedrockAgent) UpdateAgentKnowledgeBaseWithContext(ctx aws.Context, input *UpdateAgentKnowledgeBaseInput, opts ...request.Option) (*UpdateAgentKnowledgeBaseOutput, error)

UpdateAgentKnowledgeBaseWithContext is the same as UpdateAgentKnowledgeBase with the addition of the ability to pass a context and additional request options.

See UpdateAgentKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateAgentRequest

func (c *BedrockAgent) UpdateAgentRequest(input *UpdateAgentInput) (req *request.Request, output *UpdateAgentOutput)

UpdateAgentRequest generates a "aws/request.Request" representing the client's request for the UpdateAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAgent for more information on using the UpdateAgent API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAgentRequest method.
req, resp := client.UpdateAgentRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgent

func (*BedrockAgent) UpdateAgentWithContext

func (c *BedrockAgent) UpdateAgentWithContext(ctx aws.Context, input *UpdateAgentInput, opts ...request.Option) (*UpdateAgentOutput, error)

UpdateAgentWithContext is the same as UpdateAgent with the addition of the ability to pass a context and additional request options.

See UpdateAgent for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateDataSource

func (c *BedrockAgent) UpdateDataSource(input *UpdateDataSourceInput) (*UpdateDataSourceOutput, error)

UpdateDataSource API operation for Agents for Amazon Bedrock.

Updates configurations for a data source.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateDataSource for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSource

func (*BedrockAgent) UpdateDataSourceRequest

func (c *BedrockAgent) UpdateDataSourceRequest(input *UpdateDataSourceInput) (req *request.Request, output *UpdateDataSourceOutput)

UpdateDataSourceRequest generates a "aws/request.Request" representing the client's request for the UpdateDataSource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDataSource for more information on using the UpdateDataSource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateDataSourceRequest method.
req, resp := client.UpdateDataSourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSource

func (*BedrockAgent) UpdateDataSourceWithContext

func (c *BedrockAgent) UpdateDataSourceWithContext(ctx aws.Context, input *UpdateDataSourceInput, opts ...request.Option) (*UpdateDataSourceOutput, error)

UpdateDataSourceWithContext is the same as UpdateDataSource with the addition of the ability to pass a context and additional request options.

See UpdateDataSource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*BedrockAgent) UpdateKnowledgeBase

func (c *BedrockAgent) UpdateKnowledgeBase(input *UpdateKnowledgeBaseInput) (*UpdateKnowledgeBaseOutput, error)

UpdateKnowledgeBase API operation for Agents for Amazon Bedrock.

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 GetKnowledgeBase (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html) request and copy the same configurations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Agents for Amazon Bedrock's API operation UpdateKnowledgeBase for usage and error information.

Returned Error Types:

  • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.

  • AccessDeniedException The request is denied because of missing access permissions.

  • ValidationException Input validation failed. Check your request parameters and retry the request.

  • InternalServerException An internal server error occurred. Retry your request.

  • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

  • ConflictException There was a conflict performing an operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBase

func (*BedrockAgent) UpdateKnowledgeBaseRequest

func (c *BedrockAgent) UpdateKnowledgeBaseRequest(input *UpdateKnowledgeBaseInput) (req *request.Request, output *UpdateKnowledgeBaseOutput)

UpdateKnowledgeBaseRequest generates a "aws/request.Request" representing the client's request for the UpdateKnowledgeBase operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateKnowledgeBase for more information on using the UpdateKnowledgeBase API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateKnowledgeBaseRequest method.
req, resp := client.UpdateKnowledgeBaseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBase

func (*BedrockAgent) UpdateKnowledgeBaseWithContext

func (c *BedrockAgent) UpdateKnowledgeBaseWithContext(ctx aws.Context, input *UpdateKnowledgeBaseInput, opts ...request.Option) (*UpdateKnowledgeBaseOutput, error)

UpdateKnowledgeBaseWithContext is the same as UpdateKnowledgeBase with the addition of the ability to pass a context and additional request options.

See UpdateKnowledgeBase for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type BedrockEmbeddingModelConfiguration

type BedrockEmbeddingModelConfiguration struct {

	// The dimensions details for the vector configuration used on the Bedrock embeddings
	// model.
	Dimensions *int64 `locationName:"dimensions" type:"integer"`
	// contains filtered or unexported fields
}

The vector configuration details for the Bedrock embeddings model.

func (BedrockEmbeddingModelConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BedrockEmbeddingModelConfiguration) SetDimensions

SetDimensions sets the Dimensions field's value.

func (BedrockEmbeddingModelConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChunkingConfiguration

type ChunkingConfiguration struct {

	// Knowledge base can split your source data into chunks. A chunk refers to
	// an excerpt from a data source that is returned when the knowledge base that
	// it belongs to is queried. You have the following options for chunking your
	// data. If you opt for NONE, then you may want to pre-process your files by
	// splitting them up such that each file corresponds to a chunk.
	//
	//    * FIXED_SIZE – Amazon Bedrock splits your source data into chunks of
	//    the approximate size that you set in the fixedSizeChunkingConfiguration.
	//
	//    * NONE – Amazon Bedrock treats each file as one chunk. If you choose
	//    this option, you may want to pre-process your documents by splitting them
	//    into separate files.
	//
	// ChunkingStrategy is a required field
	ChunkingStrategy *string `locationName:"chunkingStrategy" type:"string" required:"true" enum:"ChunkingStrategy"`

	// Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy
	// as NONE, exclude this field.
	FixedSizeChunkingConfiguration *FixedSizeChunkingConfiguration `locationName:"fixedSizeChunkingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

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

func (ChunkingConfiguration) GoString

func (s ChunkingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChunkingConfiguration) SetChunkingStrategy

func (s *ChunkingConfiguration) SetChunkingStrategy(v string) *ChunkingConfiguration

SetChunkingStrategy sets the ChunkingStrategy field's value.

func (*ChunkingConfiguration) SetFixedSizeChunkingConfiguration

func (s *ChunkingConfiguration) SetFixedSizeChunkingConfiguration(v *FixedSizeChunkingConfiguration) *ChunkingConfiguration

SetFixedSizeChunkingConfiguration sets the FixedSizeChunkingConfiguration field's value.

func (ChunkingConfiguration) String

func (s ChunkingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChunkingConfiguration) Validate

func (s *ChunkingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There was a conflict performing an operation.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAgentActionGroupInput

type CreateAgentActionGroupInput struct {

	// 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 *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"`

	// The name to give the action group.
	//
	// ActionGroupName is a required field
	ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"`

	// 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 *string `locationName:"actionGroupState" type:"string" enum:"ActionGroupState"`

	// The unique identifier of the agent for which to create the action group.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent for which to create the action group.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// 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 *APISchema `locationName:"apiSchema" type:"structure"`

	// 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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// A description of the action group.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the function schema for the action group or the JSON
	// or YAML-formatted payload defining the schema.
	FunctionSchema *FunctionSchema `locationName:"functionSchema" type:"structure"`

	// 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 *string `locationName:"parentActionGroupSignature" type:"string" enum:"ActionGroupSignature"`
	// contains filtered or unexported fields
}

func (CreateAgentActionGroupInput) GoString

func (s CreateAgentActionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentActionGroupInput) SetActionGroupExecutor

SetActionGroupExecutor sets the ActionGroupExecutor field's value.

func (*CreateAgentActionGroupInput) SetActionGroupName

SetActionGroupName sets the ActionGroupName field's value.

func (*CreateAgentActionGroupInput) SetActionGroupState

SetActionGroupState sets the ActionGroupState field's value.

func (*CreateAgentActionGroupInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*CreateAgentActionGroupInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*CreateAgentActionGroupInput) SetApiSchema

SetApiSchema sets the ApiSchema field's value.

func (*CreateAgentActionGroupInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateAgentActionGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateAgentActionGroupInput) SetFunctionSchema

SetFunctionSchema sets the FunctionSchema field's value.

func (*CreateAgentActionGroupInput) SetParentActionGroupSignature

func (s *CreateAgentActionGroupInput) SetParentActionGroupSignature(v string) *CreateAgentActionGroupInput

SetParentActionGroupSignature sets the ParentActionGroupSignature field's value.

func (CreateAgentActionGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentActionGroupInput) Validate

func (s *CreateAgentActionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAgentActionGroupOutput

type CreateAgentActionGroupOutput struct {

	// Contains details about the action group that was created.
	//
	// AgentActionGroup is a required field
	AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAgentActionGroupOutput) GoString

func (s CreateAgentActionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentActionGroupOutput) SetAgentActionGroup

SetAgentActionGroup sets the AgentActionGroup field's value.

func (CreateAgentActionGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAgentAliasInput

type CreateAgentAliasInput struct {

	// The name of the alias.
	//
	// AgentAliasName is a required field
	AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"`

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// 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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// A description of the alias of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the routing configuration of the alias.
	RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"`

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

func (CreateAgentAliasInput) GoString

func (s CreateAgentAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentAliasInput) SetAgentAliasName

func (s *CreateAgentAliasInput) SetAgentAliasName(v string) *CreateAgentAliasInput

SetAgentAliasName sets the AgentAliasName field's value.

func (*CreateAgentAliasInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*CreateAgentAliasInput) SetClientToken

func (s *CreateAgentAliasInput) SetClientToken(v string) *CreateAgentAliasInput

SetClientToken sets the ClientToken field's value.

func (*CreateAgentAliasInput) SetDescription

func (s *CreateAgentAliasInput) SetDescription(v string) *CreateAgentAliasInput

SetDescription sets the Description field's value.

func (*CreateAgentAliasInput) SetRoutingConfiguration

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*CreateAgentAliasInput) SetTags

SetTags sets the Tags field's value.

func (CreateAgentAliasInput) String

func (s CreateAgentAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentAliasInput) Validate

func (s *CreateAgentAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAgentAliasOutput

type CreateAgentAliasOutput struct {

	// Contains details about the alias that was created.
	//
	// AgentAlias is a required field
	AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAgentAliasOutput) GoString

func (s CreateAgentAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentAliasOutput) SetAgentAlias

SetAgentAlias sets the AgentAlias field's value.

func (CreateAgentAliasOutput) String

func (s CreateAgentAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAgentInput

type CreateAgentInput struct {

	// A name for the agent that you create.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the agent.
	AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// A description of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The foundation model to be used for orchestration by the agent you create.
	FoundationModel *string `locationName:"foundationModel" min:"1" type:"string"`

	// The unique Guardrail configuration assigned to the agent when it is created.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// 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 *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer"`

	// Instructions that tell the agent what it should do and how it should interact
	// with users.
	//
	// Instruction is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAgentInput's
	// String and GoString methods.
	Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateAgentInput's
	// String and GoString methods.
	PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"`

	// Any tags that you want to attach to the agent.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAgentInput) GoString

func (s CreateAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentInput) SetAgentName

func (s *CreateAgentInput) SetAgentName(v string) *CreateAgentInput

SetAgentName sets the AgentName field's value.

func (*CreateAgentInput) SetAgentResourceRoleArn

func (s *CreateAgentInput) SetAgentResourceRoleArn(v string) *CreateAgentInput

SetAgentResourceRoleArn sets the AgentResourceRoleArn field's value.

func (*CreateAgentInput) SetClientToken

func (s *CreateAgentInput) SetClientToken(v string) *CreateAgentInput

SetClientToken sets the ClientToken field's value.

func (*CreateAgentInput) SetCustomerEncryptionKeyArn

func (s *CreateAgentInput) SetCustomerEncryptionKeyArn(v string) *CreateAgentInput

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreateAgentInput) SetDescription

func (s *CreateAgentInput) SetDescription(v string) *CreateAgentInput

SetDescription sets the Description field's value.

func (*CreateAgentInput) SetFoundationModel

func (s *CreateAgentInput) SetFoundationModel(v string) *CreateAgentInput

SetFoundationModel sets the FoundationModel field's value.

func (*CreateAgentInput) SetGuardrailConfiguration

func (s *CreateAgentInput) SetGuardrailConfiguration(v *GuardrailConfiguration) *CreateAgentInput

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*CreateAgentInput) SetIdleSessionTTLInSeconds

func (s *CreateAgentInput) SetIdleSessionTTLInSeconds(v int64) *CreateAgentInput

SetIdleSessionTTLInSeconds sets the IdleSessionTTLInSeconds field's value.

func (*CreateAgentInput) SetInstruction

func (s *CreateAgentInput) SetInstruction(v string) *CreateAgentInput

SetInstruction sets the Instruction field's value.

func (*CreateAgentInput) SetPromptOverrideConfiguration

func (s *CreateAgentInput) SetPromptOverrideConfiguration(v *PromptOverrideConfiguration) *CreateAgentInput

SetPromptOverrideConfiguration sets the PromptOverrideConfiguration field's value.

func (*CreateAgentInput) SetTags

func (s *CreateAgentInput) SetTags(v map[string]*string) *CreateAgentInput

SetTags sets the Tags field's value.

func (CreateAgentInput) String

func (s CreateAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentInput) Validate

func (s *CreateAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAgentOutput

type CreateAgentOutput struct {

	// Contains details about the agent created.
	//
	// Agent is a required field
	Agent *Agent `locationName:"agent" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAgentOutput) GoString

func (s CreateAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAgentOutput) SetAgent

func (s *CreateAgentOutput) SetAgent(v *Agent) *CreateAgentOutput

SetAgent sets the Agent field's value.

func (CreateAgentOutput) String

func (s CreateAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDataSourceInput

type CreateDataSourceInput struct {

	// 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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// The data deletion policy assigned to the data source.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// Contains metadata about where the data source is stored.
	//
	// DataSourceConfiguration is a required field
	DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"`

	// A description of the data source.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base to which to add the data source.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The name of the data source.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contains details about the server-side encryption for the data source.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDataSourceInput) GoString

func (s CreateDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceInput) SetClientToken

func (s *CreateDataSourceInput) SetClientToken(v string) *CreateDataSourceInput

SetClientToken sets the ClientToken field's value.

func (*CreateDataSourceInput) SetDataDeletionPolicy

func (s *CreateDataSourceInput) SetDataDeletionPolicy(v string) *CreateDataSourceInput

SetDataDeletionPolicy sets the DataDeletionPolicy field's value.

func (*CreateDataSourceInput) SetDataSourceConfiguration

func (s *CreateDataSourceInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *CreateDataSourceInput

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*CreateDataSourceInput) SetDescription

func (s *CreateDataSourceInput) SetDescription(v string) *CreateDataSourceInput

SetDescription sets the Description field's value.

func (*CreateDataSourceInput) SetKnowledgeBaseId

func (s *CreateDataSourceInput) SetKnowledgeBaseId(v string) *CreateDataSourceInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*CreateDataSourceInput) SetName

SetName sets the Name field's value.

func (*CreateDataSourceInput) SetServerSideEncryptionConfiguration

func (s *CreateDataSourceInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateDataSourceInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*CreateDataSourceInput) SetVectorIngestionConfiguration

func (s *CreateDataSourceInput) SetVectorIngestionConfiguration(v *VectorIngestionConfiguration) *CreateDataSourceInput

SetVectorIngestionConfiguration sets the VectorIngestionConfiguration field's value.

func (CreateDataSourceInput) String

func (s CreateDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceInput) Validate

func (s *CreateDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDataSourceOutput

type CreateDataSourceOutput struct {

	// Contains details about the data source.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDataSourceOutput) GoString

func (s CreateDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDataSourceOutput) SetDataSource

SetDataSource sets the DataSource field's value.

func (CreateDataSourceOutput) String

func (s CreateDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateKnowledgeBaseInput

type CreateKnowledgeBaseInput struct {

	// 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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// A description of the knowledge base.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the embeddings model used for the knowledge base.
	//
	// KnowledgeBaseConfiguration is a required field
	KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"`

	// A name for the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the knowledge base.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// Contains details about the configuration of the vector database used for
	// the knowledge base.
	//
	// StorageConfiguration is a required field
	StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"`

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

func (CreateKnowledgeBaseInput) GoString

func (s CreateKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateKnowledgeBaseInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateKnowledgeBaseInput) SetKnowledgeBaseConfiguration

SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetName

SetName sets the Name field's value.

func (*CreateKnowledgeBaseInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateKnowledgeBaseInput) SetStorageConfiguration

SetStorageConfiguration sets the StorageConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetTags

SetTags sets the Tags field's value.

func (CreateKnowledgeBaseInput) String

func (s CreateKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseInput) Validate

func (s *CreateKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKnowledgeBaseOutput

type CreateKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// KnowledgeBase is a required field
	KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateKnowledgeBaseOutput) GoString

func (s CreateKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKnowledgeBaseOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (CreateKnowledgeBaseOutput) String

func (s CreateKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSource

type DataSource struct {

	// The time at which the data source was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The data deletion policy for a data source.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// Contains details about how the data source is stored.
	//
	// DataSourceConfiguration is a required field
	DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"`

	// The unique identifier of the data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"`

	// The description of the data source.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The detailed reasons on the failure to delete a data source.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The name of the data source.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contains details about the configuration of the server-side encryption.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// The status of the data source. The following statuses are possible:
	//
	//    * Available – The data source has been created and is ready for ingestion
	//    into the knowledge base.
	//
	//    * Deleting – The data source is being deleted.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"`

	// The time at which the data source was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about a data source.

func (DataSource) GoString

func (s DataSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSource) SetCreatedAt

func (s *DataSource) SetCreatedAt(v time.Time) *DataSource

SetCreatedAt sets the CreatedAt field's value.

func (*DataSource) SetDataDeletionPolicy

func (s *DataSource) SetDataDeletionPolicy(v string) *DataSource

SetDataDeletionPolicy sets the DataDeletionPolicy field's value.

func (*DataSource) SetDataSourceConfiguration

func (s *DataSource) SetDataSourceConfiguration(v *DataSourceConfiguration) *DataSource

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*DataSource) SetDataSourceId

func (s *DataSource) SetDataSourceId(v string) *DataSource

SetDataSourceId sets the DataSourceId field's value.

func (*DataSource) SetDescription

func (s *DataSource) SetDescription(v string) *DataSource

SetDescription sets the Description field's value.

func (*DataSource) SetFailureReasons

func (s *DataSource) SetFailureReasons(v []*string) *DataSource

SetFailureReasons sets the FailureReasons field's value.

func (*DataSource) SetKnowledgeBaseId

func (s *DataSource) SetKnowledgeBaseId(v string) *DataSource

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DataSource) SetName

func (s *DataSource) SetName(v string) *DataSource

SetName sets the Name field's value.

func (*DataSource) SetServerSideEncryptionConfiguration

func (s *DataSource) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DataSource

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*DataSource) SetStatus

func (s *DataSource) SetStatus(v string) *DataSource

SetStatus sets the Status field's value.

func (*DataSource) SetUpdatedAt

func (s *DataSource) SetUpdatedAt(v time.Time) *DataSource

SetUpdatedAt sets the UpdatedAt field's value.

func (*DataSource) SetVectorIngestionConfiguration

func (s *DataSource) SetVectorIngestionConfiguration(v *VectorIngestionConfiguration) *DataSource

SetVectorIngestionConfiguration sets the VectorIngestionConfiguration field's value.

func (DataSource) String

func (s DataSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSourceConfiguration

type DataSourceConfiguration struct {

	// Contains details about the configuration of the S3 object containing the
	// data source.
	S3Configuration *S3DataSourceConfiguration `locationName:"s3Configuration" type:"structure"`

	// The type of storage for the data source.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DataSourceType"`
	// contains filtered or unexported fields
}

Contains details about how a data source is stored.

func (DataSourceConfiguration) GoString

func (s DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) SetS3Configuration

SetS3Configuration sets the S3Configuration field's value.

func (*DataSourceConfiguration) SetType

SetType sets the Type field's value.

func (DataSourceConfiguration) String

func (s DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceConfiguration) Validate

func (s *DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DataSourceSummary

type DataSourceSummary struct {

	// The unique identifier of the data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"`

	// The description of the data source.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The name of the data source.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the data source.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"`

	// The time at which the data source was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a data source.

func (DataSourceSummary) GoString

func (s DataSourceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DataSourceSummary) SetDataSourceId

func (s *DataSourceSummary) SetDataSourceId(v string) *DataSourceSummary

SetDataSourceId sets the DataSourceId field's value.

func (*DataSourceSummary) SetDescription

func (s *DataSourceSummary) SetDescription(v string) *DataSourceSummary

SetDescription sets the Description field's value.

func (*DataSourceSummary) SetKnowledgeBaseId

func (s *DataSourceSummary) SetKnowledgeBaseId(v string) *DataSourceSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DataSourceSummary) SetName

SetName sets the Name field's value.

func (*DataSourceSummary) SetStatus

func (s *DataSourceSummary) SetStatus(v string) *DataSourceSummary

SetStatus sets the Status field's value.

func (*DataSourceSummary) SetUpdatedAt

func (s *DataSourceSummary) SetUpdatedAt(v time.Time) *DataSourceSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (DataSourceSummary) String

func (s DataSourceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAgentActionGroupInput

type DeleteAgentActionGroupInput struct {

	// The unique identifier of the action group to delete.
	//
	// ActionGroupId is a required field
	ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"`

	// The unique identifier of the agent that the action group belongs to.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent that the action group belongs to.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteAgentActionGroupInput) GoString

func (s DeleteAgentActionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentActionGroupInput) SetActionGroupId

SetActionGroupId sets the ActionGroupId field's value.

func (*DeleteAgentActionGroupInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*DeleteAgentActionGroupInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*DeleteAgentActionGroupInput) SetSkipResourceInUseCheck

func (s *DeleteAgentActionGroupInput) SetSkipResourceInUseCheck(v bool) *DeleteAgentActionGroupInput

SetSkipResourceInUseCheck sets the SkipResourceInUseCheck field's value.

func (DeleteAgentActionGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentActionGroupInput) Validate

func (s *DeleteAgentActionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAgentActionGroupOutput

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

func (DeleteAgentActionGroupOutput) GoString

func (s DeleteAgentActionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAgentActionGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAgentAliasInput

type DeleteAgentAliasInput struct {

	// The unique identifier of the alias to delete.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// The unique identifier of the agent that the alias belongs to.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAgentAliasInput) GoString

func (s DeleteAgentAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentAliasInput) SetAgentAliasId

func (s *DeleteAgentAliasInput) SetAgentAliasId(v string) *DeleteAgentAliasInput

SetAgentAliasId sets the AgentAliasId field's value.

func (*DeleteAgentAliasInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (DeleteAgentAliasInput) String

func (s DeleteAgentAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentAliasInput) Validate

func (s *DeleteAgentAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAgentAliasOutput

type DeleteAgentAliasOutput struct {

	// The unique identifier of the alias that was deleted.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// The status of the alias.
	//
	// AgentAliasStatus is a required field
	AgentAliasStatus *string `locationName:"agentAliasStatus" type:"string" required:"true" enum:"AgentAliasStatus"`

	// The unique identifier of the agent that the alias belongs to.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAgentAliasOutput) GoString

func (s DeleteAgentAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentAliasOutput) SetAgentAliasId

func (s *DeleteAgentAliasOutput) SetAgentAliasId(v string) *DeleteAgentAliasOutput

SetAgentAliasId sets the AgentAliasId field's value.

func (*DeleteAgentAliasOutput) SetAgentAliasStatus

func (s *DeleteAgentAliasOutput) SetAgentAliasStatus(v string) *DeleteAgentAliasOutput

SetAgentAliasStatus sets the AgentAliasStatus field's value.

func (*DeleteAgentAliasOutput) SetAgentId

SetAgentId sets the AgentId field's value.

func (DeleteAgentAliasOutput) String

func (s DeleteAgentAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAgentInput

type DeleteAgentInput struct {

	// The unique identifier of the agent to delete.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteAgentInput) GoString

func (s DeleteAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentInput) SetAgentId

func (s *DeleteAgentInput) SetAgentId(v string) *DeleteAgentInput

SetAgentId sets the AgentId field's value.

func (*DeleteAgentInput) SetSkipResourceInUseCheck

func (s *DeleteAgentInput) SetSkipResourceInUseCheck(v bool) *DeleteAgentInput

SetSkipResourceInUseCheck sets the SkipResourceInUseCheck field's value.

func (DeleteAgentInput) String

func (s DeleteAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentInput) Validate

func (s *DeleteAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAgentOutput

type DeleteAgentOutput struct {

	// The unique identifier of the agent that was deleted.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The status of the agent.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`
	// contains filtered or unexported fields
}

func (DeleteAgentOutput) GoString

func (s DeleteAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentOutput) SetAgentId

func (s *DeleteAgentOutput) SetAgentId(v string) *DeleteAgentOutput

SetAgentId sets the AgentId field's value.

func (*DeleteAgentOutput) SetAgentStatus

func (s *DeleteAgentOutput) SetAgentStatus(v string) *DeleteAgentOutput

SetAgentStatus sets the AgentStatus field's value.

func (DeleteAgentOutput) String

func (s DeleteAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAgentVersionInput

type DeleteAgentVersionInput struct {

	// The unique identifier of the agent that the version belongs to.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent to delete.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" type:"string" required:"true"`

	// 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 `location:"querystring" locationName:"skipResourceInUseCheck" type:"boolean"`
	// contains filtered or unexported fields
}

func (DeleteAgentVersionInput) GoString

func (s DeleteAgentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentVersionInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*DeleteAgentVersionInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*DeleteAgentVersionInput) SetSkipResourceInUseCheck

func (s *DeleteAgentVersionInput) SetSkipResourceInUseCheck(v bool) *DeleteAgentVersionInput

SetSkipResourceInUseCheck sets the SkipResourceInUseCheck field's value.

func (DeleteAgentVersionInput) String

func (s DeleteAgentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentVersionInput) Validate

func (s *DeleteAgentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAgentVersionOutput

type DeleteAgentVersionOutput struct {

	// The unique identifier of the agent that the version belongs to.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The status of the agent version.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The version that was deleted.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAgentVersionOutput) GoString

func (s DeleteAgentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAgentVersionOutput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*DeleteAgentVersionOutput) SetAgentStatus

SetAgentStatus sets the AgentStatus field's value.

func (*DeleteAgentVersionOutput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (DeleteAgentVersionOutput) String

func (s DeleteAgentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDataSourceInput

type DeleteDataSourceInput struct {

	// The unique identifier of the data source to delete.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// The unique identifier of the knowledge base from which to delete the data
	// source.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDataSourceInput) GoString

func (s DeleteDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) SetDataSourceId

func (s *DeleteDataSourceInput) SetDataSourceId(v string) *DeleteDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*DeleteDataSourceInput) SetKnowledgeBaseId

func (s *DeleteDataSourceInput) SetKnowledgeBaseId(v string) *DeleteDataSourceInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DeleteDataSourceInput) String

func (s DeleteDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceInput) Validate

func (s *DeleteDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDataSourceOutput

type DeleteDataSourceOutput struct {

	// The unique identifier of the data source that was deleted.
	//
	// DataSourceId is a required field
	DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"`

	// The unique identifier of the knowledge base to which the data source that
	// was deleted belonged.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The status of the data source.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"DataSourceStatus"`
	// contains filtered or unexported fields
}

func (DeleteDataSourceOutput) GoString

func (s DeleteDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDataSourceOutput) SetDataSourceId

func (s *DeleteDataSourceOutput) SetDataSourceId(v string) *DeleteDataSourceOutput

SetDataSourceId sets the DataSourceId field's value.

func (*DeleteDataSourceOutput) SetKnowledgeBaseId

func (s *DeleteDataSourceOutput) SetKnowledgeBaseId(v string) *DeleteDataSourceOutput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DeleteDataSourceOutput) SetStatus

SetStatus sets the Status field's value.

func (DeleteDataSourceOutput) String

func (s DeleteDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteKnowledgeBaseInput

type DeleteKnowledgeBaseInput struct {

	// The unique identifier of the knowledge base to delete.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKnowledgeBaseInput) GoString

func (s DeleteKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnowledgeBaseInput) SetKnowledgeBaseId

func (s *DeleteKnowledgeBaseInput) SetKnowledgeBaseId(v string) *DeleteKnowledgeBaseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DeleteKnowledgeBaseInput) String

func (s DeleteKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnowledgeBaseInput) Validate

func (s *DeleteKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKnowledgeBaseOutput

type DeleteKnowledgeBaseOutput struct {

	// The unique identifier of the knowledge base that was deleted.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The status of the knowledge base and whether it has been successfully deleted.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"`
	// contains filtered or unexported fields
}

func (DeleteKnowledgeBaseOutput) GoString

func (s DeleteKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKnowledgeBaseOutput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DeleteKnowledgeBaseOutput) SetStatus

SetStatus sets the Status field's value.

func (DeleteKnowledgeBaseOutput) String

func (s DeleteKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateAgentKnowledgeBaseInput

type DisassociateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent from which to disassociate the knowledge
	// base.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent from which to disassociate the knowledge base.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// The unique identifier of the knowledge base to disassociate.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateAgentKnowledgeBaseInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateAgentKnowledgeBaseInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*DisassociateAgentKnowledgeBaseInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*DisassociateAgentKnowledgeBaseInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DisassociateAgentKnowledgeBaseInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateAgentKnowledgeBaseInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DisassociateAgentKnowledgeBaseOutput

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

func (DisassociateAgentKnowledgeBaseOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateAgentKnowledgeBaseOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EmbeddingModelConfiguration

type EmbeddingModelConfiguration struct {

	// The vector configuration details on the Bedrock embeddings model.
	BedrockEmbeddingModelConfiguration *BedrockEmbeddingModelConfiguration `locationName:"bedrockEmbeddingModelConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The configuration details for the embeddings model.

func (EmbeddingModelConfiguration) GoString

func (s EmbeddingModelConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EmbeddingModelConfiguration) SetBedrockEmbeddingModelConfiguration

SetBedrockEmbeddingModelConfiguration sets the BedrockEmbeddingModelConfiguration field's value.

func (EmbeddingModelConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FixedSizeChunkingConfiguration

type FixedSizeChunkingConfiguration struct {

	// The maximum number of tokens to include in a chunk.
	//
	// MaxTokens is a required field
	MaxTokens *int64 `locationName:"maxTokens" min:"1" type:"integer" required:"true"`

	// The percentage of overlap between adjacent chunks of a data source.
	//
	// OverlapPercentage is a required field
	OverlapPercentage *int64 `locationName:"overlapPercentage" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

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

func (FixedSizeChunkingConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FixedSizeChunkingConfiguration) SetMaxTokens

SetMaxTokens sets the MaxTokens field's value.

func (*FixedSizeChunkingConfiguration) SetOverlapPercentage

SetOverlapPercentage sets the OverlapPercentage field's value.

func (FixedSizeChunkingConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FixedSizeChunkingConfiguration) Validate

func (s *FixedSizeChunkingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Function

type Function struct {

	// A description of the function and its purpose.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A name for the function.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The parameters that the agent elicits from the user to fulfill the function.
	Parameters map[string]*ParameterDetail `locationName:"parameters" type:"map"`
	// contains filtered or unexported fields
}

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

This data type is used in the following API operations:

func (Function) GoString

func (s Function) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Function) SetDescription

func (s *Function) SetDescription(v string) *Function

SetDescription sets the Description field's value.

func (*Function) SetName

func (s *Function) SetName(v string) *Function

SetName sets the Name field's value.

func (*Function) SetParameters

func (s *Function) SetParameters(v map[string]*ParameterDetail) *Function

SetParameters sets the Parameters field's value.

func (Function) String

func (s Function) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Function) Validate

func (s *Function) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FunctionSchema

type FunctionSchema struct {

	// A list of functions that each define an action in the action group.
	Functions []*Function `locationName:"functions" type:"list"`
	// contains filtered or unexported fields
}

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

This data type is used in the following API operations:

func (FunctionSchema) GoString

func (s FunctionSchema) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionSchema) SetFunctions

func (s *FunctionSchema) SetFunctions(v []*Function) *FunctionSchema

SetFunctions sets the Functions field's value.

func (FunctionSchema) String

func (s FunctionSchema) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FunctionSchema) Validate

func (s *FunctionSchema) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentActionGroupInput

type GetAgentActionGroupInput struct {

	// The unique identifier of the action group for which to get information.
	//
	// ActionGroupId is a required field
	ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"`

	// The unique identifier of the agent that the action group belongs to.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent that the action group belongs to.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentActionGroupInput) GoString

func (s GetAgentActionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentActionGroupInput) SetActionGroupId

SetActionGroupId sets the ActionGroupId field's value.

func (*GetAgentActionGroupInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*GetAgentActionGroupInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (GetAgentActionGroupInput) String

func (s GetAgentActionGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentActionGroupInput) Validate

func (s *GetAgentActionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentActionGroupOutput

type GetAgentActionGroupOutput struct {

	// Contains details about the action group.
	//
	// AgentActionGroup is a required field
	AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentActionGroupOutput) GoString

func (s GetAgentActionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentActionGroupOutput) SetAgentActionGroup

SetAgentActionGroup sets the AgentActionGroup field's value.

func (GetAgentActionGroupOutput) String

func (s GetAgentActionGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAgentAliasInput

type GetAgentAliasInput struct {

	// The unique identifier of the alias for which to get information.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// The unique identifier of the agent to which the alias to get information
	// belongs.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentAliasInput) GoString

func (s GetAgentAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentAliasInput) SetAgentAliasId

func (s *GetAgentAliasInput) SetAgentAliasId(v string) *GetAgentAliasInput

SetAgentAliasId sets the AgentAliasId field's value.

func (*GetAgentAliasInput) SetAgentId

func (s *GetAgentAliasInput) SetAgentId(v string) *GetAgentAliasInput

SetAgentId sets the AgentId field's value.

func (GetAgentAliasInput) String

func (s GetAgentAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentAliasInput) Validate

func (s *GetAgentAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentAliasOutput

type GetAgentAliasOutput struct {

	// Contains information about the alias.
	//
	// AgentAlias is a required field
	AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentAliasOutput) GoString

func (s GetAgentAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentAliasOutput) SetAgentAlias

func (s *GetAgentAliasOutput) SetAgentAlias(v *AgentAlias) *GetAgentAliasOutput

SetAgentAlias sets the AgentAlias field's value.

func (GetAgentAliasOutput) String

func (s GetAgentAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAgentInput

type GetAgentInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentInput) GoString

func (s GetAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentInput) SetAgentId

func (s *GetAgentInput) SetAgentId(v string) *GetAgentInput

SetAgentId sets the AgentId field's value.

func (GetAgentInput) String

func (s GetAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentInput) Validate

func (s *GetAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentKnowledgeBaseInput

type GetAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent with which the knowledge base is associated.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent with which the knowledge base is associated.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// The unique identifier of the knowledge base associated with the agent.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentKnowledgeBaseInput) GoString

func (s GetAgentKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentKnowledgeBaseInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*GetAgentKnowledgeBaseInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*GetAgentKnowledgeBaseInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetAgentKnowledgeBaseInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentKnowledgeBaseInput) Validate

func (s *GetAgentKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentKnowledgeBaseOutput

type GetAgentKnowledgeBaseOutput struct {

	// Contains details about a knowledge base attached to an agent.
	//
	// AgentKnowledgeBase is a required field
	AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentKnowledgeBaseOutput) GoString

func (s GetAgentKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentKnowledgeBaseOutput) SetAgentKnowledgeBase

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (GetAgentKnowledgeBaseOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAgentOutput

type GetAgentOutput struct {

	// Contains details about the agent.
	//
	// Agent is a required field
	Agent *Agent `locationName:"agent" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentOutput) GoString

func (s GetAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentOutput) SetAgent

func (s *GetAgentOutput) SetAgent(v *Agent) *GetAgentOutput

SetAgent sets the Agent field's value.

func (GetAgentOutput) String

func (s GetAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAgentVersionInput

type GetAgentVersionInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentVersionInput) GoString

func (s GetAgentVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentVersionInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*GetAgentVersionInput) SetAgentVersion

func (s *GetAgentVersionInput) SetAgentVersion(v string) *GetAgentVersionInput

SetAgentVersion sets the AgentVersion field's value.

func (GetAgentVersionInput) String

func (s GetAgentVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentVersionInput) Validate

func (s *GetAgentVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAgentVersionOutput

type GetAgentVersionOutput struct {

	// Contains details about the version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *AgentVersion `locationName:"agentVersion" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetAgentVersionOutput) GoString

func (s GetAgentVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAgentVersionOutput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (GetAgentVersionOutput) String

func (s GetAgentVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDataSourceInput

type GetDataSourceInput struct {

	// The unique identifier of the data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// The unique identifier of the knowledge base that the data source was added
	// to.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDataSourceInput) GoString

func (s GetDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceInput) SetDataSourceId

func (s *GetDataSourceInput) SetDataSourceId(v string) *GetDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*GetDataSourceInput) SetKnowledgeBaseId

func (s *GetDataSourceInput) SetKnowledgeBaseId(v string) *GetDataSourceInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetDataSourceInput) String

func (s GetDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceInput) Validate

func (s *GetDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDataSourceOutput

type GetDataSourceOutput struct {

	// Contains details about the data source.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetDataSourceOutput) GoString

func (s GetDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDataSourceOutput) SetDataSource

func (s *GetDataSourceOutput) SetDataSource(v *DataSource) *GetDataSourceOutput

SetDataSource sets the DataSource field's value.

func (GetDataSourceOutput) String

func (s GetDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetIngestionJobInput

type GetIngestionJobInput struct {

	// The unique identifier of the data source in the ingestion job.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// The unique identifier of the ingestion job.
	//
	// IngestionJobId is a required field
	IngestionJobId *string `location:"uri" locationName:"ingestionJobId" type:"string" required:"true"`

	// The unique identifier of the knowledge base for which the ingestion job applies.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetIngestionJobInput) GoString

func (s GetIngestionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIngestionJobInput) SetDataSourceId

func (s *GetIngestionJobInput) SetDataSourceId(v string) *GetIngestionJobInput

SetDataSourceId sets the DataSourceId field's value.

func (*GetIngestionJobInput) SetIngestionJobId

func (s *GetIngestionJobInput) SetIngestionJobId(v string) *GetIngestionJobInput

SetIngestionJobId sets the IngestionJobId field's value.

func (*GetIngestionJobInput) SetKnowledgeBaseId

func (s *GetIngestionJobInput) SetKnowledgeBaseId(v string) *GetIngestionJobInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetIngestionJobInput) String

func (s GetIngestionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIngestionJobInput) Validate

func (s *GetIngestionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetIngestionJobOutput

type GetIngestionJobOutput struct {

	// Contains details about the ingestion job.
	//
	// IngestionJob is a required field
	IngestionJob *IngestionJob `locationName:"ingestionJob" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetIngestionJobOutput) GoString

func (s GetIngestionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetIngestionJobOutput) SetIngestionJob

SetIngestionJob sets the IngestionJob field's value.

func (GetIngestionJobOutput) String

func (s GetIngestionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetKnowledgeBaseInput

type GetKnowledgeBaseInput struct {

	// The unique identifier of the knowledge base for which to get information.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetKnowledgeBaseInput) GoString

func (s GetKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseInput) SetKnowledgeBaseId

func (s *GetKnowledgeBaseInput) SetKnowledgeBaseId(v string) *GetKnowledgeBaseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetKnowledgeBaseInput) String

func (s GetKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseInput) Validate

func (s *GetKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKnowledgeBaseOutput

type GetKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// KnowledgeBase is a required field
	KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetKnowledgeBaseOutput) GoString

func (s GetKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKnowledgeBaseOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (GetKnowledgeBaseOutput) String

func (s GetKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GuardrailConfiguration

type GuardrailConfiguration struct {

	// The guardrails identifier assigned to the guardrails configuration.
	GuardrailIdentifier *string `locationName:"guardrailIdentifier" type:"string"`

	// The guardrails version assigned to the guardrails configuration.
	GuardrailVersion *string `locationName:"guardrailVersion" type:"string"`
	// contains filtered or unexported fields
}

The details of the guardrails configuration.

func (GuardrailConfiguration) GoString

func (s GuardrailConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GuardrailConfiguration) SetGuardrailIdentifier

func (s *GuardrailConfiguration) SetGuardrailIdentifier(v string) *GuardrailConfiguration

SetGuardrailIdentifier sets the GuardrailIdentifier field's value.

func (*GuardrailConfiguration) SetGuardrailVersion

func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration

SetGuardrailVersion sets the GuardrailVersion field's value.

func (GuardrailConfiguration) String

func (s GuardrailConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InferenceConfiguration

type InferenceConfiguration struct {

	// The maximum number of tokens to allow in the generated response.
	MaximumLength *int64 `locationName:"maximumLength" type:"integer"`

	// A list of stop sequences. A stop sequence is a sequence of characters that
	// causes the model to stop generating the response.
	StopSequences []*string `locationName:"stopSequences" type:"list"`

	// The likelihood of the model selecting higher-probability options while generating
	// a response. A lower value makes the model more likely to choose higher-probability
	// options, while a higher value makes the model more likely to choose lower-probability
	// options.
	Temperature *float64 `locationName:"temperature" type:"float"`

	// While generating a response, the model determines the probability of the
	// following token at each point of generation. The value that you set for topK
	// is the number of most-likely candidates from which the model chooses the
	// next token in the sequence. For example, if you set topK to 50, the model
	// selects the next token from among the top 50 most likely choices.
	TopK *int64 `locationName:"topK" type:"integer"`

	// While generating a response, the model determines the probability of the
	// following token at each point of generation. The value that you set for Top
	// P determines the number of most-likely candidates from which the model chooses
	// the next token in the sequence. For example, if you set topP to 80, the model
	// only selects the next token from the top 80% of the probability distribution
	// of next tokens.
	TopP *float64 `locationName:"topP" type:"float"`
	// contains filtered or unexported fields
}

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).

func (InferenceConfiguration) GoString

func (s InferenceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InferenceConfiguration) SetMaximumLength

func (s *InferenceConfiguration) SetMaximumLength(v int64) *InferenceConfiguration

SetMaximumLength sets the MaximumLength field's value.

func (*InferenceConfiguration) SetStopSequences

func (s *InferenceConfiguration) SetStopSequences(v []*string) *InferenceConfiguration

SetStopSequences sets the StopSequences field's value.

func (*InferenceConfiguration) SetTemperature

SetTemperature sets the Temperature field's value.

func (*InferenceConfiguration) SetTopK

SetTopK sets the TopK field's value.

func (*InferenceConfiguration) SetTopP

SetTopP sets the TopP field's value.

func (InferenceConfiguration) String

func (s InferenceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IngestionJob

type IngestionJob struct {

	// The unique identifier of the ingested data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"`

	// The description of the ingestion job.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A list of reasons that the ingestion job failed.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// The unique identifier of the ingestion job.
	//
	// IngestionJobId is a required field
	IngestionJobId *string `locationName:"ingestionJobId" type:"string" required:"true"`

	// The unique identifier of the knowledge base to which the data source is being
	// added.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The time at which the ingestion job started.
	//
	// StartedAt is a required field
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Contains statistics about the ingestion job.
	Statistics *IngestionJobStatistics `locationName:"statistics" type:"structure"`

	// The status of the ingestion job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"IngestionJobStatus"`

	// The time at which the ingestion job was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

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

This data type is used in the following API operations:

func (IngestionJob) GoString

func (s IngestionJob) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJob) SetDataSourceId

func (s *IngestionJob) SetDataSourceId(v string) *IngestionJob

SetDataSourceId sets the DataSourceId field's value.

func (*IngestionJob) SetDescription

func (s *IngestionJob) SetDescription(v string) *IngestionJob

SetDescription sets the Description field's value.

func (*IngestionJob) SetFailureReasons

func (s *IngestionJob) SetFailureReasons(v []*string) *IngestionJob

SetFailureReasons sets the FailureReasons field's value.

func (*IngestionJob) SetIngestionJobId

func (s *IngestionJob) SetIngestionJobId(v string) *IngestionJob

SetIngestionJobId sets the IngestionJobId field's value.

func (*IngestionJob) SetKnowledgeBaseId

func (s *IngestionJob) SetKnowledgeBaseId(v string) *IngestionJob

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*IngestionJob) SetStartedAt

func (s *IngestionJob) SetStartedAt(v time.Time) *IngestionJob

SetStartedAt sets the StartedAt field's value.

func (*IngestionJob) SetStatistics

func (s *IngestionJob) SetStatistics(v *IngestionJobStatistics) *IngestionJob

SetStatistics sets the Statistics field's value.

func (*IngestionJob) SetStatus

func (s *IngestionJob) SetStatus(v string) *IngestionJob

SetStatus sets the Status field's value.

func (*IngestionJob) SetUpdatedAt

func (s *IngestionJob) SetUpdatedAt(v time.Time) *IngestionJob

SetUpdatedAt sets the UpdatedAt field's value.

func (IngestionJob) String

func (s IngestionJob) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IngestionJobFilter

type IngestionJobFilter struct {

	// The attribute by which to filter the results.
	//
	// Attribute is a required field
	Attribute *string `locationName:"attribute" type:"string" required:"true" enum:"IngestionJobFilterAttribute"`

	// The operation to carry out between the attribute and the values.
	//
	// Operator is a required field
	Operator *string `locationName:"operator" type:"string" required:"true" enum:"IngestionJobFilterOperator"`

	// A list of values for the attribute.
	//
	// Values is a required field
	Values []*string `locationName:"values" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines a filter by which to filter the results.

func (IngestionJobFilter) GoString

func (s IngestionJobFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobFilter) SetAttribute

func (s *IngestionJobFilter) SetAttribute(v string) *IngestionJobFilter

SetAttribute sets the Attribute field's value.

func (*IngestionJobFilter) SetOperator

func (s *IngestionJobFilter) SetOperator(v string) *IngestionJobFilter

SetOperator sets the Operator field's value.

func (*IngestionJobFilter) SetValues

func (s *IngestionJobFilter) SetValues(v []*string) *IngestionJobFilter

SetValues sets the Values field's value.

func (IngestionJobFilter) String

func (s IngestionJobFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobFilter) Validate

func (s *IngestionJobFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IngestionJobSortBy

type IngestionJobSortBy struct {

	// The attribute by which to sort the results.
	//
	// Attribute is a required field
	Attribute *string `locationName:"attribute" type:"string" required:"true" enum:"IngestionJobSortByAttribute"`

	// The order by which to sort the results.
	//
	// Order is a required field
	Order *string `locationName:"order" type:"string" required:"true" enum:"SortOrder"`
	// contains filtered or unexported fields
}

Parameters by which to sort the results.

func (IngestionJobSortBy) GoString

func (s IngestionJobSortBy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobSortBy) SetAttribute

func (s *IngestionJobSortBy) SetAttribute(v string) *IngestionJobSortBy

SetAttribute sets the Attribute field's value.

func (*IngestionJobSortBy) SetOrder

SetOrder sets the Order field's value.

func (IngestionJobSortBy) String

func (s IngestionJobSortBy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobSortBy) Validate

func (s *IngestionJobSortBy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IngestionJobStatistics

type IngestionJobStatistics struct {

	// The number of source documents that was deleted.
	NumberOfDocumentsDeleted *int64 `locationName:"numberOfDocumentsDeleted" type:"long"`

	// The number of source documents that failed to be ingested.
	NumberOfDocumentsFailed *int64 `locationName:"numberOfDocumentsFailed" type:"long"`

	// The total number of source documents that were scanned. Includes new, updated,
	// and unchanged documents.
	NumberOfDocumentsScanned *int64 `locationName:"numberOfDocumentsScanned" type:"long"`

	// The number of metadata files that were updated or deleted.
	NumberOfMetadataDocumentsModified *int64 `locationName:"numberOfMetadataDocumentsModified" type:"long"`

	// The total number of metadata files that were scanned. Includes new, updated,
	// and unchanged files.
	NumberOfMetadataDocumentsScanned *int64 `locationName:"numberOfMetadataDocumentsScanned" type:"long"`

	// The number of modified source documents in the data source that were successfully
	// indexed.
	NumberOfModifiedDocumentsIndexed *int64 `locationName:"numberOfModifiedDocumentsIndexed" type:"long"`

	// The number of new source documents in the data source that were successfully
	// indexed.
	NumberOfNewDocumentsIndexed *int64 `locationName:"numberOfNewDocumentsIndexed" type:"long"`
	// contains filtered or unexported fields
}

Contains the statistics for the ingestion job.

func (IngestionJobStatistics) GoString

func (s IngestionJobStatistics) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobStatistics) SetNumberOfDocumentsDeleted

func (s *IngestionJobStatistics) SetNumberOfDocumentsDeleted(v int64) *IngestionJobStatistics

SetNumberOfDocumentsDeleted sets the NumberOfDocumentsDeleted field's value.

func (*IngestionJobStatistics) SetNumberOfDocumentsFailed

func (s *IngestionJobStatistics) SetNumberOfDocumentsFailed(v int64) *IngestionJobStatistics

SetNumberOfDocumentsFailed sets the NumberOfDocumentsFailed field's value.

func (*IngestionJobStatistics) SetNumberOfDocumentsScanned

func (s *IngestionJobStatistics) SetNumberOfDocumentsScanned(v int64) *IngestionJobStatistics

SetNumberOfDocumentsScanned sets the NumberOfDocumentsScanned field's value.

func (*IngestionJobStatistics) SetNumberOfMetadataDocumentsModified

func (s *IngestionJobStatistics) SetNumberOfMetadataDocumentsModified(v int64) *IngestionJobStatistics

SetNumberOfMetadataDocumentsModified sets the NumberOfMetadataDocumentsModified field's value.

func (*IngestionJobStatistics) SetNumberOfMetadataDocumentsScanned

func (s *IngestionJobStatistics) SetNumberOfMetadataDocumentsScanned(v int64) *IngestionJobStatistics

SetNumberOfMetadataDocumentsScanned sets the NumberOfMetadataDocumentsScanned field's value.

func (*IngestionJobStatistics) SetNumberOfModifiedDocumentsIndexed

func (s *IngestionJobStatistics) SetNumberOfModifiedDocumentsIndexed(v int64) *IngestionJobStatistics

SetNumberOfModifiedDocumentsIndexed sets the NumberOfModifiedDocumentsIndexed field's value.

func (*IngestionJobStatistics) SetNumberOfNewDocumentsIndexed

func (s *IngestionJobStatistics) SetNumberOfNewDocumentsIndexed(v int64) *IngestionJobStatistics

SetNumberOfNewDocumentsIndexed sets the NumberOfNewDocumentsIndexed field's value.

func (IngestionJobStatistics) String

func (s IngestionJobStatistics) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IngestionJobSummary

type IngestionJobSummary struct {

	// The unique identifier of the data source in the ingestion job.
	//
	// DataSourceId is a required field
	DataSourceId *string `locationName:"dataSourceId" type:"string" required:"true"`

	// The description of the ingestion job.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the ingestion job.
	//
	// IngestionJobId is a required field
	IngestionJobId *string `locationName:"ingestionJobId" type:"string" required:"true"`

	// The unique identifier of the knowledge base to which the data source is added.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The time at which the ingestion job was started.
	//
	// StartedAt is a required field
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Contains statistics for the ingestion job.
	Statistics *IngestionJobStatistics `locationName:"statistics" type:"structure"`

	// The status of the ingestion job.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"IngestionJobStatus"`

	// The time at which the ingestion job was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about an ingestion job.

func (IngestionJobSummary) GoString

func (s IngestionJobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IngestionJobSummary) SetDataSourceId

func (s *IngestionJobSummary) SetDataSourceId(v string) *IngestionJobSummary

SetDataSourceId sets the DataSourceId field's value.

func (*IngestionJobSummary) SetDescription

func (s *IngestionJobSummary) SetDescription(v string) *IngestionJobSummary

SetDescription sets the Description field's value.

func (*IngestionJobSummary) SetIngestionJobId

func (s *IngestionJobSummary) SetIngestionJobId(v string) *IngestionJobSummary

SetIngestionJobId sets the IngestionJobId field's value.

func (*IngestionJobSummary) SetKnowledgeBaseId

func (s *IngestionJobSummary) SetKnowledgeBaseId(v string) *IngestionJobSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*IngestionJobSummary) SetStartedAt

func (s *IngestionJobSummary) SetStartedAt(v time.Time) *IngestionJobSummary

SetStartedAt sets the StartedAt field's value.

func (*IngestionJobSummary) SetStatistics

SetStatistics sets the Statistics field's value.

func (*IngestionJobSummary) SetStatus

SetStatus sets the Status field's value.

func (*IngestionJobSummary) SetUpdatedAt

func (s *IngestionJobSummary) SetUpdatedAt(v time.Time) *IngestionJobSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (IngestionJobSummary) String

func (s IngestionJobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBase

type KnowledgeBase struct {

	// The time at which the knowledge base was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the knowledge base.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A list of reasons that the API operation on the knowledge base failed.
	FailureReasons []*string `locationName:"failureReasons" type:"list"`

	// The Amazon Resource Name (ARN) of the knowledge base.
	//
	// KnowledgeBaseArn is a required field
	KnowledgeBaseArn *string `locationName:"knowledgeBaseArn" type:"string" required:"true"`

	// Contains details about the embeddings configuration of the knowledge base.
	//
	// KnowledgeBaseConfiguration is a required field
	KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"`

	// The unique identifier of the knowledge base.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The name of the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the knowledge base.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The status of the knowledge base. The following statuses are possible:
	//
	//    * CREATING – The knowledge base is being created.
	//
	//    * ACTIVE – The knowledge base is ready to be queried.
	//
	//    * DELETING – The knowledge base is being deleted.
	//
	//    * UPDATING – The knowledge base is being updated.
	//
	//    * FAILED – The knowledge base API operation failed.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"`

	// Contains details about the storage configuration of the knowledge base.
	//
	// StorageConfiguration is a required field
	StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"`

	// The time at which the knowledge base was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a knowledge base.

func (KnowledgeBase) GoString

func (s KnowledgeBase) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBase) SetCreatedAt

func (s *KnowledgeBase) SetCreatedAt(v time.Time) *KnowledgeBase

SetCreatedAt sets the CreatedAt field's value.

func (*KnowledgeBase) SetDescription

func (s *KnowledgeBase) SetDescription(v string) *KnowledgeBase

SetDescription sets the Description field's value.

func (*KnowledgeBase) SetFailureReasons

func (s *KnowledgeBase) SetFailureReasons(v []*string) *KnowledgeBase

SetFailureReasons sets the FailureReasons field's value.

func (*KnowledgeBase) SetKnowledgeBaseArn

func (s *KnowledgeBase) SetKnowledgeBaseArn(v string) *KnowledgeBase

SetKnowledgeBaseArn sets the KnowledgeBaseArn field's value.

func (*KnowledgeBase) SetKnowledgeBaseConfiguration

func (s *KnowledgeBase) SetKnowledgeBaseConfiguration(v *KnowledgeBaseConfiguration) *KnowledgeBase

SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.

func (*KnowledgeBase) SetKnowledgeBaseId

func (s *KnowledgeBase) SetKnowledgeBaseId(v string) *KnowledgeBase

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBase) SetName

func (s *KnowledgeBase) SetName(v string) *KnowledgeBase

SetName sets the Name field's value.

func (*KnowledgeBase) SetRoleArn

func (s *KnowledgeBase) SetRoleArn(v string) *KnowledgeBase

SetRoleArn sets the RoleArn field's value.

func (*KnowledgeBase) SetStatus

func (s *KnowledgeBase) SetStatus(v string) *KnowledgeBase

SetStatus sets the Status field's value.

func (*KnowledgeBase) SetStorageConfiguration

func (s *KnowledgeBase) SetStorageConfiguration(v *StorageConfiguration) *KnowledgeBase

SetStorageConfiguration sets the StorageConfiguration field's value.

func (*KnowledgeBase) SetUpdatedAt

func (s *KnowledgeBase) SetUpdatedAt(v time.Time) *KnowledgeBase

SetUpdatedAt sets the UpdatedAt field's value.

func (KnowledgeBase) String

func (s KnowledgeBase) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KnowledgeBaseConfiguration

type KnowledgeBaseConfiguration struct {

	// The type of data that the data source is converted into for the knowledge
	// base.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"KnowledgeBaseType"`

	// Contains details about the embeddings model that'sused to convert the data
	// source.
	VectorKnowledgeBaseConfiguration *VectorKnowledgeBaseConfiguration `locationName:"vectorKnowledgeBaseConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Contains details about the embeddings configuration of the knowledge base.

func (KnowledgeBaseConfiguration) GoString

func (s KnowledgeBaseConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseConfiguration) SetType

SetType sets the Type field's value.

func (*KnowledgeBaseConfiguration) SetVectorKnowledgeBaseConfiguration

SetVectorKnowledgeBaseConfiguration sets the VectorKnowledgeBaseConfiguration field's value.

func (KnowledgeBaseConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseConfiguration) Validate

func (s *KnowledgeBaseConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type KnowledgeBaseSummary

type KnowledgeBaseSummary struct {

	// The description of the knowledge base.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `locationName:"knowledgeBaseId" type:"string" required:"true"`

	// The name of the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the knowledge base.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"KnowledgeBaseStatus"`

	// The time at which the knowledge base was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Contains details about a knowledge base.

func (KnowledgeBaseSummary) GoString

func (s KnowledgeBaseSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KnowledgeBaseSummary) SetDescription

func (s *KnowledgeBaseSummary) SetDescription(v string) *KnowledgeBaseSummary

SetDescription sets the Description field's value.

func (*KnowledgeBaseSummary) SetKnowledgeBaseId

func (s *KnowledgeBaseSummary) SetKnowledgeBaseId(v string) *KnowledgeBaseSummary

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseSummary) SetName

SetName sets the Name field's value.

func (*KnowledgeBaseSummary) SetStatus

SetStatus sets the Status field's value.

func (*KnowledgeBaseSummary) SetUpdatedAt

func (s *KnowledgeBaseSummary) SetUpdatedAt(v time.Time) *KnowledgeBaseSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (KnowledgeBaseSummary) String

func (s KnowledgeBaseSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAgentActionGroupsInput

type ListAgentActionGroupsInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentActionGroupsInput) GoString

func (s ListAgentActionGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentActionGroupsInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*ListAgentActionGroupsInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*ListAgentActionGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAgentActionGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentActionGroupsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentActionGroupsInput) Validate

func (s *ListAgentActionGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgentActionGroupsOutput

type ListAgentActionGroupsOutput struct {

	// A list of objects, each of which contains information about an action group.
	//
	// ActionGroupSummaries is a required field
	ActionGroupSummaries []*ActionGroupSummary `locationName:"actionGroupSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentActionGroupsOutput) GoString

func (s ListAgentActionGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentActionGroupsOutput) SetActionGroupSummaries

SetActionGroupSummaries sets the ActionGroupSummaries field's value.

func (*ListAgentActionGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentActionGroupsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAgentAliasesInput

type ListAgentAliasesInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentAliasesInput) GoString

func (s ListAgentAliasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentAliasesInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*ListAgentAliasesInput) SetMaxResults

func (s *ListAgentAliasesInput) SetMaxResults(v int64) *ListAgentAliasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgentAliasesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentAliasesInput) String

func (s ListAgentAliasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentAliasesInput) Validate

func (s *ListAgentAliasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgentAliasesOutput

type ListAgentAliasesOutput struct {

	// A list of objects, each of which contains information about an alias of the
	// agent.
	//
	// AgentAliasSummaries is a required field
	AgentAliasSummaries []*AgentAliasSummary `locationName:"agentAliasSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentAliasesOutput) GoString

func (s ListAgentAliasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentAliasesOutput) SetAgentAliasSummaries

func (s *ListAgentAliasesOutput) SetAgentAliasSummaries(v []*AgentAliasSummary) *ListAgentAliasesOutput

SetAgentAliasSummaries sets the AgentAliasSummaries field's value.

func (*ListAgentAliasesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentAliasesOutput) String

func (s ListAgentAliasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAgentKnowledgeBasesInput

type ListAgentKnowledgeBasesInput struct {

	// The unique identifier of the agent for which to return information about
	// knowledge bases associated with it.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent for which to return information about knowledge
	// bases associated with it.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentKnowledgeBasesInput) GoString

func (s ListAgentKnowledgeBasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentKnowledgeBasesInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*ListAgentKnowledgeBasesInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*ListAgentKnowledgeBasesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAgentKnowledgeBasesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentKnowledgeBasesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentKnowledgeBasesInput) Validate

func (s *ListAgentKnowledgeBasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgentKnowledgeBasesOutput

type ListAgentKnowledgeBasesOutput struct {

	// A list of objects, each of which contains information about a knowledge base
	// associated with the agent.
	//
	// AgentKnowledgeBaseSummaries is a required field
	AgentKnowledgeBaseSummaries []*AgentKnowledgeBaseSummary `locationName:"agentKnowledgeBaseSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentKnowledgeBasesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentKnowledgeBasesOutput) SetAgentKnowledgeBaseSummaries

SetAgentKnowledgeBaseSummaries sets the AgentKnowledgeBaseSummaries field's value.

func (*ListAgentKnowledgeBasesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentKnowledgeBasesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAgentVersionsInput

type ListAgentVersionsInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentVersionsInput) GoString

func (s ListAgentVersionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentVersionsInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*ListAgentVersionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAgentVersionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentVersionsInput) String

func (s ListAgentVersionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentVersionsInput) Validate

func (s *ListAgentVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgentVersionsOutput

type ListAgentVersionsOutput struct {

	// A list of objects, each of which contains information about a version of
	// the agent.
	//
	// AgentVersionSummaries is a required field
	AgentVersionSummaries []*AgentVersionSummary `locationName:"agentVersionSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentVersionsOutput) GoString

func (s ListAgentVersionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentVersionsOutput) SetAgentVersionSummaries

func (s *ListAgentVersionsOutput) SetAgentVersionSummaries(v []*AgentVersionSummary) *ListAgentVersionsOutput

SetAgentVersionSummaries sets the AgentVersionSummaries field's value.

func (*ListAgentVersionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAgentVersionsOutput) String

func (s ListAgentVersionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentsInput) GoString

func (s ListAgentsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentsInput) SetMaxResults

func (s *ListAgentsInput) SetMaxResults(v int64) *ListAgentsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgentsInput) SetNextToken

func (s *ListAgentsInput) SetNextToken(v string) *ListAgentsInput

SetNextToken sets the NextToken field's value.

func (ListAgentsInput) String

func (s ListAgentsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentsInput) Validate

func (s *ListAgentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAgentsOutput

type ListAgentsOutput struct {

	// A list of objects, each of which contains information about an agent.
	//
	// AgentSummaries is a required field
	AgentSummaries []*AgentSummary `locationName:"agentSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAgentsOutput) GoString

func (s ListAgentsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAgentsOutput) SetAgentSummaries

func (s *ListAgentsOutput) SetAgentSummaries(v []*AgentSummary) *ListAgentsOutput

SetAgentSummaries sets the AgentSummaries field's value.

func (*ListAgentsOutput) SetNextToken

func (s *ListAgentsOutput) SetNextToken(v string) *ListAgentsOutput

SetNextToken sets the NextToken field's value.

func (ListAgentsOutput) String

func (s ListAgentsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDataSourcesInput

type ListDataSourcesInput struct {

	// The unique identifier of the knowledge base for which to return a list of
	// information.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourcesInput) GoString

func (s ListDataSourcesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) SetKnowledgeBaseId

func (s *ListDataSourcesInput) SetKnowledgeBaseId(v string) *ListDataSourcesInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ListDataSourcesInput) SetMaxResults

func (s *ListDataSourcesInput) SetMaxResults(v int64) *ListDataSourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDataSourcesInput) SetNextToken

func (s *ListDataSourcesInput) SetNextToken(v string) *ListDataSourcesInput

SetNextToken sets the NextToken field's value.

func (ListDataSourcesInput) String

func (s ListDataSourcesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesInput) Validate

func (s *ListDataSourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDataSourcesOutput

type ListDataSourcesOutput struct {

	// A list of objects, each of which contains information about a data source.
	//
	// DataSourceSummaries is a required field
	DataSourceSummaries []*DataSourceSummary `locationName:"dataSourceSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDataSourcesOutput) GoString

func (s ListDataSourcesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDataSourcesOutput) SetDataSourceSummaries

func (s *ListDataSourcesOutput) SetDataSourceSummaries(v []*DataSourceSummary) *ListDataSourcesOutput

SetDataSourceSummaries sets the DataSourceSummaries field's value.

func (*ListDataSourcesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDataSourcesOutput) String

func (s ListDataSourcesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListIngestionJobsInput

type ListIngestionJobsInput struct {

	// The unique identifier of the data source for which to return ingestion jobs.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// Contains a definition of a filter for which to filter the results.
	Filters []*IngestionJobFilter `locationName:"filters" min:"1" type:"list"`

	// The unique identifier of the knowledge base for which to return ingestion
	// jobs.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// Contains details about how to sort the results.
	SortBy *IngestionJobSortBy `locationName:"sortBy" type:"structure"`
	// contains filtered or unexported fields
}

func (ListIngestionJobsInput) GoString

func (s ListIngestionJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIngestionJobsInput) SetDataSourceId

func (s *ListIngestionJobsInput) SetDataSourceId(v string) *ListIngestionJobsInput

SetDataSourceId sets the DataSourceId field's value.

func (*ListIngestionJobsInput) SetFilters

SetFilters sets the Filters field's value.

func (*ListIngestionJobsInput) SetKnowledgeBaseId

func (s *ListIngestionJobsInput) SetKnowledgeBaseId(v string) *ListIngestionJobsInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*ListIngestionJobsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListIngestionJobsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListIngestionJobsInput) SetSortBy

SetSortBy sets the SortBy field's value.

func (ListIngestionJobsInput) String

func (s ListIngestionJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIngestionJobsInput) Validate

func (s *ListIngestionJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIngestionJobsOutput

type ListIngestionJobsOutput struct {

	// A list of objects, each of which contains information about an ingestion
	// job.
	//
	// IngestionJobSummaries is a required field
	IngestionJobSummaries []*IngestionJobSummary `locationName:"ingestionJobSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListIngestionJobsOutput) GoString

func (s ListIngestionJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListIngestionJobsOutput) SetIngestionJobSummaries

func (s *ListIngestionJobsOutput) SetIngestionJobSummaries(v []*IngestionJobSummary) *ListIngestionJobsOutput

SetIngestionJobSummaries sets the IngestionJobSummaries field's value.

func (*ListIngestionJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListIngestionJobsOutput) String

func (s ListIngestionJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKnowledgeBasesInput) GoString

func (s ListKnowledgeBasesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListKnowledgeBasesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListKnowledgeBasesInput) String

func (s ListKnowledgeBasesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesInput) Validate

func (s *ListKnowledgeBasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKnowledgeBasesOutput

type ListKnowledgeBasesOutput struct {

	// A list of objects, each of which contains information about a knowledge base.
	//
	// KnowledgeBaseSummaries is a required field
	KnowledgeBaseSummaries []*KnowledgeBaseSummary `locationName:"knowledgeBaseSummaries" type:"list" required:"true"`

	// 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 `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKnowledgeBasesOutput) GoString

func (s ListKnowledgeBasesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKnowledgeBasesOutput) SetKnowledgeBaseSummaries

func (s *ListKnowledgeBasesOutput) SetKnowledgeBaseSummaries(v []*KnowledgeBaseSummary) *ListKnowledgeBasesOutput

SetKnowledgeBaseSummaries sets the KnowledgeBaseSummaries field's value.

func (*ListKnowledgeBasesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListKnowledgeBasesOutput) String

func (s ListKnowledgeBasesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource for which to list tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The key-value pairs for the tags associated with the resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MongoDbAtlasConfiguration

type MongoDbAtlasConfiguration struct {

	// The collection name of the knowledge base in MongoDB Atlas.
	//
	// CollectionName is a required field
	CollectionName *string `locationName:"collectionName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that contains user credentials for your MongoDB Atlas cluster.
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The database name in your MongoDB Atlas cluster for your knowledge base.
	//
	// DatabaseName is a required field
	DatabaseName *string `locationName:"databaseName" type:"string" required:"true"`

	// The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
	//
	// Endpoint is a required field
	Endpoint *string `locationName:"endpoint" type:"string" required:"true"`

	// The name of the VPC endpoint service in your account that is connected to
	// your MongoDB Atlas cluster.
	EndpointServiceName *string `locationName:"endpointServiceName" min:"1" type:"string"`

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// FieldMapping is a required field
	FieldMapping *MongoDbAtlasFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"`

	// The name of the MongoDB Atlas vector search index.
	//
	// VectorIndexName is a required field
	VectorIndexName *string `locationName:"vectorIndexName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (MongoDbAtlasConfiguration) GoString

func (s MongoDbAtlasConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MongoDbAtlasConfiguration) SetCollectionName

SetCollectionName sets the CollectionName field's value.

func (*MongoDbAtlasConfiguration) SetCredentialsSecretArn

func (s *MongoDbAtlasConfiguration) SetCredentialsSecretArn(v string) *MongoDbAtlasConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*MongoDbAtlasConfiguration) SetDatabaseName

SetDatabaseName sets the DatabaseName field's value.

func (*MongoDbAtlasConfiguration) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*MongoDbAtlasConfiguration) SetEndpointServiceName

func (s *MongoDbAtlasConfiguration) SetEndpointServiceName(v string) *MongoDbAtlasConfiguration

SetEndpointServiceName sets the EndpointServiceName field's value.

func (*MongoDbAtlasConfiguration) SetFieldMapping

SetFieldMapping sets the FieldMapping field's value.

func (*MongoDbAtlasConfiguration) SetVectorIndexName

SetVectorIndexName sets the VectorIndexName field's value.

func (MongoDbAtlasConfiguration) String

func (s MongoDbAtlasConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MongoDbAtlasConfiguration) Validate

func (s *MongoDbAtlasConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MongoDbAtlasFieldMapping

type MongoDbAtlasFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// MetadataField is a required field
	MetadataField *string `locationName:"metadataField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the raw text from your
	// data. The text is split according to the chunking strategy you choose.
	//
	// TextField is a required field
	TextField *string `locationName:"textField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the vector embeddings
	// for your data sources.
	//
	// VectorField is a required field
	VectorField *string `locationName:"vectorField" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (MongoDbAtlasFieldMapping) GoString

func (s MongoDbAtlasFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MongoDbAtlasFieldMapping) SetMetadataField

SetMetadataField sets the MetadataField field's value.

func (*MongoDbAtlasFieldMapping) SetTextField

SetTextField sets the TextField field's value.

func (*MongoDbAtlasFieldMapping) SetVectorField

SetVectorField sets the VectorField field's value.

func (MongoDbAtlasFieldMapping) String

func (s MongoDbAtlasFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MongoDbAtlasFieldMapping) Validate

func (s *MongoDbAtlasFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OpenSearchServerlessConfiguration

type OpenSearchServerlessConfiguration struct {

	// The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
	//
	// CollectionArn is a required field
	CollectionArn *string `locationName:"collectionArn" type:"string" required:"true"`

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// FieldMapping is a required field
	FieldMapping *OpenSearchServerlessFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"`

	// The name of the vector store.
	//
	// VectorIndexName is a required field
	VectorIndexName *string `locationName:"vectorIndexName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).

func (OpenSearchServerlessConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchServerlessConfiguration) SetCollectionArn

SetCollectionArn sets the CollectionArn field's value.

func (*OpenSearchServerlessConfiguration) SetFieldMapping

SetFieldMapping sets the FieldMapping field's value.

func (*OpenSearchServerlessConfiguration) SetVectorIndexName

SetVectorIndexName sets the VectorIndexName field's value.

func (OpenSearchServerlessConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchServerlessConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type OpenSearchServerlessFieldMapping

type OpenSearchServerlessFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// MetadataField is a required field
	MetadataField *string `locationName:"metadataField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the raw text from your
	// data. The text is split according to the chunking strategy you choose.
	//
	// TextField is a required field
	TextField *string `locationName:"textField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the vector embeddings
	// for your data sources.
	//
	// VectorField is a required field
	VectorField *string `locationName:"vectorField" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (OpenSearchServerlessFieldMapping) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchServerlessFieldMapping) SetMetadataField

SetMetadataField sets the MetadataField field's value.

func (*OpenSearchServerlessFieldMapping) SetTextField

SetTextField sets the TextField field's value.

func (*OpenSearchServerlessFieldMapping) SetVectorField

SetVectorField sets the VectorField field's value.

func (OpenSearchServerlessFieldMapping) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*OpenSearchServerlessFieldMapping) Validate

Validate inspects the fields of the type to determine if they are valid.

type ParameterDetail

type ParameterDetail struct {

	// A description of the parameter. Helps the foundation model determine how
	// to elicit the parameters from the user.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Whether the parameter is required for the agent to complete the function
	// for action group invocation.
	Required *bool `locationName:"required" type:"boolean"`

	// The data type of the parameter.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"Type"`
	// contains filtered or unexported fields
}

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

This data type is used in the following API operations:

func (ParameterDetail) GoString

func (s ParameterDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterDetail) SetDescription

func (s *ParameterDetail) SetDescription(v string) *ParameterDetail

SetDescription sets the Description field's value.

func (*ParameterDetail) SetRequired

func (s *ParameterDetail) SetRequired(v bool) *ParameterDetail

SetRequired sets the Required field's value.

func (*ParameterDetail) SetType

func (s *ParameterDetail) SetType(v string) *ParameterDetail

SetType sets the Type field's value.

func (ParameterDetail) String

func (s ParameterDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ParameterDetail) Validate

func (s *ParameterDetail) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PineconeConfiguration

type PineconeConfiguration struct {

	// The endpoint URL for your index management page.
	//
	// ConnectionString is a required field
	ConnectionString *string `locationName:"connectionString" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Pinecone API key.
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// FieldMapping is a required field
	FieldMapping *PineconeFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"`

	// The namespace to be used to write new data to your database.
	Namespace *string `locationName:"namespace" type:"string"`
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html).

func (PineconeConfiguration) GoString

func (s PineconeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PineconeConfiguration) SetConnectionString

func (s *PineconeConfiguration) SetConnectionString(v string) *PineconeConfiguration

SetConnectionString sets the ConnectionString field's value.

func (*PineconeConfiguration) SetCredentialsSecretArn

func (s *PineconeConfiguration) SetCredentialsSecretArn(v string) *PineconeConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*PineconeConfiguration) SetFieldMapping

SetFieldMapping sets the FieldMapping field's value.

func (*PineconeConfiguration) SetNamespace

SetNamespace sets the Namespace field's value.

func (PineconeConfiguration) String

func (s PineconeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PineconeConfiguration) Validate

func (s *PineconeConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PineconeFieldMapping

type PineconeFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// MetadataField is a required field
	MetadataField *string `locationName:"metadataField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the raw text from your
	// data. The text is split according to the chunking strategy you choose.
	//
	// TextField is a required field
	TextField *string `locationName:"textField" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (PineconeFieldMapping) GoString

func (s PineconeFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PineconeFieldMapping) SetMetadataField

func (s *PineconeFieldMapping) SetMetadataField(v string) *PineconeFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*PineconeFieldMapping) SetTextField

func (s *PineconeFieldMapping) SetTextField(v string) *PineconeFieldMapping

SetTextField sets the TextField field's value.

func (PineconeFieldMapping) String

func (s PineconeFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PineconeFieldMapping) Validate

func (s *PineconeFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PrepareAgentInput

type PrepareAgentInput struct {

	// The unique identifier of the agent for which to create a DRAFT version.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PrepareAgentInput) GoString

func (s PrepareAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PrepareAgentInput) SetAgentId

func (s *PrepareAgentInput) SetAgentId(v string) *PrepareAgentInput

SetAgentId sets the AgentId field's value.

func (PrepareAgentInput) String

func (s PrepareAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PrepareAgentInput) Validate

func (s *PrepareAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PrepareAgentOutput

type PrepareAgentOutput struct {

	// The unique identifier of the agent for which the DRAFT version was created.
	//
	// AgentId is a required field
	AgentId *string `locationName:"agentId" type:"string" required:"true"`

	// The status of the DRAFT version and whether it is ready for use.
	//
	// AgentStatus is a required field
	AgentStatus *string `locationName:"agentStatus" type:"string" required:"true" enum:"AgentStatus"`

	// The version of the agent.
	//
	// AgentVersion is a required field
	AgentVersion *string `locationName:"agentVersion" min:"1" type:"string" required:"true"`

	// The time at which the DRAFT version of the agent was last prepared.
	//
	// PreparedAt is a required field
	PreparedAt *time.Time `locationName:"preparedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

func (PrepareAgentOutput) GoString

func (s PrepareAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PrepareAgentOutput) SetAgentId

func (s *PrepareAgentOutput) SetAgentId(v string) *PrepareAgentOutput

SetAgentId sets the AgentId field's value.

func (*PrepareAgentOutput) SetAgentStatus

func (s *PrepareAgentOutput) SetAgentStatus(v string) *PrepareAgentOutput

SetAgentStatus sets the AgentStatus field's value.

func (*PrepareAgentOutput) SetAgentVersion

func (s *PrepareAgentOutput) SetAgentVersion(v string) *PrepareAgentOutput

SetAgentVersion sets the AgentVersion field's value.

func (*PrepareAgentOutput) SetPreparedAt

func (s *PrepareAgentOutput) SetPreparedAt(v time.Time) *PrepareAgentOutput

SetPreparedAt sets the PreparedAt field's value.

func (PrepareAgentOutput) String

func (s PrepareAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PromptConfiguration

type PromptConfiguration struct {

	// Defines the prompt template with which to replace the default prompt template.
	// You can use placeholder variables in the base prompt template to customize
	// the prompt. For more information, see Prompt template placeholder variables
	// (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html).
	// For more information, see Configure the prompt templates (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html).
	BasePromptTemplate *string `locationName:"basePromptTemplate" min:"1" type:"string"`

	// Contains inference parameters to use when the agent invokes a foundation
	// model in the part of the agent sequence defined by the promptType. For more
	// information, see Inference parameters for foundation models (https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
	InferenceConfiguration *InferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`

	// Specifies whether to override the default parser Lambda function when parsing
	// the raw foundation model output in the part of the agent sequence defined
	// by the promptType. If you set the field as OVERRIDEN, the overrideLambda
	// field in the PromptOverrideConfiguration (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html)
	// must be specified with the ARN of a Lambda function.
	ParserMode *string `locationName:"parserMode" type:"string" enum:"CreationMode"`

	// Specifies whether to override the default prompt template for this promptType.
	// Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate.
	// If you leave it as DEFAULT, the agent uses a default prompt template.
	PromptCreationMode *string `locationName:"promptCreationMode" type:"string" enum:"CreationMode"`

	// Specifies whether to allow the agent to carry out the step specified in the
	// promptType. If you set this value to DISABLED, the agent skips that step.
	// The default state for each promptType is as follows.
	//
	//    * PRE_PROCESSING – ENABLED
	//
	//    * ORCHESTRATION – ENABLED
	//
	//    * KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
	//
	//    * POST_PROCESSING – DISABLED
	PromptState *string `locationName:"promptState" type:"string" enum:"PromptState"`

	// The step in the agent sequence that this prompt configuration applies to.
	PromptType *string `locationName:"promptType" type:"string" enum:"PromptType"`
	// contains filtered or unexported fields
}

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).

func (PromptConfiguration) GoString

func (s PromptConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptConfiguration) SetBasePromptTemplate

func (s *PromptConfiguration) SetBasePromptTemplate(v string) *PromptConfiguration

SetBasePromptTemplate sets the BasePromptTemplate field's value.

func (*PromptConfiguration) SetInferenceConfiguration

func (s *PromptConfiguration) SetInferenceConfiguration(v *InferenceConfiguration) *PromptConfiguration

SetInferenceConfiguration sets the InferenceConfiguration field's value.

func (*PromptConfiguration) SetParserMode

func (s *PromptConfiguration) SetParserMode(v string) *PromptConfiguration

SetParserMode sets the ParserMode field's value.

func (*PromptConfiguration) SetPromptCreationMode

func (s *PromptConfiguration) SetPromptCreationMode(v string) *PromptConfiguration

SetPromptCreationMode sets the PromptCreationMode field's value.

func (*PromptConfiguration) SetPromptState

func (s *PromptConfiguration) SetPromptState(v string) *PromptConfiguration

SetPromptState sets the PromptState field's value.

func (*PromptConfiguration) SetPromptType

func (s *PromptConfiguration) SetPromptType(v string) *PromptConfiguration

SetPromptType sets the PromptType field's value.

func (PromptConfiguration) String

func (s PromptConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptConfiguration) Validate

func (s *PromptConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PromptOverrideConfiguration

type PromptOverrideConfiguration struct {

	// The ARN of the Lambda function to use when parsing the raw foundation model
	// output in parts of the agent sequence. If you specify this field, at least
	// one of the promptConfigurations must contain a parserMode value that is set
	// to OVERRIDDEN. For more information, see Parser Lambda function in Agents
	// for Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html).
	OverrideLambda *string `locationName:"overrideLambda" type:"string"`

	// Contains configurations to override a prompt template in one part of an agent
	// sequence. For more information, see Advanced prompts (https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
	//
	// PromptConfigurations is a required field
	PromptConfigurations []*PromptConfiguration `locationName:"promptConfigurations" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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).

func (PromptOverrideConfiguration) GoString

func (s PromptOverrideConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptOverrideConfiguration) SetOverrideLambda

SetOverrideLambda sets the OverrideLambda field's value.

func (*PromptOverrideConfiguration) SetPromptConfigurations

SetPromptConfigurations sets the PromptConfigurations field's value.

func (PromptOverrideConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PromptOverrideConfiguration) Validate

func (s *PromptOverrideConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RdsConfiguration

type RdsConfiguration struct {

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Amazon RDS database.
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The name of your Amazon RDS database.
	//
	// DatabaseName is a required field
	DatabaseName *string `locationName:"databaseName" type:"string" required:"true"`

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// FieldMapping is a required field
	FieldMapping *RdsFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the vector store.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The name of the table in the database.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).

func (RdsConfiguration) GoString

func (s RdsConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RdsConfiguration) SetCredentialsSecretArn

func (s *RdsConfiguration) SetCredentialsSecretArn(v string) *RdsConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*RdsConfiguration) SetDatabaseName

func (s *RdsConfiguration) SetDatabaseName(v string) *RdsConfiguration

SetDatabaseName sets the DatabaseName field's value.

func (*RdsConfiguration) SetFieldMapping

func (s *RdsConfiguration) SetFieldMapping(v *RdsFieldMapping) *RdsConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*RdsConfiguration) SetResourceArn

func (s *RdsConfiguration) SetResourceArn(v string) *RdsConfiguration

SetResourceArn sets the ResourceArn field's value.

func (*RdsConfiguration) SetTableName

func (s *RdsConfiguration) SetTableName(v string) *RdsConfiguration

SetTableName sets the TableName field's value.

func (RdsConfiguration) String

func (s RdsConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RdsConfiguration) Validate

func (s *RdsConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RdsFieldMapping

type RdsFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// MetadataField is a required field
	MetadataField *string `locationName:"metadataField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the ID for each entry.
	//
	// PrimaryKeyField is a required field
	PrimaryKeyField *string `locationName:"primaryKeyField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the raw text from your
	// data. The text is split according to the chunking strategy you choose.
	//
	// TextField is a required field
	TextField *string `locationName:"textField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the vector embeddings
	// for your data sources.
	//
	// VectorField is a required field
	VectorField *string `locationName:"vectorField" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (RdsFieldMapping) GoString

func (s RdsFieldMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RdsFieldMapping) SetMetadataField

func (s *RdsFieldMapping) SetMetadataField(v string) *RdsFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*RdsFieldMapping) SetPrimaryKeyField

func (s *RdsFieldMapping) SetPrimaryKeyField(v string) *RdsFieldMapping

SetPrimaryKeyField sets the PrimaryKeyField field's value.

func (*RdsFieldMapping) SetTextField

func (s *RdsFieldMapping) SetTextField(v string) *RdsFieldMapping

SetTextField sets the TextField field's value.

func (*RdsFieldMapping) SetVectorField

func (s *RdsFieldMapping) SetVectorField(v string) *RdsFieldMapping

SetVectorField sets the VectorField field's value.

func (RdsFieldMapping) String

func (s RdsFieldMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RdsFieldMapping) Validate

func (s *RdsFieldMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RedisEnterpriseCloudConfiguration

type RedisEnterpriseCloudConfiguration struct {

	// The Amazon Resource Name (ARN) of the secret that you created in Secrets
	// Manager that is linked to your Redis Enterprise Cloud database.
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The endpoint URL of the Redis Enterprise Cloud database.
	//
	// Endpoint is a required field
	Endpoint *string `locationName:"endpoint" type:"string" required:"true"`

	// Contains the names of the fields to which to map information about the vector
	// store.
	//
	// FieldMapping is a required field
	FieldMapping *RedisEnterpriseCloudFieldMapping `locationName:"fieldMapping" type:"structure" required:"true"`

	// The name of the vector index.
	//
	// VectorIndexName is a required field
	VectorIndexName *string `locationName:"vectorIndexName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).

func (RedisEnterpriseCloudConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedisEnterpriseCloudConfiguration) SetCredentialsSecretArn

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*RedisEnterpriseCloudConfiguration) SetEndpoint

SetEndpoint sets the Endpoint field's value.

func (*RedisEnterpriseCloudConfiguration) SetFieldMapping

SetFieldMapping sets the FieldMapping field's value.

func (*RedisEnterpriseCloudConfiguration) SetVectorIndexName

SetVectorIndexName sets the VectorIndexName field's value.

func (RedisEnterpriseCloudConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedisEnterpriseCloudConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type RedisEnterpriseCloudFieldMapping

type RedisEnterpriseCloudFieldMapping struct {

	// The name of the field in which Amazon Bedrock stores metadata about the vector
	// store.
	//
	// MetadataField is a required field
	MetadataField *string `locationName:"metadataField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the raw text from your
	// data. The text is split according to the chunking strategy you choose.
	//
	// TextField is a required field
	TextField *string `locationName:"textField" type:"string" required:"true"`

	// The name of the field in which Amazon Bedrock stores the vector embeddings
	// for your data sources.
	//
	// VectorField is a required field
	VectorField *string `locationName:"vectorField" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (RedisEnterpriseCloudFieldMapping) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedisEnterpriseCloudFieldMapping) SetMetadataField

SetMetadataField sets the MetadataField field's value.

func (*RedisEnterpriseCloudFieldMapping) SetTextField

SetTextField sets the TextField field's value.

func (*RedisEnterpriseCloudFieldMapping) SetVectorField

SetVectorField sets the VectorField field's value.

func (RedisEnterpriseCloudFieldMapping) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RedisEnterpriseCloudFieldMapping) Validate

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3DataSourceConfiguration

type S3DataSourceConfiguration struct {

	// The Amazon Resource Name (ARN) of the bucket that contains the data source.
	//
	// BucketArn is a required field
	BucketArn *string `locationName:"bucketArn" min:"1" type:"string" required:"true"`

	// The bucket account owner ID for the S3 bucket.
	BucketOwnerAccountId *string `locationName:"bucketOwnerAccountId" min:"12" type:"string"`

	// A list of S3 prefixes that define the object containing the data sources.
	// For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html).
	InclusionPrefixes []*string `locationName:"inclusionPrefixes" min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains information about the S3 configuration of the data source.

func (S3DataSourceConfiguration) GoString

func (s S3DataSourceConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) SetBucketArn

SetBucketArn sets the BucketArn field's value.

func (*S3DataSourceConfiguration) SetBucketOwnerAccountId

func (s *S3DataSourceConfiguration) SetBucketOwnerAccountId(v string) *S3DataSourceConfiguration

SetBucketOwnerAccountId sets the BucketOwnerAccountId field's value.

func (*S3DataSourceConfiguration) SetInclusionPrefixes

func (s *S3DataSourceConfiguration) SetInclusionPrefixes(v []*string) *S3DataSourceConfiguration

SetInclusionPrefixes sets the InclusionPrefixes field's value.

func (S3DataSourceConfiguration) String

func (s S3DataSourceConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3DataSourceConfiguration) Validate

func (s *S3DataSourceConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type S3Identifier

type S3Identifier struct {

	// The name of the S3 bucket.
	S3BucketName *string `locationName:"s3BucketName" min:"3" type:"string"`

	// The S3 object key containing the resource.
	S3ObjectKey *string `locationName:"s3ObjectKey" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the S3 object containing the resource.

func (S3Identifier) GoString

func (s S3Identifier) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Identifier) SetS3BucketName

func (s *S3Identifier) SetS3BucketName(v string) *S3Identifier

SetS3BucketName sets the S3BucketName field's value.

func (*S3Identifier) SetS3ObjectKey

func (s *S3Identifier) SetS3ObjectKey(v string) *S3Identifier

SetS3ObjectKey sets the S3ObjectKey field's value.

func (S3Identifier) String

func (s S3Identifier) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Identifier) Validate

func (s *S3Identifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServerSideEncryptionConfiguration

type ServerSideEncryptionConfiguration struct {

	// The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the configuration for server-side encryption.

func (ServerSideEncryptionConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) SetKmsKeyArn

SetKmsKeyArn sets the KmsKeyArn field's value.

func (ServerSideEncryptionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServerSideEncryptionConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The number of requests exceeds the service quota. Resubmit your request later.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartIngestionJobInput

type StartIngestionJobInput struct {

	// 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 `locationName:"clientToken" min:"33" type:"string" idempotencyToken:"true"`

	// The unique identifier of the data source to ingest.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// A description of the ingestion job.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base to which to add the data source.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartIngestionJobInput) GoString

func (s StartIngestionJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartIngestionJobInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*StartIngestionJobInput) SetDataSourceId

func (s *StartIngestionJobInput) SetDataSourceId(v string) *StartIngestionJobInput

SetDataSourceId sets the DataSourceId field's value.

func (*StartIngestionJobInput) SetDescription

SetDescription sets the Description field's value.

func (*StartIngestionJobInput) SetKnowledgeBaseId

func (s *StartIngestionJobInput) SetKnowledgeBaseId(v string) *StartIngestionJobInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (StartIngestionJobInput) String

func (s StartIngestionJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartIngestionJobInput) Validate

func (s *StartIngestionJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartIngestionJobOutput

type StartIngestionJobOutput struct {

	// An object containing information about the ingestion job.
	//
	// IngestionJob is a required field
	IngestionJob *IngestionJob `locationName:"ingestionJob" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartIngestionJobOutput) GoString

func (s StartIngestionJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartIngestionJobOutput) SetIngestionJob

SetIngestionJob sets the IngestionJob field's value.

func (StartIngestionJobOutput) String

func (s StartIngestionJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StorageConfiguration

type StorageConfiguration struct {

	// Contains the storage configuration of the knowledge base in MongoDB Atlas.
	MongoDbAtlasConfiguration *MongoDbAtlasConfiguration `locationName:"mongoDbAtlasConfiguration" type:"structure"`

	// Contains the storage configuration of the knowledge base in Amazon OpenSearch
	// Service.
	OpensearchServerlessConfiguration *OpenSearchServerlessConfiguration `locationName:"opensearchServerlessConfiguration" type:"structure"`

	// Contains the storage configuration of the knowledge base in Pinecone.
	PineconeConfiguration *PineconeConfiguration `locationName:"pineconeConfiguration" type:"structure"`

	// Contains details about the storage configuration of the knowledge base in
	// Amazon RDS. For more information, see Create a vector index in Amazon RDS
	// (https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).
	RdsConfiguration *RdsConfiguration `locationName:"rdsConfiguration" type:"structure"`

	// Contains the storage configuration of the knowledge base in Redis Enterprise
	// Cloud.
	RedisEnterpriseCloudConfiguration *RedisEnterpriseCloudConfiguration `locationName:"redisEnterpriseCloudConfiguration" type:"structure"`

	// The vector store service in which the knowledge base is stored.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"KnowledgeBaseStorageType"`
	// contains filtered or unexported fields
}

Contains the storage configuration of the knowledge base.

func (StorageConfiguration) GoString

func (s StorageConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageConfiguration) SetMongoDbAtlasConfiguration

func (s *StorageConfiguration) SetMongoDbAtlasConfiguration(v *MongoDbAtlasConfiguration) *StorageConfiguration

SetMongoDbAtlasConfiguration sets the MongoDbAtlasConfiguration field's value.

func (*StorageConfiguration) SetOpensearchServerlessConfiguration

func (s *StorageConfiguration) SetOpensearchServerlessConfiguration(v *OpenSearchServerlessConfiguration) *StorageConfiguration

SetOpensearchServerlessConfiguration sets the OpensearchServerlessConfiguration field's value.

func (*StorageConfiguration) SetPineconeConfiguration

func (s *StorageConfiguration) SetPineconeConfiguration(v *PineconeConfiguration) *StorageConfiguration

SetPineconeConfiguration sets the PineconeConfiguration field's value.

func (*StorageConfiguration) SetRdsConfiguration

func (s *StorageConfiguration) SetRdsConfiguration(v *RdsConfiguration) *StorageConfiguration

SetRdsConfiguration sets the RdsConfiguration field's value.

func (*StorageConfiguration) SetRedisEnterpriseCloudConfiguration

func (s *StorageConfiguration) SetRedisEnterpriseCloudConfiguration(v *RedisEnterpriseCloudConfiguration) *StorageConfiguration

SetRedisEnterpriseCloudConfiguration sets the RedisEnterpriseCloudConfiguration field's value.

func (*StorageConfiguration) SetType

SetType sets the Type field's value.

func (StorageConfiguration) String

func (s StorageConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StorageConfiguration) Validate

func (s *StorageConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// An object containing key-value pairs that define the tags to attach to the
	// resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The number of requests exceeds the limit. Resubmit your request later.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to remove tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// A list of keys of the tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAgentActionGroupInput

type UpdateAgentActionGroupInput struct {

	// The Amazon Resource Name (ARN) of the Lambda function containing the business
	// logic that is carried out upon invoking the action.
	ActionGroupExecutor *ActionGroupExecutor `locationName:"actionGroupExecutor" type:"structure"`

	// The unique identifier of the action group.
	//
	// ActionGroupId is a required field
	ActionGroupId *string `location:"uri" locationName:"actionGroupId" type:"string" required:"true"`

	// Specifies a new name for the action group.
	//
	// ActionGroupName is a required field
	ActionGroupName *string `locationName:"actionGroupName" type:"string" required:"true"`

	// 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 *string `locationName:"actionGroupState" type:"string" enum:"ActionGroupState"`

	// The unique identifier of the agent for which to update the action group.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The unique identifier of the agent version for which to update the action
	// group.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// 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 *APISchema `locationName:"apiSchema" type:"structure"`

	// Specifies a new name for the action group.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the function schema for the action group or the JSON
	// or YAML-formatted payload defining the schema.
	FunctionSchema *FunctionSchema `locationName:"functionSchema" type:"structure"`

	// 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 *string `locationName:"parentActionGroupSignature" type:"string" enum:"ActionGroupSignature"`
	// contains filtered or unexported fields
}

func (UpdateAgentActionGroupInput) GoString

func (s UpdateAgentActionGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentActionGroupInput) SetActionGroupExecutor

SetActionGroupExecutor sets the ActionGroupExecutor field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupId

SetActionGroupId sets the ActionGroupId field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupName

SetActionGroupName sets the ActionGroupName field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupState

SetActionGroupState sets the ActionGroupState field's value.

func (*UpdateAgentActionGroupInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*UpdateAgentActionGroupInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*UpdateAgentActionGroupInput) SetApiSchema

SetApiSchema sets the ApiSchema field's value.

func (*UpdateAgentActionGroupInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateAgentActionGroupInput) SetFunctionSchema

SetFunctionSchema sets the FunctionSchema field's value.

func (*UpdateAgentActionGroupInput) SetParentActionGroupSignature

func (s *UpdateAgentActionGroupInput) SetParentActionGroupSignature(v string) *UpdateAgentActionGroupInput

SetParentActionGroupSignature sets the ParentActionGroupSignature field's value.

func (UpdateAgentActionGroupInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentActionGroupInput) Validate

func (s *UpdateAgentActionGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAgentActionGroupOutput

type UpdateAgentActionGroupOutput struct {

	// Contains details about the action group that was updated.
	//
	// AgentActionGroup is a required field
	AgentActionGroup *AgentActionGroup `locationName:"agentActionGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAgentActionGroupOutput) GoString

func (s UpdateAgentActionGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentActionGroupOutput) SetAgentActionGroup

SetAgentActionGroup sets the AgentActionGroup field's value.

func (UpdateAgentActionGroupOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAgentAliasInput

type UpdateAgentAliasInput struct {

	// The unique identifier of the alias.
	//
	// AgentAliasId is a required field
	AgentAliasId *string `location:"uri" locationName:"agentAliasId" min:"10" type:"string" required:"true"`

	// Specifies a new name for the alias.
	//
	// AgentAliasName is a required field
	AgentAliasName *string `locationName:"agentAliasName" type:"string" required:"true"`

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// Specifies a new description for the alias.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Contains details about the routing configuration of the alias.
	RoutingConfiguration []*AgentAliasRoutingConfigurationListItem `locationName:"routingConfiguration" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateAgentAliasInput) GoString

func (s UpdateAgentAliasInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentAliasInput) SetAgentAliasId

func (s *UpdateAgentAliasInput) SetAgentAliasId(v string) *UpdateAgentAliasInput

SetAgentAliasId sets the AgentAliasId field's value.

func (*UpdateAgentAliasInput) SetAgentAliasName

func (s *UpdateAgentAliasInput) SetAgentAliasName(v string) *UpdateAgentAliasInput

SetAgentAliasName sets the AgentAliasName field's value.

func (*UpdateAgentAliasInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*UpdateAgentAliasInput) SetDescription

func (s *UpdateAgentAliasInput) SetDescription(v string) *UpdateAgentAliasInput

SetDescription sets the Description field's value.

func (*UpdateAgentAliasInput) SetRoutingConfiguration

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (UpdateAgentAliasInput) String

func (s UpdateAgentAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentAliasInput) Validate

func (s *UpdateAgentAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAgentAliasOutput

type UpdateAgentAliasOutput struct {

	// Contains details about the alias that was updated.
	//
	// AgentAlias is a required field
	AgentAlias *AgentAlias `locationName:"agentAlias" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAgentAliasOutput) GoString

func (s UpdateAgentAliasOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentAliasOutput) SetAgentAlias

SetAgentAlias sets the AgentAlias field's value.

func (UpdateAgentAliasOutput) String

func (s UpdateAgentAliasOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAgentInput

type UpdateAgentInput struct {

	// The unique identifier of the agent.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// Specifies a new name for the agent.
	//
	// AgentName is a required field
	AgentName *string `locationName:"agentName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role with permissions to invoke
	// API operations on the agent.
	//
	// AgentResourceRoleArn is a required field
	AgentResourceRoleArn *string `locationName:"agentResourceRoleArn" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// Specifies a new description of the agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// Specifies a new foundation model to be used for orchestration by the agent.
	//
	// FoundationModel is a required field
	FoundationModel *string `locationName:"foundationModel" min:"1" type:"string" required:"true"`

	// The unique Guardrail configuration assigned to the agent when it is updated.
	GuardrailConfiguration *GuardrailConfiguration `locationName:"guardrailConfiguration" type:"structure"`

	// 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 *int64 `locationName:"idleSessionTTLInSeconds" min:"60" type:"integer"`

	// Specifies new instructions that tell the agent what it should do and how
	// it should interact with users.
	//
	// Instruction is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAgentInput's
	// String and GoString methods.
	Instruction *string `locationName:"instruction" min:"40" type:"string" sensitive:"true"`

	// 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateAgentInput's
	// String and GoString methods.
	PromptOverrideConfiguration *PromptOverrideConfiguration `locationName:"promptOverrideConfiguration" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateAgentInput) GoString

func (s UpdateAgentInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentInput) SetAgentId

func (s *UpdateAgentInput) SetAgentId(v string) *UpdateAgentInput

SetAgentId sets the AgentId field's value.

func (*UpdateAgentInput) SetAgentName

func (s *UpdateAgentInput) SetAgentName(v string) *UpdateAgentInput

SetAgentName sets the AgentName field's value.

func (*UpdateAgentInput) SetAgentResourceRoleArn

func (s *UpdateAgentInput) SetAgentResourceRoleArn(v string) *UpdateAgentInput

SetAgentResourceRoleArn sets the AgentResourceRoleArn field's value.

func (*UpdateAgentInput) SetCustomerEncryptionKeyArn

func (s *UpdateAgentInput) SetCustomerEncryptionKeyArn(v string) *UpdateAgentInput

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*UpdateAgentInput) SetDescription

func (s *UpdateAgentInput) SetDescription(v string) *UpdateAgentInput

SetDescription sets the Description field's value.

func (*UpdateAgentInput) SetFoundationModel

func (s *UpdateAgentInput) SetFoundationModel(v string) *UpdateAgentInput

SetFoundationModel sets the FoundationModel field's value.

func (*UpdateAgentInput) SetGuardrailConfiguration

func (s *UpdateAgentInput) SetGuardrailConfiguration(v *GuardrailConfiguration) *UpdateAgentInput

SetGuardrailConfiguration sets the GuardrailConfiguration field's value.

func (*UpdateAgentInput) SetIdleSessionTTLInSeconds

func (s *UpdateAgentInput) SetIdleSessionTTLInSeconds(v int64) *UpdateAgentInput

SetIdleSessionTTLInSeconds sets the IdleSessionTTLInSeconds field's value.

func (*UpdateAgentInput) SetInstruction

func (s *UpdateAgentInput) SetInstruction(v string) *UpdateAgentInput

SetInstruction sets the Instruction field's value.

func (*UpdateAgentInput) SetPromptOverrideConfiguration

func (s *UpdateAgentInput) SetPromptOverrideConfiguration(v *PromptOverrideConfiguration) *UpdateAgentInput

SetPromptOverrideConfiguration sets the PromptOverrideConfiguration field's value.

func (UpdateAgentInput) String

func (s UpdateAgentInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentInput) Validate

func (s *UpdateAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAgentKnowledgeBaseInput

type UpdateAgentKnowledgeBaseInput struct {

	// The unique identifier of the agent associated with the knowledge base that
	// you want to update.
	//
	// AgentId is a required field
	AgentId *string `location:"uri" locationName:"agentId" type:"string" required:"true"`

	// The version of the agent associated with the knowledge base that you want
	// to update.
	//
	// AgentVersion is a required field
	AgentVersion *string `location:"uri" locationName:"agentVersion" min:"5" type:"string" required:"true"`

	// Specifies a new description for the knowledge base associated with an agent.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base that has been associated with
	// an agent.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// 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 *string `locationName:"knowledgeBaseState" type:"string" enum:"KnowledgeBaseState"`
	// contains filtered or unexported fields
}

func (UpdateAgentKnowledgeBaseInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentKnowledgeBaseInput) SetAgentId

SetAgentId sets the AgentId field's value.

func (*UpdateAgentKnowledgeBaseInput) SetAgentVersion

SetAgentVersion sets the AgentVersion field's value.

func (*UpdateAgentKnowledgeBaseInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateAgentKnowledgeBaseInput) SetKnowledgeBaseId

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateAgentKnowledgeBaseInput) SetKnowledgeBaseState

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (UpdateAgentKnowledgeBaseInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentKnowledgeBaseInput) Validate

func (s *UpdateAgentKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAgentKnowledgeBaseOutput

type UpdateAgentKnowledgeBaseOutput struct {

	// Contains details about the knowledge base that has been associated with an
	// agent.
	//
	// AgentKnowledgeBase is a required field
	AgentKnowledgeBase *AgentKnowledgeBase `locationName:"agentKnowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAgentKnowledgeBaseOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (UpdateAgentKnowledgeBaseOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAgentOutput

type UpdateAgentOutput struct {

	// Contains details about the agent that was updated.
	//
	// Agent is a required field
	Agent *Agent `locationName:"agent" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAgentOutput) GoString

func (s UpdateAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAgentOutput) SetAgent

func (s *UpdateAgentOutput) SetAgent(v *Agent) *UpdateAgentOutput

SetAgent sets the Agent field's value.

func (UpdateAgentOutput) String

func (s UpdateAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDataSourceInput

type UpdateDataSourceInput struct {

	// The data deletion policy of the updated data source.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// Contains details about the storage configuration of the data source.
	//
	// DataSourceConfiguration is a required field
	DataSourceConfiguration *DataSourceConfiguration `locationName:"dataSourceConfiguration" type:"structure" required:"true"`

	// The unique identifier of the data source.
	//
	// DataSourceId is a required field
	DataSourceId *string `location:"uri" locationName:"dataSourceId" type:"string" required:"true"`

	// Specifies a new description for the data source.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the knowledge base to which the data source belongs.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// Specifies a new name for the data source.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contains details about server-side encryption of the data source.
	ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `locationName:"serverSideEncryptionConfiguration" type:"structure"`

	// Contains details about how to ingest the documents in the data source.
	VectorIngestionConfiguration *VectorIngestionConfiguration `locationName:"vectorIngestionConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateDataSourceInput) GoString

func (s UpdateDataSourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataSourceInput) SetDataDeletionPolicy

func (s *UpdateDataSourceInput) SetDataDeletionPolicy(v string) *UpdateDataSourceInput

SetDataDeletionPolicy sets the DataDeletionPolicy field's value.

func (*UpdateDataSourceInput) SetDataSourceConfiguration

func (s *UpdateDataSourceInput) SetDataSourceConfiguration(v *DataSourceConfiguration) *UpdateDataSourceInput

SetDataSourceConfiguration sets the DataSourceConfiguration field's value.

func (*UpdateDataSourceInput) SetDataSourceId

func (s *UpdateDataSourceInput) SetDataSourceId(v string) *UpdateDataSourceInput

SetDataSourceId sets the DataSourceId field's value.

func (*UpdateDataSourceInput) SetDescription

func (s *UpdateDataSourceInput) SetDescription(v string) *UpdateDataSourceInput

SetDescription sets the Description field's value.

func (*UpdateDataSourceInput) SetKnowledgeBaseId

func (s *UpdateDataSourceInput) SetKnowledgeBaseId(v string) *UpdateDataSourceInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateDataSourceInput) SetName

SetName sets the Name field's value.

func (*UpdateDataSourceInput) SetServerSideEncryptionConfiguration

func (s *UpdateDataSourceInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *UpdateDataSourceInput

SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value.

func (*UpdateDataSourceInput) SetVectorIngestionConfiguration

func (s *UpdateDataSourceInput) SetVectorIngestionConfiguration(v *VectorIngestionConfiguration) *UpdateDataSourceInput

SetVectorIngestionConfiguration sets the VectorIngestionConfiguration field's value.

func (UpdateDataSourceInput) String

func (s UpdateDataSourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataSourceInput) Validate

func (s *UpdateDataSourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateDataSourceOutput

type UpdateDataSourceOutput struct {

	// Contains details about the data source.
	//
	// DataSource is a required field
	DataSource *DataSource `locationName:"dataSource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDataSourceOutput) GoString

func (s UpdateDataSourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDataSourceOutput) SetDataSource

SetDataSource sets the DataSource field's value.

func (UpdateDataSourceOutput) String

func (s UpdateDataSourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateKnowledgeBaseInput

type UpdateKnowledgeBaseInput struct {

	// Specifies a new description for the knowledge base.
	Description *string `locationName:"description" min:"1" type:"string"`

	// 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.
	//
	// KnowledgeBaseConfiguration is a required field
	KnowledgeBaseConfiguration *KnowledgeBaseConfiguration `locationName:"knowledgeBaseConfiguration" type:"structure" required:"true"`

	// The unique identifier of the knowledge base to update.
	//
	// KnowledgeBaseId is a required field
	KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"`

	// Specifies a new name for the knowledge base.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions
	// to invoke API operations on the knowledge base.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// 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.
	//
	// StorageConfiguration is a required field
	StorageConfiguration *StorageConfiguration `locationName:"storageConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateKnowledgeBaseInput) GoString

func (s UpdateKnowledgeBaseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateKnowledgeBaseInput) SetKnowledgeBaseConfiguration

SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.

func (*UpdateKnowledgeBaseInput) SetKnowledgeBaseId

func (s *UpdateKnowledgeBaseInput) SetKnowledgeBaseId(v string) *UpdateKnowledgeBaseInput

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateKnowledgeBaseInput) SetName

SetName sets the Name field's value.

func (*UpdateKnowledgeBaseInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*UpdateKnowledgeBaseInput) SetStorageConfiguration

SetStorageConfiguration sets the StorageConfiguration field's value.

func (UpdateKnowledgeBaseInput) String

func (s UpdateKnowledgeBaseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseInput) Validate

func (s *UpdateKnowledgeBaseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateKnowledgeBaseOutput

type UpdateKnowledgeBaseOutput struct {

	// Contains details about the knowledge base.
	//
	// KnowledgeBase is a required field
	KnowledgeBase *KnowledgeBase `locationName:"knowledgeBase" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateKnowledgeBaseOutput) GoString

func (s UpdateKnowledgeBaseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateKnowledgeBaseOutput) SetKnowledgeBase

SetKnowledgeBase sets the KnowledgeBase field's value.

func (UpdateKnowledgeBaseOutput) String

func (s UpdateKnowledgeBaseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A list of objects containing fields that caused validation errors and their
	// corresponding validation error messages.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Input validation failed. Check your request parameters and retry the request.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

	// A message describing why this field failed validation.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the field.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VectorIngestionConfiguration

type VectorIngestionConfiguration struct {

	// Details about how to chunk the documents in the data source. A chunk refers
	// to an excerpt from a data source that is returned when the knowledge base
	// that it belongs to is queried.
	ChunkingConfiguration *ChunkingConfiguration `locationName:"chunkingConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

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

func (VectorIngestionConfiguration) GoString

func (s VectorIngestionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VectorIngestionConfiguration) SetChunkingConfiguration

SetChunkingConfiguration sets the ChunkingConfiguration field's value.

func (VectorIngestionConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VectorIngestionConfiguration) Validate

func (s *VectorIngestionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type VectorKnowledgeBaseConfiguration

type VectorKnowledgeBaseConfiguration struct {

	// The Amazon Resource Name (ARN) of the model used to create vector embeddings
	// for the knowledge base.
	//
	// EmbeddingModelArn is a required field
	EmbeddingModelArn *string `locationName:"embeddingModelArn" min:"20" type:"string" required:"true"`

	// The embeddings model configuration details for the vector model used in Knowledge
	// Base.
	EmbeddingModelConfiguration *EmbeddingModelConfiguration `locationName:"embeddingModelConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

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

func (VectorKnowledgeBaseConfiguration) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VectorKnowledgeBaseConfiguration) SetEmbeddingModelArn

SetEmbeddingModelArn sets the EmbeddingModelArn field's value.

func (*VectorKnowledgeBaseConfiguration) SetEmbeddingModelConfiguration

SetEmbeddingModelConfiguration sets the EmbeddingModelConfiguration field's value.

func (VectorKnowledgeBaseConfiguration) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VectorKnowledgeBaseConfiguration) Validate

Validate inspects the fields of the type to determine if they are valid.

Directories

Path Synopsis
Package bedrockagentiface provides an interface to enable mocking the Agents for Amazon Bedrock service client for testing your code.
Package bedrockagentiface provides an interface to enable mocking the Agents for Amazon Bedrock service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL