bedrockagent

package
v1.55.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2024 License: Apache-2.0 Imports: 10 Imported by: 2

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 (
	// ActionGroupSignatureAmazonUserInput is a ActionGroupSignature enum value
	ActionGroupSignatureAmazonUserInput = "AMAZON.UserInput"

	// ActionGroupSignatureAmazonCodeInterpreter is a ActionGroupSignature enum value
	ActionGroupSignatureAmazonCodeInterpreter = "AMAZON.CodeInterpreter"
)
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"

	// ChunkingStrategyHierarchical is a ChunkingStrategy enum value
	ChunkingStrategyHierarchical = "HIERARCHICAL"

	// ChunkingStrategySemantic is a ChunkingStrategy enum value
	ChunkingStrategySemantic = "SEMANTIC"
)
View Source 
const (
	// ConfluenceAuthTypeBasic is a ConfluenceAuthType enum value
	ConfluenceAuthTypeBasic = "BASIC"

	// ConfluenceAuthTypeOauth2ClientCredentials is a ConfluenceAuthType enum value
	ConfluenceAuthTypeOauth2ClientCredentials = "OAUTH2_CLIENT_CREDENTIALS"
)
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 (
	// DataSourceTypeS3 is a DataSourceType enum value
	DataSourceTypeS3 = "S3"

	// DataSourceTypeWeb is a DataSourceType enum value
	DataSourceTypeWeb = "WEB"

	// DataSourceTypeConfluence is a DataSourceType enum value
	DataSourceTypeConfluence = "CONFLUENCE"

	// DataSourceTypeSalesforce is a DataSourceType enum value
	DataSourceTypeSalesforce = "SALESFORCE"

	// DataSourceTypeSharepoint is a DataSourceType enum value
	DataSourceTypeSharepoint = "SHAREPOINT"
)
View Source 
const (
	// FlowConnectionTypeData is a FlowConnectionType enum value
	FlowConnectionTypeData = "Data"

	// FlowConnectionTypeConditional is a FlowConnectionType enum value
	FlowConnectionTypeConditional = "Conditional"
)
View Source 
const (
	// FlowNodeIODataTypeString is a FlowNodeIODataType enum value
	FlowNodeIODataTypeString = "String"

	// FlowNodeIODataTypeNumber is a FlowNodeIODataType enum value
	FlowNodeIODataTypeNumber = "Number"

	// FlowNodeIODataTypeBoolean is a FlowNodeIODataType enum value
	FlowNodeIODataTypeBoolean = "Boolean"

	// FlowNodeIODataTypeObject is a FlowNodeIODataType enum value
	FlowNodeIODataTypeObject = "Object"

	// FlowNodeIODataTypeArray is a FlowNodeIODataType enum value
	FlowNodeIODataTypeArray = "Array"
)
View Source 
const (
	// FlowNodeTypeInput is a FlowNodeType enum value
	FlowNodeTypeInput = "Input"

	// FlowNodeTypeOutput is a FlowNodeType enum value
	FlowNodeTypeOutput = "Output"

	// FlowNodeTypeKnowledgeBase is a FlowNodeType enum value
	FlowNodeTypeKnowledgeBase = "KnowledgeBase"

	// FlowNodeTypeCondition is a FlowNodeType enum value
	FlowNodeTypeCondition = "Condition"

	// FlowNodeTypeLex is a FlowNodeType enum value
	FlowNodeTypeLex = "Lex"

	// FlowNodeTypePrompt is a FlowNodeType enum value
	FlowNodeTypePrompt = "Prompt"

	// FlowNodeTypeLambdaFunction is a FlowNodeType enum value
	FlowNodeTypeLambdaFunction = "LambdaFunction"

	// FlowNodeTypeStorage is a FlowNodeType enum value
	FlowNodeTypeStorage = "Storage"

	// FlowNodeTypeAgent is a FlowNodeType enum value
	FlowNodeTypeAgent = "Agent"

	// FlowNodeTypeRetrieval is a FlowNodeType enum value
	FlowNodeTypeRetrieval = "Retrieval"

	// FlowNodeTypeIterator is a FlowNodeType enum value
	FlowNodeTypeIterator = "Iterator"

	// FlowNodeTypeCollector is a FlowNodeType enum value
	FlowNodeTypeCollector = "Collector"
)
View Source 
const (
	// FlowStatusFailed is a FlowStatus enum value
	FlowStatusFailed = "Failed"

	// FlowStatusPrepared is a FlowStatus enum value
	FlowStatusPrepared = "Prepared"

	// FlowStatusPreparing is a FlowStatus enum value
	FlowStatusPreparing = "Preparing"

	// FlowStatusNotPrepared is a FlowStatus enum value
	FlowStatusNotPrepared = "NotPrepared"
)
View Source 
const (
	// FlowValidationSeverityWarning is a FlowValidationSeverity enum value
	FlowValidationSeverityWarning = "Warning"

	// FlowValidationSeverityError is a FlowValidationSeverity enum value
	FlowValidationSeverityError = "Error"
)
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 (
	// WebScopeTypeHostOnly is a WebScopeType enum value
	WebScopeTypeHostOnly = "HOST_ONLY"

	// WebScopeTypeSubdomains is a WebScopeType enum value
	WebScopeTypeSubdomains = "SUBDOMAINS"
)
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 (
	// ConfluenceHostTypeSaas is a ConfluenceHostType enum value
	ConfluenceHostTypeSaas = "SAAS"
)
View Source 
const (
	// CrawlFilterConfigurationTypePattern is a CrawlFilterConfigurationType enum value
	CrawlFilterConfigurationTypePattern = "PATTERN"
)
View Source 
const (
	// CustomControlMethodReturnControl is a CustomControlMethod enum value
	CustomControlMethodReturnControl = "RETURN_CONTROL"
)
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"
)
View Source 
const (
	// MemoryTypeSessionSummary is a MemoryType enum value
	MemoryTypeSessionSummary = "SESSION_SUMMARY"
)
View Source 
const (
	// ParsingStrategyBedrockFoundationModel is a ParsingStrategy enum value
	ParsingStrategyBedrockFoundationModel = "BEDROCK_FOUNDATION_MODEL"
)
View Source 
const (
	// PromptTemplateTypeText is a PromptTemplateType enum value
	PromptTemplateTypeText = "TEXT"
)
View Source 
const (
	// SalesforceAuthTypeOauth2ClientCredentials is a SalesforceAuthType enum value
	SalesforceAuthTypeOauth2ClientCredentials = "OAUTH2_CLIENT_CREDENTIALS"
)
View Source 
const (
	// SharePointAuthTypeOauth2ClientCredentials is a SharePointAuthType enum value
	SharePointAuthTypeOauth2ClientCredentials = "OAUTH2_CLIENT_CREDENTIALS"
)
View Source 
const (
	// SharePointHostTypeOnline is a SharePointHostType enum value
	SharePointHostTypeOnline = "ONLINE"
)
View Source 
const (
	// StepTypePostChunking is a StepType enum value
	StepTypePostChunking = "POST_CHUNKING"
)

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 ConfluenceAuthType_Values added in v1.54.18 

func ConfluenceAuthType_Values() []string

ConfluenceAuthType_Values returns all elements of the ConfluenceAuthType enum

func ConfluenceHostType_Values added in v1.54.18 

func ConfluenceHostType_Values() []string

ConfluenceHostType_Values returns all elements of the ConfluenceHostType enum

func CrawlFilterConfigurationType_Values added in v1.54.18 

func CrawlFilterConfigurationType_Values() []string

CrawlFilterConfigurationType_Values returns all elements of the CrawlFilterConfigurationType enum

func CreationMode_Values 

func CreationMode_Values() []string

CreationMode_Values returns all elements of the CreationMode enum

func CustomControlMethod_Values added in v1.51.26 

func CustomControlMethod_Values() []string

CustomControlMethod_Values returns all elements of the CustomControlMethod enum

func DataDeletionPolicy_Values added in v1.51.27 

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 FlowConnectionType_Values added in v1.54.18 

func FlowConnectionType_Values() []string

FlowConnectionType_Values returns all elements of the FlowConnectionType enum

func FlowNodeIODataType_Values added in v1.54.18 

func FlowNodeIODataType_Values() []string

FlowNodeIODataType_Values returns all elements of the FlowNodeIODataType enum

func FlowNodeType_Values added in v1.54.18 

func FlowNodeType_Values() []string

FlowNodeType_Values returns all elements of the FlowNodeType enum

func FlowStatus_Values added in v1.54.18 

func FlowStatus_Values() []string

FlowStatus_Values returns all elements of the FlowStatus enum

func FlowValidationSeverity_Values added in v1.54.18 

func FlowValidationSeverity_Values() []string

FlowValidationSeverity_Values returns all elements of the FlowValidationSeverity 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 MemoryType_Values added in v1.54.18 

func MemoryType_Values() []string

MemoryType_Values returns all elements of the MemoryType enum

func ParsingStrategy_Values added in v1.54.18 

func ParsingStrategy_Values() []string

ParsingStrategy_Values returns all elements of the ParsingStrategy enum

func PromptState_Values 

func PromptState_Values() []string

PromptState_Values returns all elements of the PromptState enum

func PromptTemplateType_Values added in v1.54.18 

func PromptTemplateType_Values() []string

PromptTemplateType_Values returns all elements of the PromptTemplateType enum

func PromptType_Values 

func PromptType_Values() []string

PromptType_Values returns all elements of the PromptType enum

func SalesforceAuthType_Values added in v1.54.18 

func SalesforceAuthType_Values() []string

SalesforceAuthType_Values returns all elements of the SalesforceAuthType enum

func SharePointAuthType_Values added in v1.54.18 

func SharePointAuthType_Values() []string

SharePointAuthType_Values returns all elements of the SharePointAuthType enum

func SharePointHostType_Values added in v1.54.18 

func SharePointHostType_Values() []string

SharePointHostType_Values returns all elements of the SharePointHostType enum

func SortOrder_Values 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func StepType_Values added in v1.54.18 

func StepType_Values() []string

StepType_Values returns all elements of the StepType enum

func Type_Values added in v1.51.26 

func Type_Values() []string

Type_Values returns all elements of the Type enum

func WebScopeType_Values added in v1.54.18 

func WebScopeType_Values() []string

WebScopeType_Values returns all elements of the WebScopeType 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 added in v1.51.26 

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

SetCustomControl sets the CustomControl field's value.

func (*ActionGroupExecutor) SetLambda 

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

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"`

	// Details about the guardrail associated with 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"`

	// Contains memory configuration for the agent.
	MemoryConfiguration *MemoryConfiguration `locationName:"memoryConfiguration" type:"structure"`

	// 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 added in v1.53.6 

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) SetMemoryConfiguration added in v1.54.18 

func (s *Agent) SetMemoryConfiguration(v *MemoryConfiguration) *Agent

SetMemoryConfiguration sets the MemoryConfiguration 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 added in v1.51.26 

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 added in v1.52.2 

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 

func (s *AgentAliasHistoryEvent) SetEndDate(v time.Time) *AgentAliasHistoryEvent

SetEndDate sets the EndDate field's value.

func (*AgentAliasHistoryEvent) SetRoutingConfiguration 

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

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*AgentAliasHistoryEvent) SetStartDate 

func (s *AgentAliasHistoryEvent) SetStartDate(v time.Time) *AgentAliasHistoryEvent

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 

func (s AgentAliasRoutingConfigurationListItem) 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 (*AgentAliasRoutingConfigurationListItem) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*AgentAliasRoutingConfigurationListItem) SetProvisionedThroughput added in v1.52.2 

func (s *AgentAliasRoutingConfigurationListItem) SetProvisionedThroughput(v string) *AgentAliasRoutingConfigurationListItem

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (AgentAliasRoutingConfigurationListItem) String 

func (s AgentAliasRoutingConfigurationListItem) 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 (*AgentAliasRoutingConfigurationListItem) Validate 

func (s *AgentAliasRoutingConfigurationListItem) Validate() error

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 

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

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 AgentFlowNodeConfiguration added in v1.54.18 

type AgentFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the alias of the agent to invoke.
	//
	// AgentAliasArn is a required field
	AgentAliasArn *string `locationName:"agentAliasArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (AgentFlowNodeConfiguration) GoString added in v1.54.18 

func (s AgentFlowNodeConfiguration) 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 (*AgentFlowNodeConfiguration) SetAgentAliasArn added in v1.54.18 

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

SetAgentAliasArn sets the AgentAliasArn field's value.

func (AgentFlowNodeConfiguration) String added in v1.54.18 

func (s AgentFlowNodeConfiguration) 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 (*AgentFlowNodeConfiguration) Validate added in v1.54.18 

func (s *AgentFlowNodeConfiguration) Validate() error

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

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 

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

SetDescription sets the Description field's value.

func (*AgentKnowledgeBaseSummary) SetKnowledgeBaseId 

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

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 

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

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"`

	// Details about the guardrail associated with the agent.
	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 added in v1.53.6 

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"`

	// Details about the guardrail associated with 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"`

	// 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 details of the memory configuration on the version of the agent.
	MemoryConfiguration *MemoryConfiguration `locationName:"memoryConfiguration" type:"structure"`

	// 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 added in v1.53.6 

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) SetMemoryConfiguration added in v1.54.18 

func (s *AgentVersion) SetMemoryConfiguration(v *MemoryConfiguration) *AgentVersion

SetMemoryConfiguration sets the MemoryConfiguration 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"`

	// Details about the guardrail associated with the agent.
	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 added in v1.53.6 

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 

func (s AssociateAgentKnowledgeBaseInput) 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 (*AssociateAgentKnowledgeBaseInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*AssociateAgentKnowledgeBaseInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*AssociateAgentKnowledgeBaseInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*AssociateAgentKnowledgeBaseInput) SetKnowledgeBaseId 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*AssociateAgentKnowledgeBaseInput) SetKnowledgeBaseState 

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

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (AssociateAgentKnowledgeBaseInput) String 

func (s AssociateAgentKnowledgeBaseInput) 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 (*AssociateAgentKnowledgeBaseInput) Validate 

func (s *AssociateAgentKnowledgeBaseInput) Validate() error

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 

func (s AssociateAgentKnowledgeBaseOutput) 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 (*AssociateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase 

func (s *AssociateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowledgeBase) *AssociateAgentKnowledgeBaseOutput

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (AssociateAgentKnowledgeBaseOutput) String 

func (s AssociateAgentKnowledgeBaseOutput) 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 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 enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory (https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html).

  • 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.

To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.

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.

Creates a data source connector for a knowledge base.

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

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) CreateFlow added in v1.54.18 

func (c *BedrockAgent) CreateFlow(input *CreateFlowInput) (*CreateFlowOutput, error)

CreateFlow API operation for Agents for Amazon Bedrock.

Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and Create a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.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 CreateFlow 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/CreateFlow

func (*BedrockAgent) CreateFlowAlias added in v1.54.18 

func (c *BedrockAgent) CreateFlowAlias(input *CreateFlowAliasInput) (*CreateFlowAliasOutput, error)

CreateFlowAlias API operation for Agents for Amazon Bedrock.

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 CreateFlowAlias 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/CreateFlowAlias

func (*BedrockAgent) CreateFlowAliasRequest added in v1.54.18 

func (c *BedrockAgent) CreateFlowAliasRequest(input *CreateFlowAliasInput) (req *request.Request, output *CreateFlowAliasOutput)

CreateFlowAliasRequest generates a "aws/request.Request" representing the client's request for the CreateFlowAlias 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 CreateFlowAlias for more information on using the CreateFlowAlias 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 CreateFlowAliasRequest method.
req, resp := client.CreateFlowAliasRequest(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/CreateFlowAlias

func (*BedrockAgent) CreateFlowAliasWithContext added in v1.54.18 

func (c *BedrockAgent) CreateFlowAliasWithContext(ctx aws.Context, input *CreateFlowAliasInput, opts ...request.Option) (*CreateFlowAliasOutput, error)

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

See CreateFlowAlias 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) CreateFlowRequest added in v1.54.18 

func (c *BedrockAgent) CreateFlowRequest(input *CreateFlowInput) (req *request.Request, output *CreateFlowOutput)

CreateFlowRequest generates a "aws/request.Request" representing the client's request for the CreateFlow 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 CreateFlow for more information on using the CreateFlow 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 CreateFlowRequest method.
req, resp := client.CreateFlowRequest(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/CreateFlow

func (*BedrockAgent) CreateFlowVersion added in v1.54.18 

func (c *BedrockAgent) CreateFlowVersion(input *CreateFlowVersionInput) (*CreateFlowVersionOutput, error)

CreateFlowVersion API operation for Agents for Amazon Bedrock.

Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 CreateFlowVersion 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/CreateFlowVersion

func (*BedrockAgent) CreateFlowVersionRequest added in v1.54.18 

func (c *BedrockAgent) CreateFlowVersionRequest(input *CreateFlowVersionInput) (req *request.Request, output *CreateFlowVersionOutput)

CreateFlowVersionRequest generates a "aws/request.Request" representing the client's request for the CreateFlowVersion 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 CreateFlowVersion for more information on using the CreateFlowVersion 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 CreateFlowVersionRequest method.
req, resp := client.CreateFlowVersionRequest(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/CreateFlowVersion

func (*BedrockAgent) CreateFlowVersionWithContext added in v1.54.18 

func (c *BedrockAgent) CreateFlowVersionWithContext(ctx aws.Context, input *CreateFlowVersionInput, opts ...request.Option) (*CreateFlowVersionOutput, error)

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

See CreateFlowVersion 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) CreateFlowWithContext added in v1.54.18 

func (c *BedrockAgent) CreateFlowWithContext(ctx aws.Context, input *CreateFlowInput, opts ...request.Option) (*CreateFlowOutput, error)

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

See CreateFlow 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) CreatePrompt added in v1.54.18 

func (c *BedrockAgent) CreatePrompt(input *CreatePromptInput) (*CreatePromptOutput, error)

CreatePrompt API operation for Agents for Amazon Bedrock.

Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), Create a prompt using Prompt management (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and Prompt flows in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows.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 CreatePrompt 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/CreatePrompt

func (*BedrockAgent) CreatePromptRequest added in v1.54.18 

func (c *BedrockAgent) CreatePromptRequest(input *CreatePromptInput) (req *request.Request, output *CreatePromptOutput)

CreatePromptRequest generates a "aws/request.Request" representing the client's request for the CreatePrompt 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 CreatePrompt for more information on using the CreatePrompt 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 CreatePromptRequest method.
req, resp := client.CreatePromptRequest(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/CreatePrompt

func (*BedrockAgent) CreatePromptVersion added in v1.54.18 

func (c *BedrockAgent) CreatePromptVersion(input *CreatePromptVersionInput) (*CreatePromptVersionOutput, error)

CreatePromptVersion API operation for Agents for Amazon Bedrock.

Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.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 CreatePromptVersion 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/CreatePromptVersion

func (*BedrockAgent) CreatePromptVersionRequest added in v1.54.18 

func (c *BedrockAgent) CreatePromptVersionRequest(input *CreatePromptVersionInput) (req *request.Request, output *CreatePromptVersionOutput)

CreatePromptVersionRequest generates a "aws/request.Request" representing the client's request for the CreatePromptVersion 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 CreatePromptVersion for more information on using the CreatePromptVersion 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 CreatePromptVersionRequest method.
req, resp := client.CreatePromptVersionRequest(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/CreatePromptVersion

func (*BedrockAgent) CreatePromptVersionWithContext added in v1.54.18 

func (c *BedrockAgent) CreatePromptVersionWithContext(ctx aws.Context, input *CreatePromptVersionInput, opts ...request.Option) (*CreatePromptVersionOutput, error)

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

See CreatePromptVersion 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) CreatePromptWithContext added in v1.54.18 

func (c *BedrockAgent) CreatePromptWithContext(ctx aws.Context, input *CreatePromptInput, opts ...request.Option) (*CreatePromptOutput, error)

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

See CreatePrompt 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) DeleteFlow added in v1.54.18 

func (c *BedrockAgent) DeleteFlow(input *DeleteFlowInput) (*DeleteFlowOutput, error)

DeleteFlow API operation for Agents for Amazon Bedrock.

Deletes a flow.

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 DeleteFlow 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/DeleteFlow

func (*BedrockAgent) DeleteFlowAlias added in v1.54.18 

func (c *BedrockAgent) DeleteFlowAlias(input *DeleteFlowAliasInput) (*DeleteFlowAliasOutput, error)

DeleteFlowAlias API operation for Agents for Amazon Bedrock.

Deletes an alias of a flow.

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 DeleteFlowAlias 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/DeleteFlowAlias

func (*BedrockAgent) DeleteFlowAliasRequest added in v1.54.18 

func (c *BedrockAgent) DeleteFlowAliasRequest(input *DeleteFlowAliasInput) (req *request.Request, output *DeleteFlowAliasOutput)

DeleteFlowAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteFlowAlias 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 DeleteFlowAlias for more information on using the DeleteFlowAlias 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 DeleteFlowAliasRequest method.
req, resp := client.DeleteFlowAliasRequest(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/DeleteFlowAlias

func (*BedrockAgent) DeleteFlowAliasWithContext added in v1.54.18 

func (c *BedrockAgent) DeleteFlowAliasWithContext(ctx aws.Context, input *DeleteFlowAliasInput, opts ...request.Option) (*DeleteFlowAliasOutput, error)

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

See DeleteFlowAlias 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) DeleteFlowRequest added in v1.54.18 

func (c *BedrockAgent) DeleteFlowRequest(input *DeleteFlowInput) (req *request.Request, output *DeleteFlowOutput)

DeleteFlowRequest generates a "aws/request.Request" representing the client's request for the DeleteFlow 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 DeleteFlow for more information on using the DeleteFlow 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 DeleteFlowRequest method.
req, resp := client.DeleteFlowRequest(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/DeleteFlow

func (*BedrockAgent) DeleteFlowVersion added in v1.54.18 

func (c *BedrockAgent) DeleteFlowVersion(input *DeleteFlowVersionInput) (*DeleteFlowVersionOutput, error)

DeleteFlowVersion API operation for Agents for Amazon Bedrock.

Deletes a version of a flow.

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 DeleteFlowVersion 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/DeleteFlowVersion

func (*BedrockAgent) DeleteFlowVersionRequest added in v1.54.18 

func (c *BedrockAgent) DeleteFlowVersionRequest(input *DeleteFlowVersionInput) (req *request.Request, output *DeleteFlowVersionOutput)

DeleteFlowVersionRequest generates a "aws/request.Request" representing the client's request for the DeleteFlowVersion 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 DeleteFlowVersion for more information on using the DeleteFlowVersion 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 DeleteFlowVersionRequest method.
req, resp := client.DeleteFlowVersionRequest(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/DeleteFlowVersion

func (*BedrockAgent) DeleteFlowVersionWithContext added in v1.54.18 

func (c *BedrockAgent) DeleteFlowVersionWithContext(ctx aws.Context, input *DeleteFlowVersionInput, opts ...request.Option) (*DeleteFlowVersionOutput, error)

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

See DeleteFlowVersion 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) DeleteFlowWithContext added in v1.54.18 

func (c *BedrockAgent) DeleteFlowWithContext(ctx aws.Context, input *DeleteFlowInput, opts ...request.Option) (*DeleteFlowOutput, error)

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

See DeleteFlow 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) DeletePrompt added in v1.54.18 

func (c *BedrockAgent) DeletePrompt(input *DeletePromptInput) (*DeletePromptOutput, error)

DeletePrompt API operation for Agents for Amazon Bedrock.

Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-delete.html) and Delete a version of a prompt from the Prompt management tool (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.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 DeletePrompt 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/DeletePrompt

func (*BedrockAgent) DeletePromptRequest added in v1.54.18 

func (c *BedrockAgent) DeletePromptRequest(input *DeletePromptInput) (req *request.Request, output *DeletePromptOutput)

DeletePromptRequest generates a "aws/request.Request" representing the client's request for the DeletePrompt 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 DeletePrompt for more information on using the DeletePrompt 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 DeletePromptRequest method.
req, resp := client.DeletePromptRequest(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/DeletePrompt

func (*BedrockAgent) DeletePromptWithContext added in v1.54.18 

func (c *BedrockAgent) DeletePromptWithContext(ctx aws.Context, input *DeletePromptInput, opts ...request.Option) (*DeletePromptOutput, error)

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

See DeletePrompt 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 

func (c *BedrockAgent) DisassociateAgentKnowledgeBase(input *DisassociateAgentKnowledgeBaseInput) (*DisassociateAgentKnowledgeBaseOutput, error)

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) GetFlow added in v1.54.18 

func (c *BedrockAgent) GetFlow(input *GetFlowInput) (*GetFlowOutput, error)

GetFlow API operation for Agents for Amazon Bedrock.

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.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 GetFlow 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/GetFlow

func (*BedrockAgent) GetFlowAlias added in v1.54.18 

func (c *BedrockAgent) GetFlowAlias(input *GetFlowAliasInput) (*GetFlowAliasOutput, error)

GetFlowAlias API operation for Agents for Amazon Bedrock.

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 GetFlowAlias 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/GetFlowAlias

func (*BedrockAgent) GetFlowAliasRequest added in v1.54.18 

func (c *BedrockAgent) GetFlowAliasRequest(input *GetFlowAliasInput) (req *request.Request, output *GetFlowAliasOutput)

GetFlowAliasRequest generates a "aws/request.Request" representing the client's request for the GetFlowAlias 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 GetFlowAlias for more information on using the GetFlowAlias 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 GetFlowAliasRequest method.
req, resp := client.GetFlowAliasRequest(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/GetFlowAlias

func (*BedrockAgent) GetFlowAliasWithContext added in v1.54.18 

func (c *BedrockAgent) GetFlowAliasWithContext(ctx aws.Context, input *GetFlowAliasInput, opts ...request.Option) (*GetFlowAliasOutput, error)

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

See GetFlowAlias 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) GetFlowRequest added in v1.54.18 

func (c *BedrockAgent) GetFlowRequest(input *GetFlowInput) (req *request.Request, output *GetFlowOutput)

GetFlowRequest generates a "aws/request.Request" representing the client's request for the GetFlow 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 GetFlow for more information on using the GetFlow 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 GetFlowRequest method.
req, resp := client.GetFlowRequest(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/GetFlow

func (*BedrockAgent) GetFlowVersion added in v1.54.18 

func (c *BedrockAgent) GetFlowVersion(input *GetFlowVersionInput) (*GetFlowVersionOutput, error)

GetFlowVersion API operation for Agents for Amazon Bedrock.

Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 GetFlowVersion 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/GetFlowVersion

func (*BedrockAgent) GetFlowVersionRequest added in v1.54.18 

func (c *BedrockAgent) GetFlowVersionRequest(input *GetFlowVersionInput) (req *request.Request, output *GetFlowVersionOutput)

GetFlowVersionRequest generates a "aws/request.Request" representing the client's request for the GetFlowVersion 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 GetFlowVersion for more information on using the GetFlowVersion 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 GetFlowVersionRequest method.
req, resp := client.GetFlowVersionRequest(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/GetFlowVersion

func (*BedrockAgent) GetFlowVersionWithContext added in v1.54.18 

func (c *BedrockAgent) GetFlowVersionWithContext(ctx aws.Context, input *GetFlowVersionInput, opts ...request.Option) (*GetFlowVersionOutput, error)

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

See GetFlowVersion 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) GetFlowWithContext added in v1.54.18 

func (c *BedrockAgent) GetFlowWithContext(ctx aws.Context, input *GetFlowInput, opts ...request.Option) (*GetFlowOutput, error)

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

See GetFlow 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) GetPrompt added in v1.54.18 

func (c *BedrockAgent) GetPrompt(input *GetPromptInput) (*GetPromptOutput, error)

GetPrompt API operation for Agents for Amazon Bedrock.

Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html) and View information about a version of your prompt (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.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 GetPrompt 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/GetPrompt

func (*BedrockAgent) GetPromptRequest added in v1.54.18 

func (c *BedrockAgent) GetPromptRequest(input *GetPromptInput) (req *request.Request, output *GetPromptOutput)

GetPromptRequest generates a "aws/request.Request" representing the client's request for the GetPrompt 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 GetPrompt for more information on using the GetPrompt 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 GetPromptRequest method.
req, resp := client.GetPromptRequest(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/GetPrompt

func (*BedrockAgent) GetPromptWithContext added in v1.54.18 

func (c *BedrockAgent) GetPromptWithContext(ctx aws.Context, input *GetPromptInput, opts ...request.Option) (*GetPromptOutput, error)

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

See GetPrompt 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) ListFlowAliases added in v1.54.18 

func (c *BedrockAgent) ListFlowAliases(input *ListFlowAliasesInput) (*ListFlowAliasesOutput, error)

ListFlowAliases API operation for Agents for Amazon Bedrock.

Returns a list of aliases for a flow.

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 ListFlowAliases 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/ListFlowAliases

func (*BedrockAgent) ListFlowAliasesPages added in v1.54.18 

func (c *BedrockAgent) ListFlowAliasesPages(input *ListFlowAliasesInput, fn func(*ListFlowAliasesOutput, bool) bool) error

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

See ListFlowAliases 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 ListFlowAliases operation.
pageNum := 0
err := client.ListFlowAliasesPages(params,
    func(page *bedrockagent.ListFlowAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListFlowAliasesPagesWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowAliasesPagesWithContext(ctx aws.Context, input *ListFlowAliasesInput, fn func(*ListFlowAliasesOutput, bool) bool, opts ...request.Option) error

ListFlowAliasesPagesWithContext same as ListFlowAliasesPages 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) ListFlowAliasesRequest added in v1.54.18 

func (c *BedrockAgent) ListFlowAliasesRequest(input *ListFlowAliasesInput) (req *request.Request, output *ListFlowAliasesOutput)

ListFlowAliasesRequest generates a "aws/request.Request" representing the client's request for the ListFlowAliases 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 ListFlowAliases for more information on using the ListFlowAliases 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 ListFlowAliasesRequest method.
req, resp := client.ListFlowAliasesRequest(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/ListFlowAliases

func (*BedrockAgent) ListFlowAliasesWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowAliasesWithContext(ctx aws.Context, input *ListFlowAliasesInput, opts ...request.Option) (*ListFlowAliasesOutput, error)

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

See ListFlowAliases 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) ListFlowVersions added in v1.54.18 

func (c *BedrockAgent) ListFlowVersions(input *ListFlowVersionsInput) (*ListFlowVersionsOutput, error)

ListFlowVersions API operation for Agents for Amazon Bedrock.

Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 ListFlowVersions 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/ListFlowVersions

func (*BedrockAgent) ListFlowVersionsPages added in v1.54.18 

func (c *BedrockAgent) ListFlowVersionsPages(input *ListFlowVersionsInput, fn func(*ListFlowVersionsOutput, bool) bool) error

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

See ListFlowVersions 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 ListFlowVersions operation.
pageNum := 0
err := client.ListFlowVersionsPages(params,
    func(page *bedrockagent.ListFlowVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListFlowVersionsPagesWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowVersionsPagesWithContext(ctx aws.Context, input *ListFlowVersionsInput, fn func(*ListFlowVersionsOutput, bool) bool, opts ...request.Option) error

ListFlowVersionsPagesWithContext same as ListFlowVersionsPages 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) ListFlowVersionsRequest added in v1.54.18 

func (c *BedrockAgent) ListFlowVersionsRequest(input *ListFlowVersionsInput) (req *request.Request, output *ListFlowVersionsOutput)

ListFlowVersionsRequest generates a "aws/request.Request" representing the client's request for the ListFlowVersions 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 ListFlowVersions for more information on using the ListFlowVersions 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 ListFlowVersionsRequest method.
req, resp := client.ListFlowVersionsRequest(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/ListFlowVersions

func (*BedrockAgent) ListFlowVersionsWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowVersionsWithContext(ctx aws.Context, input *ListFlowVersionsInput, opts ...request.Option) (*ListFlowVersionsOutput, error)

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

See ListFlowVersions 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) ListFlows added in v1.54.18 

func (c *BedrockAgent) ListFlows(input *ListFlowsInput) (*ListFlowsOutput, error)

ListFlows API operation for Agents for Amazon Bedrock.

Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.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 ListFlows 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/ListFlows

func (*BedrockAgent) ListFlowsPages added in v1.54.18 

func (c *BedrockAgent) ListFlowsPages(input *ListFlowsInput, fn func(*ListFlowsOutput, bool) bool) error

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

See ListFlows 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 ListFlows operation.
pageNum := 0
err := client.ListFlowsPages(params,
    func(page *bedrockagent.ListFlowsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListFlowsPagesWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowsPagesWithContext(ctx aws.Context, input *ListFlowsInput, fn func(*ListFlowsOutput, bool) bool, opts ...request.Option) error

ListFlowsPagesWithContext same as ListFlowsPages 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) ListFlowsRequest added in v1.54.18 

func (c *BedrockAgent) ListFlowsRequest(input *ListFlowsInput) (req *request.Request, output *ListFlowsOutput)

ListFlowsRequest generates a "aws/request.Request" representing the client's request for the ListFlows 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 ListFlows for more information on using the ListFlows 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 ListFlowsRequest method.
req, resp := client.ListFlowsRequest(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/ListFlows

func (*BedrockAgent) ListFlowsWithContext added in v1.54.18 

func (c *BedrockAgent) ListFlowsWithContext(ctx aws.Context, input *ListFlowsInput, opts ...request.Option) (*ListFlowsOutput, error)

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

See ListFlows 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) ListPrompts added in v1.54.18 

func (c *BedrockAgent) ListPrompts(input *ListPromptsInput) (*ListPromptsOutput, error)

ListPrompts API operation for Agents for Amazon Bedrock.

Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.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 ListPrompts 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/ListPrompts

func (*BedrockAgent) ListPromptsPages added in v1.54.18 

func (c *BedrockAgent) ListPromptsPages(input *ListPromptsInput, fn func(*ListPromptsOutput, bool) bool) error

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

See ListPrompts 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 ListPrompts operation.
pageNum := 0
err := client.ListPromptsPages(params,
    func(page *bedrockagent.ListPromptsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*BedrockAgent) ListPromptsPagesWithContext added in v1.54.18 

func (c *BedrockAgent) ListPromptsPagesWithContext(ctx aws.Context, input *ListPromptsInput, fn func(*ListPromptsOutput, bool) bool, opts ...request.Option) error

ListPromptsPagesWithContext same as ListPromptsPages 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) ListPromptsRequest added in v1.54.18 

func (c *BedrockAgent) ListPromptsRequest(input *ListPromptsInput) (req *request.Request, output *ListPromptsOutput)

ListPromptsRequest generates a "aws/request.Request" representing the client's request for the ListPrompts 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 ListPrompts for more information on using the ListPrompts 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 ListPromptsRequest method.
req, resp := client.ListPromptsRequest(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/ListPrompts

func (*BedrockAgent) ListPromptsWithContext added in v1.54.18 

func (c *BedrockAgent) ListPromptsWithContext(ctx aws.Context, input *ListPromptsInput, opts ...request.Option) (*ListPromptsOutput, error)

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

See ListPrompts 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) PrepareFlow added in v1.54.18 

func (c *BedrockAgent) PrepareFlow(input *PrepareFlowInput) (*PrepareFlowOutput, error)

PrepareFlow API operation for Agents for Amazon Bedrock.

Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.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 PrepareFlow 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/PrepareFlow

func (*BedrockAgent) PrepareFlowRequest added in v1.54.18 

func (c *BedrockAgent) PrepareFlowRequest(input *PrepareFlowInput) (req *request.Request, output *PrepareFlowOutput)

PrepareFlowRequest generates a "aws/request.Request" representing the client's request for the PrepareFlow 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 PrepareFlow for more information on using the PrepareFlow 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 PrepareFlowRequest method.
req, resp := client.PrepareFlowRequest(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/PrepareFlow

func (*BedrockAgent) PrepareFlowWithContext added in v1.54.18 

func (c *BedrockAgent) PrepareFlowWithContext(ctx aws.Context, input *PrepareFlowInput, opts ...request.Option) (*PrepareFlowOutput, error)

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

See PrepareFlow 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 the configurations for a data source connector.

You can't change the chunkingConfiguration after you create the data source connector. 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) UpdateFlow added in v1.54.18 

func (c *BedrockAgent) UpdateFlow(input *UpdateFlowInput) (*UpdateFlowOutput, error)

UpdateFlow API operation for Agents for Amazon Bedrock.

Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and Create a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.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 UpdateFlow 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/UpdateFlow

func (*BedrockAgent) UpdateFlowAlias added in v1.54.18 

func (c *BedrockAgent) UpdateFlowAlias(input *UpdateFlowAliasInput) (*UpdateFlowAliasOutput, error)

UpdateFlowAlias API operation for Agents for Amazon Bedrock.

Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.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 UpdateFlowAlias 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/UpdateFlowAlias

func (*BedrockAgent) UpdateFlowAliasRequest added in v1.54.18 

func (c *BedrockAgent) UpdateFlowAliasRequest(input *UpdateFlowAliasInput) (req *request.Request, output *UpdateFlowAliasOutput)

UpdateFlowAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateFlowAlias 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 UpdateFlowAlias for more information on using the UpdateFlowAlias 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 UpdateFlowAliasRequest method.
req, resp := client.UpdateFlowAliasRequest(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/UpdateFlowAlias

func (*BedrockAgent) UpdateFlowAliasWithContext added in v1.54.18 

func (c *BedrockAgent) UpdateFlowAliasWithContext(ctx aws.Context, input *UpdateFlowAliasInput, opts ...request.Option) (*UpdateFlowAliasOutput, error)

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

See UpdateFlowAlias 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) UpdateFlowRequest added in v1.54.18 

func (c *BedrockAgent) UpdateFlowRequest(input *UpdateFlowInput) (req *request.Request, output *UpdateFlowOutput)

UpdateFlowRequest generates a "aws/request.Request" representing the client's request for the UpdateFlow 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 UpdateFlow for more information on using the UpdateFlow 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 UpdateFlowRequest method.
req, resp := client.UpdateFlowRequest(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/UpdateFlow

func (*BedrockAgent) UpdateFlowWithContext added in v1.54.18 

func (c *BedrockAgent) UpdateFlowWithContext(ctx aws.Context, input *UpdateFlowInput, opts ...request.Option) (*UpdateFlowOutput, error)

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

See UpdateFlow 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.

func (*BedrockAgent) UpdatePrompt added in v1.54.18 

func (c *BedrockAgent) UpdatePrompt(input *UpdatePromptInput) (*UpdatePromptOutput, error)

UpdatePrompt API operation for Agents for Amazon Bedrock.

Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html) and Edit prompts in your prompt library (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-edit) 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 UpdatePrompt 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/UpdatePrompt

func (*BedrockAgent) UpdatePromptRequest added in v1.54.18 

func (c *BedrockAgent) UpdatePromptRequest(input *UpdatePromptInput) (req *request.Request, output *UpdatePromptOutput)

UpdatePromptRequest generates a "aws/request.Request" representing the client's request for the UpdatePrompt 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 UpdatePrompt for more information on using the UpdatePrompt 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 UpdatePromptRequest method.
req, resp := client.UpdatePromptRequest(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/UpdatePrompt

func (*BedrockAgent) UpdatePromptWithContext added in v1.54.18 

func (c *BedrockAgent) UpdatePromptWithContext(ctx aws.Context, input *UpdatePromptInput, opts ...request.Option) (*UpdatePromptOutput, error)

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

See UpdatePrompt 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 added in v1.53.13 

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 added in v1.53.13 

func (s BedrockEmbeddingModelConfiguration) 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 (*BedrockEmbeddingModelConfiguration) SetDimensions added in v1.53.13 

func (s *BedrockEmbeddingModelConfiguration) SetDimensions(v int64) *BedrockEmbeddingModelConfiguration

SetDimensions sets the Dimensions field's value.

func (BedrockEmbeddingModelConfiguration) String added in v1.53.13 

func (s BedrockEmbeddingModelConfiguration) 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 BedrockFoundationModelConfiguration added in v1.54.18 

type BedrockFoundationModelConfiguration struct {

	// The model's ARN.
	//
	// ModelArn is a required field
	ModelArn *string `locationName:"modelArn" min:"1" type:"string" required:"true"`

	// Instructions for interpreting the contents of a document.
	ParsingPrompt *ParsingPrompt `locationName:"parsingPrompt" type:"structure"`
	// contains filtered or unexported fields
}

Settings for a foundation model used to parse documents for a data source.

func (BedrockFoundationModelConfiguration) GoString added in v1.54.18 

func (s BedrockFoundationModelConfiguration) 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 (*BedrockFoundationModelConfiguration) SetModelArn added in v1.54.18 

func (s *BedrockFoundationModelConfiguration) SetModelArn(v string) *BedrockFoundationModelConfiguration

SetModelArn sets the ModelArn field's value.

func (*BedrockFoundationModelConfiguration) SetParsingPrompt added in v1.54.18 

func (s *BedrockFoundationModelConfiguration) SetParsingPrompt(v *ParsingPrompt) *BedrockFoundationModelConfiguration

SetParsingPrompt sets the ParsingPrompt field's value.

func (BedrockFoundationModelConfiguration) String added in v1.54.18 

func (s BedrockFoundationModelConfiguration) 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 (*BedrockFoundationModelConfiguration) Validate added in v1.54.18 

func (s *BedrockFoundationModelConfiguration) Validate() error

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

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.
	//
	//    * HIERARCHICAL – Split documents into layers of chunks where the first
	//    layer contains large chunks, and the second layer contains smaller chunks
	//    derived from the first layer.
	//
	//    * SEMANTIC – Split documents into chunks based on groups of similar
	//    content derived with natural language processing.
	//
	//    * 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"`

	// Settings for hierarchical document chunking for a data source. Hierarchical
	// chunking splits documents into layers of chunks where the first layer contains
	// large chunks, and the second layer contains smaller chunks derived from the
	// first layer.
	HierarchicalChunkingConfiguration *HierarchicalChunkingConfiguration `locationName:"hierarchicalChunkingConfiguration" type:"structure"`

	// Settings for semantic document chunking for a data source. Semantic chunking
	// splits a document into into smaller documents based on groups of similar
	// content derived from the text with natural language processing.
	SemanticChunkingConfiguration *SemanticChunkingConfiguration `locationName:"semanticChunkingConfiguration" 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) SetHierarchicalChunkingConfiguration added in v1.54.18 

func (s *ChunkingConfiguration) SetHierarchicalChunkingConfiguration(v *HierarchicalChunkingConfiguration) *ChunkingConfiguration

SetHierarchicalChunkingConfiguration sets the HierarchicalChunkingConfiguration field's value.

func (*ChunkingConfiguration) SetSemanticChunkingConfiguration added in v1.54.18 

func (s *ChunkingConfiguration) SetSemanticChunkingConfiguration(v *SemanticChunkingConfiguration) *ChunkingConfiguration

SetSemanticChunkingConfiguration sets the SemanticChunkingConfiguration 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 CollectorFlowNodeConfiguration added in v1.54.18 

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

Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (CollectorFlowNodeConfiguration) GoString added in v1.54.18 

func (s CollectorFlowNodeConfiguration) 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 (CollectorFlowNodeConfiguration) String added in v1.54.18 

func (s CollectorFlowNodeConfiguration) 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 ConditionFlowNodeConfiguration added in v1.54.18 

type ConditionFlowNodeConfiguration struct {

	// An array of conditions. Each member contains the name of a condition and
	// an expression that defines the condition.
	//
	// Conditions is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ConditionFlowNodeConfiguration's
	// String and GoString methods.
	//
	// Conditions is a required field
	Conditions []*FlowCondition `locationName:"conditions" min:"1" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (ConditionFlowNodeConfiguration) GoString added in v1.54.18 

func (s ConditionFlowNodeConfiguration) 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 (*ConditionFlowNodeConfiguration) SetConditions added in v1.54.18 

func (s *ConditionFlowNodeConfiguration) SetConditions(v []*FlowCondition) *ConditionFlowNodeConfiguration

SetConditions sets the Conditions field's value.

func (ConditionFlowNodeConfiguration) String added in v1.54.18 

func (s ConditionFlowNodeConfiguration) 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 (*ConditionFlowNodeConfiguration) Validate added in v1.54.18 

func (s *ConditionFlowNodeConfiguration) 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 ConfluenceCrawlerConfiguration added in v1.54.18 

type ConfluenceCrawlerConfiguration struct {

	// The configuration of filtering the Confluence content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration `locationName:"filterConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the Confluence content. For example, configuring specific types of Confluence content.

func (ConfluenceCrawlerConfiguration) GoString added in v1.54.18 

func (s ConfluenceCrawlerConfiguration) 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 (*ConfluenceCrawlerConfiguration) SetFilterConfiguration added in v1.54.18 

func (s *ConfluenceCrawlerConfiguration) SetFilterConfiguration(v *CrawlFilterConfiguration) *ConfluenceCrawlerConfiguration

SetFilterConfiguration sets the FilterConfiguration field's value.

func (ConfluenceCrawlerConfiguration) String added in v1.54.18 

func (s ConfluenceCrawlerConfiguration) 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 (*ConfluenceCrawlerConfiguration) Validate added in v1.54.18 

func (s *ConfluenceCrawlerConfiguration) Validate() error

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

type ConfluenceDataSourceConfiguration added in v1.54.18 

type ConfluenceDataSourceConfiguration struct {

	// The configuration of the Confluence content. For example, configuring specific
	// types of Confluence content.
	CrawlerConfiguration *ConfluenceCrawlerConfiguration `locationName:"crawlerConfiguration" type:"structure"`

	// The endpoint information to connect to your Confluence data source.
	//
	// SourceConfiguration is a required field
	SourceConfiguration *ConfluenceSourceConfiguration `locationName:"sourceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration information to connect to Confluence as your data source.

func (ConfluenceDataSourceConfiguration) GoString added in v1.54.18 

func (s ConfluenceDataSourceConfiguration) 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 (*ConfluenceDataSourceConfiguration) SetCrawlerConfiguration added in v1.54.18 

func (s *ConfluenceDataSourceConfiguration) SetCrawlerConfiguration(v *ConfluenceCrawlerConfiguration) *ConfluenceDataSourceConfiguration

SetCrawlerConfiguration sets the CrawlerConfiguration field's value.

func (*ConfluenceDataSourceConfiguration) SetSourceConfiguration added in v1.54.18 

func (s *ConfluenceDataSourceConfiguration) SetSourceConfiguration(v *ConfluenceSourceConfiguration) *ConfluenceDataSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (ConfluenceDataSourceConfiguration) String added in v1.54.18 

func (s ConfluenceDataSourceConfiguration) 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 (*ConfluenceDataSourceConfiguration) Validate added in v1.54.18 

func (s *ConfluenceDataSourceConfiguration) Validate() error

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

type ConfluenceSourceConfiguration added in v1.54.18 

type ConfluenceSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your Confluence
	// instance.
	//
	// AuthType is a required field
	AuthType *string `locationName:"authType" type:"string" required:"true" enum:"ConfluenceAuthType"`

	// The Amazon Resource Name of an Secrets Manager secret that stores your authentication
	// credentials for your SharePoint site/sites. For more information on the key-value
	// pairs that must be included in your secret, depending on your authentication
	// type, see Confluence connection configuration (https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector).
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The supported host type, whether online/cloud or server/on-premises.
	//
	// HostType is a required field
	HostType *string `locationName:"hostType" type:"string" required:"true" enum:"ConfluenceHostType"`

	// The Confluence host URL or instance URL.
	//
	// HostUrl is a required field
	HostUrl *string `locationName:"hostUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The endpoint information to connect to your Confluence data source.

func (ConfluenceSourceConfiguration) GoString added in v1.54.18 

func (s ConfluenceSourceConfiguration) 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 (*ConfluenceSourceConfiguration) SetAuthType added in v1.54.18 

func (s *ConfluenceSourceConfiguration) SetAuthType(v string) *ConfluenceSourceConfiguration

SetAuthType sets the AuthType field's value.

func (*ConfluenceSourceConfiguration) SetCredentialsSecretArn added in v1.54.18 

func (s *ConfluenceSourceConfiguration) SetCredentialsSecretArn(v string) *ConfluenceSourceConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*ConfluenceSourceConfiguration) SetHostType added in v1.54.18 

func (s *ConfluenceSourceConfiguration) SetHostType(v string) *ConfluenceSourceConfiguration

SetHostType sets the HostType field's value.

func (*ConfluenceSourceConfiguration) SetHostUrl added in v1.54.18 

func (s *ConfluenceSourceConfiguration) SetHostUrl(v string) *ConfluenceSourceConfiguration

SetHostUrl sets the HostUrl field's value.

func (ConfluenceSourceConfiguration) String added in v1.54.18 

func (s ConfluenceSourceConfiguration) 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 (*ConfluenceSourceConfiguration) Validate added in v1.54.18 

func (s *ConfluenceSourceConfiguration) Validate() error

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

type CrawlFilterConfiguration added in v1.54.18 

type CrawlFilterConfiguration struct {

	// The configuration of filtering certain objects or content types of the data
	// source.
	PatternObjectFilter *PatternObjectFilterConfiguration `locationName:"patternObjectFilter" type:"structure"`

	// The type of filtering that you want to apply to certain objects or content
	// of the data source. For example, the PATTERN type is regular expression patterns
	// you can apply to filter your content.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CrawlFilterConfigurationType"`
	// contains filtered or unexported fields
}

The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.

func (CrawlFilterConfiguration) GoString added in v1.54.18 

func (s CrawlFilterConfiguration) 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 (*CrawlFilterConfiguration) SetPatternObjectFilter added in v1.54.18 

func (s *CrawlFilterConfiguration) SetPatternObjectFilter(v *PatternObjectFilterConfiguration) *CrawlFilterConfiguration

SetPatternObjectFilter sets the PatternObjectFilter field's value.

func (*CrawlFilterConfiguration) SetType added in v1.54.18 

func (s *CrawlFilterConfiguration) SetType(v string) *CrawlFilterConfiguration

SetType sets the Type field's value.

func (CrawlFilterConfiguration) String added in v1.54.18 

func (s CrawlFilterConfiguration) 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 (*CrawlFilterConfiguration) Validate added in v1.54.18 

func (s *CrawlFilterConfiguration) Validate() error

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

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.
	//
	// To allow your agent to generate, run, and troubleshoot code when trying to
	// complete a task, set this field to AMAZON.CodeInterpreter. 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 

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

SetActionGroupExecutor sets the ActionGroupExecutor field's value.

func (*CreateAgentActionGroupInput) SetActionGroupName 

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

SetActionGroupName sets the ActionGroupName field's value.

func (*CreateAgentActionGroupInput) SetActionGroupState 

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

SetActionGroupState sets the ActionGroupState field's value.

func (*CreateAgentActionGroupInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*CreateAgentActionGroupInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*CreateAgentActionGroupInput) SetApiSchema 

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

SetApiSchema sets the ApiSchema field's value.

func (*CreateAgentActionGroupInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateAgentActionGroupInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateAgentActionGroupInput) SetFunctionSchema added in v1.51.26 

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

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 

func (s CreateAgentActionGroupInput) 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 (*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 

func (s *CreateAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) *CreateAgentActionGroupOutput

SetAgentActionGroup sets the AgentActionGroup field's value.

func (CreateAgentActionGroupOutput) String 

func (s CreateAgentActionGroupOutput) 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 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 

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

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 

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

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*CreateAgentAliasInput) SetTags 

func (s *CreateAgentAliasInput) SetTags(v map[string]*string) *CreateAgentAliasInput

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 

func (s *CreateAgentAliasOutput) SetAgentAlias(v *AgentAlias) *CreateAgentAliasOutput

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 the details of the memory configured for the agent.
	MemoryConfiguration *MemoryConfiguration `locationName:"memoryConfiguration" type:"structure"`

	// 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 added in v1.53.6 

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) SetMemoryConfiguration added in v1.54.18 

func (s *CreateAgentInput) SetMemoryConfiguration(v *MemoryConfiguration) *CreateAgentInput

SetMemoryConfiguration sets the MemoryConfiguration 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 for the data source.
	//
	// You can set the data deletion policy to:
	//
	//    * DELETE: Deletes all underlying data belonging to the data source from
	//    the vector store upon deletion of a knowledge base or data source resource.
	//    Note that the vector store itself is not deleted, only the underlying
	//    data. This flag is ignored if an Amazon Web Services account is deleted.
	//
	//    * RETAIN: Retains all underlying data in your vector store upon deletion
	//    of a knowledge base or data source resource.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// The connection configuration for the data source.
	//
	// 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 added in v1.51.27 

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 

func (s *CreateDataSourceInput) SetName(v string) *CreateDataSourceInput

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 

func (s *CreateDataSourceOutput) SetDataSource(v *DataSource) *CreateDataSourceOutput

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 CreateFlowAliasInput added in v1.54.18 

type CreateFlowAliasInput 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 for the alias.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the flow for which to create an alias.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`

	// A name for the alias.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contains information about the version to which to map the alias.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`

	// Any tags that you want to attach to the alias of the flow. For more information,
	// see Tagging resources in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateFlowAliasInput) GoString added in v1.54.18 

func (s CreateFlowAliasInput) 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 (*CreateFlowAliasInput) SetClientToken added in v1.54.18 

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

SetClientToken sets the ClientToken field's value.

func (*CreateFlowAliasInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowAliasInput) SetFlowIdentifier added in v1.54.18 

func (s *CreateFlowAliasInput) SetFlowIdentifier(v string) *CreateFlowAliasInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*CreateFlowAliasInput) SetName added in v1.54.18 

func (s *CreateFlowAliasInput) SetName(v string) *CreateFlowAliasInput

SetName sets the Name field's value.

func (*CreateFlowAliasInput) SetRoutingConfiguration added in v1.54.18 

func (s *CreateFlowAliasInput) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *CreateFlowAliasInput

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*CreateFlowAliasInput) SetTags added in v1.54.18 

func (s *CreateFlowAliasInput) SetTags(v map[string]*string) *CreateFlowAliasInput

SetTags sets the Tags field's value.

func (CreateFlowAliasInput) String added in v1.54.18 

func (s CreateFlowAliasInput) 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 (*CreateFlowAliasInput) Validate added in v1.54.18 

func (s *CreateFlowAliasInput) Validate() error

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

type CreateFlowAliasOutput added in v1.54.18 

type CreateFlowAliasOutput struct {

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

	// The time at which the alias 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"`

	// The unique identifier of the flow that the alias belongs to.
	//
	// FlowId is a required field
	FlowId *string `locationName:"flowId" type:"string" required:"true"`

	// The unique identifier of the alias.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

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

	// Contains information about the version that the alias is mapped to.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`

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

func (CreateFlowAliasOutput) GoString added in v1.54.18 

func (s CreateFlowAliasOutput) 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 (*CreateFlowAliasOutput) SetArn added in v1.54.18 

func (s *CreateFlowAliasOutput) SetArn(v string) *CreateFlowAliasOutput

SetArn sets the Arn field's value.

func (*CreateFlowAliasOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreateFlowAliasOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowAliasOutput) SetFlowId added in v1.54.18 

func (s *CreateFlowAliasOutput) SetFlowId(v string) *CreateFlowAliasOutput

SetFlowId sets the FlowId field's value.

func (*CreateFlowAliasOutput) SetId added in v1.54.18 

func (s *CreateFlowAliasOutput) SetId(v string) *CreateFlowAliasOutput

SetId sets the Id field's value.

func (*CreateFlowAliasOutput) SetName added in v1.54.18 

func (s *CreateFlowAliasOutput) SetName(v string) *CreateFlowAliasOutput

SetName sets the Name field's value.

func (*CreateFlowAliasOutput) SetRoutingConfiguration added in v1.54.18 

func (s *CreateFlowAliasOutput) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *CreateFlowAliasOutput

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*CreateFlowAliasOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (CreateFlowAliasOutput) String added in v1.54.18 

func (s CreateFlowAliasOutput) 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 CreateFlowInput added in v1.54.18 

type CreateFlowInput 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 Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// A definition of the nodes and connections between nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

	// A description for the flow.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// and manage a flow. For more information, see Create a service role for flows
	// in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// A name for the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Any tags that you want to attach to the flow. For more information, see Tagging
	// resources in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateFlowInput) GoString added in v1.54.18 

func (s CreateFlowInput) 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 (*CreateFlowInput) SetClientToken added in v1.54.18 

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

SetClientToken sets the ClientToken field's value.

func (*CreateFlowInput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreateFlowInput) SetDefinition added in v1.54.18 

func (s *CreateFlowInput) SetDefinition(v *FlowDefinition) *CreateFlowInput

SetDefinition sets the Definition field's value.

func (*CreateFlowInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowInput) SetExecutionRoleArn added in v1.54.18 

func (s *CreateFlowInput) SetExecutionRoleArn(v string) *CreateFlowInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateFlowInput) SetName added in v1.54.18 

func (s *CreateFlowInput) SetName(v string) *CreateFlowInput

SetName sets the Name field's value.

func (*CreateFlowInput) SetTags added in v1.54.18 

func (s *CreateFlowInput) SetTags(v map[string]*string) *CreateFlowInput

SetTags sets the Tags field's value.

func (CreateFlowInput) String added in v1.54.18 

func (s CreateFlowInput) 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 (*CreateFlowInput) Validate added in v1.54.18 

func (s *CreateFlowInput) Validate() error

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

type CreateFlowOutput added in v1.54.18 

type CreateFlowOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the flow 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 you encrypted the flow
	// with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// A definition of the nodes and connections between nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

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

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// a flow. For more information, see Create a service role for flows in Amazon
	// Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow. When you submit this request, the status will be
	// NotPrepared. If creation fails, the status becomes Failed.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

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

	// The version of the flow. When you create a flow, the version created is the
	// DRAFT version.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFlowOutput) GoString added in v1.54.18 

func (s CreateFlowOutput) 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 (*CreateFlowOutput) SetArn added in v1.54.18 

func (s *CreateFlowOutput) SetArn(v string) *CreateFlowOutput

SetArn sets the Arn field's value.

func (*CreateFlowOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreateFlowOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreateFlowOutput) SetDefinition added in v1.54.18 

func (s *CreateFlowOutput) SetDefinition(v *FlowDefinition) *CreateFlowOutput

SetDefinition sets the Definition field's value.

func (*CreateFlowOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowOutput) SetExecutionRoleArn added in v1.54.18 

func (s *CreateFlowOutput) SetExecutionRoleArn(v string) *CreateFlowOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateFlowOutput) SetId added in v1.54.18 

func (s *CreateFlowOutput) SetId(v string) *CreateFlowOutput

SetId sets the Id field's value.

func (*CreateFlowOutput) SetName added in v1.54.18 

func (s *CreateFlowOutput) SetName(v string) *CreateFlowOutput

SetName sets the Name field's value.

func (*CreateFlowOutput) SetStatus added in v1.54.18 

func (s *CreateFlowOutput) SetStatus(v string) *CreateFlowOutput

SetStatus sets the Status field's value.

func (*CreateFlowOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*CreateFlowOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (CreateFlowOutput) String added in v1.54.18 

func (s CreateFlowOutput) 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 CreateFlowVersionInput added in v1.54.18 

type CreateFlowVersionInput 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 version of the flow.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the flow that you want to create a version of.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFlowVersionInput) GoString added in v1.54.18 

func (s CreateFlowVersionInput) 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 (*CreateFlowVersionInput) SetClientToken added in v1.54.18 

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

SetClientToken sets the ClientToken field's value.

func (*CreateFlowVersionInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowVersionInput) SetFlowIdentifier added in v1.54.18 

func (s *CreateFlowVersionInput) SetFlowIdentifier(v string) *CreateFlowVersionInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (CreateFlowVersionInput) String added in v1.54.18 

func (s CreateFlowVersionInput) 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 (*CreateFlowVersionInput) Validate added in v1.54.18 

func (s *CreateFlowVersionInput) Validate() error

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

type CreateFlowVersionOutput added in v1.54.18 

type CreateFlowVersionOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

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

	// The KMS key that the flow is encrypted with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// A definition of the nodes and connections in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

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

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// a flow. For more information, see Create a service role for flows in Amazon
	// Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow version.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

	// The version of the flow that was created. Versions are numbered incrementally,
	// starting from 1.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFlowVersionOutput) GoString added in v1.54.18 

func (s CreateFlowVersionOutput) 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 (*CreateFlowVersionOutput) SetArn added in v1.54.18 

func (s *CreateFlowVersionOutput) SetArn(v string) *CreateFlowVersionOutput

SetArn sets the Arn field's value.

func (*CreateFlowVersionOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreateFlowVersionOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreateFlowVersionOutput) SetDefinition added in v1.54.18 

func (s *CreateFlowVersionOutput) SetDefinition(v *FlowDefinition) *CreateFlowVersionOutput

SetDefinition sets the Definition field's value.

func (*CreateFlowVersionOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreateFlowVersionOutput) SetExecutionRoleArn added in v1.54.18 

func (s *CreateFlowVersionOutput) SetExecutionRoleArn(v string) *CreateFlowVersionOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*CreateFlowVersionOutput) SetId added in v1.54.18 

func (s *CreateFlowVersionOutput) SetId(v string) *CreateFlowVersionOutput

SetId sets the Id field's value.

func (*CreateFlowVersionOutput) SetName added in v1.54.18 

func (s *CreateFlowVersionOutput) SetName(v string) *CreateFlowVersionOutput

SetName sets the Name field's value.

func (*CreateFlowVersionOutput) SetStatus added in v1.54.18 

func (s *CreateFlowVersionOutput) SetStatus(v string) *CreateFlowVersionOutput

SetStatus sets the Status field's value.

func (*CreateFlowVersionOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (CreateFlowVersionOutput) String added in v1.54.18 

func (s CreateFlowVersionOutput) 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 

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

SetClientToken sets the ClientToken field's value.

func (*CreateKnowledgeBaseInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateKnowledgeBaseInput) SetKnowledgeBaseConfiguration 

func (s *CreateKnowledgeBaseInput) SetKnowledgeBaseConfiguration(v *KnowledgeBaseConfiguration) *CreateKnowledgeBaseInput

SetKnowledgeBaseConfiguration sets the KnowledgeBaseConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetName 

func (s *CreateKnowledgeBaseInput) SetName(v string) *CreateKnowledgeBaseInput

SetName sets the Name field's value.

func (*CreateKnowledgeBaseInput) SetRoleArn 

func (s *CreateKnowledgeBaseInput) SetRoleArn(v string) *CreateKnowledgeBaseInput

SetRoleArn sets the RoleArn field's value.

func (*CreateKnowledgeBaseInput) SetStorageConfiguration 

func (s *CreateKnowledgeBaseInput) SetStorageConfiguration(v *StorageConfiguration) *CreateKnowledgeBaseInput

SetStorageConfiguration sets the StorageConfiguration field's value.

func (*CreateKnowledgeBaseInput) SetTags 

func (s *CreateKnowledgeBaseInput) SetTags(v map[string]*string) *CreateKnowledgeBaseInput

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 

func (s *CreateKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *CreateKnowledgeBaseOutput

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 CreatePromptInput added in v1.54.18 

type CreatePromptInput 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 Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The name of the default variant for the prompt. This value must match the
	// name field in the relevant PromptVariant (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html)
	// object.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

	// A description for the prompt.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A name for the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Any tags that you want to attach to the prompt. For more information, see
	// Tagging resources in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePromptInput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreatePromptInput) GoString added in v1.54.18 

func (s CreatePromptInput) 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 (*CreatePromptInput) SetClientToken added in v1.54.18 

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

SetClientToken sets the ClientToken field's value.

func (*CreatePromptInput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreatePromptInput) SetDefaultVariant added in v1.54.18 

func (s *CreatePromptInput) SetDefaultVariant(v string) *CreatePromptInput

SetDefaultVariant sets the DefaultVariant field's value.

func (*CreatePromptInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreatePromptInput) SetName added in v1.54.18 

func (s *CreatePromptInput) SetName(v string) *CreatePromptInput

SetName sets the Name field's value.

func (*CreatePromptInput) SetTags added in v1.54.18 

func (s *CreatePromptInput) SetTags(v map[string]*string) *CreatePromptInput

SetTags sets the Tags field's value.

func (*CreatePromptInput) SetVariants added in v1.54.18 

func (s *CreatePromptInput) SetVariants(v []*PromptVariant) *CreatePromptInput

SetVariants sets the Variants field's value.

func (CreatePromptInput) String added in v1.54.18 

func (s CreatePromptInput) 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 (*CreatePromptInput) Validate added in v1.54.18 

func (s *CreatePromptInput) Validate() error

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

type CreatePromptOutput added in v1.54.18 

type CreatePromptOutput struct {

	// The Amazon Resource Name (ARN) of the prompt.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the prompt 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 you encrypted the prompt
	// with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The name of the default variant for your prompt.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

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

	// The unique identifier of the prompt.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

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

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePromptOutput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`

	// The version of the prompt. When you create a prompt, the version created
	// is the DRAFT version.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePromptOutput) GoString added in v1.54.18 

func (s CreatePromptOutput) 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 (*CreatePromptOutput) SetArn added in v1.54.18 

func (s *CreatePromptOutput) SetArn(v string) *CreatePromptOutput

SetArn sets the Arn field's value.

func (*CreatePromptOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreatePromptOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreatePromptOutput) SetDefaultVariant added in v1.54.18 

func (s *CreatePromptOutput) SetDefaultVariant(v string) *CreatePromptOutput

SetDefaultVariant sets the DefaultVariant field's value.

func (*CreatePromptOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreatePromptOutput) SetId added in v1.54.18 

func (s *CreatePromptOutput) SetId(v string) *CreatePromptOutput

SetId sets the Id field's value.

func (*CreatePromptOutput) SetName added in v1.54.18 

func (s *CreatePromptOutput) SetName(v string) *CreatePromptOutput

SetName sets the Name field's value.

func (*CreatePromptOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*CreatePromptOutput) SetVariants added in v1.54.18 

func (s *CreatePromptOutput) SetVariants(v []*PromptVariant) *CreatePromptOutput

SetVariants sets the Variants field's value.

func (*CreatePromptOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (CreatePromptOutput) String added in v1.54.18 

func (s CreatePromptOutput) 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 CreatePromptVersionInput added in v1.54.18 

type CreatePromptVersionInput 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 for the version of the prompt.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the prompt that you want to create a version of.
	//
	// PromptIdentifier is a required field
	PromptIdentifier *string `location:"uri" locationName:"promptIdentifier" type:"string" required:"true"`

	// Any tags that you want to attach to the version of the prompt. For more information,
	// see Tagging resources in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreatePromptVersionInput) GoString added in v1.54.18 

func (s CreatePromptVersionInput) 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 (*CreatePromptVersionInput) SetClientToken added in v1.54.18 

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

SetClientToken sets the ClientToken field's value.

func (*CreatePromptVersionInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreatePromptVersionInput) SetPromptIdentifier added in v1.54.18 

func (s *CreatePromptVersionInput) SetPromptIdentifier(v string) *CreatePromptVersionInput

SetPromptIdentifier sets the PromptIdentifier field's value.

func (*CreatePromptVersionInput) SetTags added in v1.54.18 

func (s *CreatePromptVersionInput) SetTags(v map[string]*string) *CreatePromptVersionInput

SetTags sets the Tags field's value.

func (CreatePromptVersionInput) String added in v1.54.18 

func (s CreatePromptVersionInput) 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 (*CreatePromptVersionInput) Validate added in v1.54.18 

func (s *CreatePromptVersionInput) Validate() error

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

type CreatePromptVersionOutput added in v1.54.18 

type CreatePromptVersionOutput struct {

	// The Amazon Resource Name (ARN) of the version of the prompt.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the prompt 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 to encrypt the version of the
	// prompt.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The name of the default variant for the prompt. This value must match the
	// name field in the relevant PromptVariant (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html)
	// object.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

	// A description for the prompt version.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the prompt.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the prompt version.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

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

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreatePromptVersionOutput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`

	// The version of the prompt that was created. Versions are numbered incrementally,
	// starting from 1.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePromptVersionOutput) GoString added in v1.54.18 

func (s CreatePromptVersionOutput) 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 (*CreatePromptVersionOutput) SetArn added in v1.54.18 

func (s *CreatePromptVersionOutput) SetArn(v string) *CreatePromptVersionOutput

SetArn sets the Arn field's value.

func (*CreatePromptVersionOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreatePromptVersionOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*CreatePromptVersionOutput) SetDefaultVariant added in v1.54.18 

func (s *CreatePromptVersionOutput) SetDefaultVariant(v string) *CreatePromptVersionOutput

SetDefaultVariant sets the DefaultVariant field's value.

func (*CreatePromptVersionOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*CreatePromptVersionOutput) SetId added in v1.54.18 

func (s *CreatePromptVersionOutput) SetId(v string) *CreatePromptVersionOutput

SetId sets the Id field's value.

func (*CreatePromptVersionOutput) SetName added in v1.54.18 

func (s *CreatePromptVersionOutput) SetName(v string) *CreatePromptVersionOutput

SetName sets the Name field's value.

func (*CreatePromptVersionOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*CreatePromptVersionOutput) SetVariants added in v1.54.18 

func (s *CreatePromptVersionOutput) SetVariants(v []*PromptVariant) *CreatePromptVersionOutput

SetVariants sets the Variants field's value.

func (*CreatePromptVersionOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (CreatePromptVersionOutput) String added in v1.54.18 

func (s CreatePromptVersionOutput) 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 CustomTransformationConfiguration added in v1.54.18 

type CustomTransformationConfiguration struct {

	// An S3 bucket path for input and output objects.
	//
	// IntermediateStorage is a required field
	IntermediateStorage *IntermediateStorage `locationName:"intermediateStorage" type:"structure" required:"true"`

	// A Lambda function that processes documents.
	//
	// Transformations is a required field
	Transformations []*Transformation `locationName:"transformations" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Settings for customizing steps in the data source content ingestion pipeline.

You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.

To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk.

func (CustomTransformationConfiguration) GoString added in v1.54.18 

func (s CustomTransformationConfiguration) 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 (*CustomTransformationConfiguration) SetIntermediateStorage added in v1.54.18 

func (s *CustomTransformationConfiguration) SetIntermediateStorage(v *IntermediateStorage) *CustomTransformationConfiguration

SetIntermediateStorage sets the IntermediateStorage field's value.

func (*CustomTransformationConfiguration) SetTransformations added in v1.54.18 

func (s *CustomTransformationConfiguration) SetTransformations(v []*Transformation) *CustomTransformationConfiguration

SetTransformations sets the Transformations field's value.

func (CustomTransformationConfiguration) String added in v1.54.18 

func (s CustomTransformationConfiguration) 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 (*CustomTransformationConfiguration) Validate added in v1.54.18 

func (s *CustomTransformationConfiguration) Validate() error

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

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 the data source.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// The connection configuration for 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 `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 added in v1.51.27 

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 added in v1.51.27 

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 {

	// The configuration information to connect to Confluence as your data source.
	//
	// Confluence data source connector is in preview release and is subject to
	// change.
	ConfluenceConfiguration *ConfluenceDataSourceConfiguration `locationName:"confluenceConfiguration" type:"structure"`

	// The configuration information to connect to Amazon S3 as your data source.
	S3Configuration *S3DataSourceConfiguration `locationName:"s3Configuration" type:"structure"`

	// The configuration information to connect to Salesforce as your data source.
	//
	// Salesforce data source connector is in preview release and is subject to
	// change.
	SalesforceConfiguration *SalesforceDataSourceConfiguration `locationName:"salesforceConfiguration" type:"structure"`

	// The configuration information to connect to SharePoint as your data source.
	//
	// SharePoint data source connector is in preview release and is subject to
	// change.
	SharePointConfiguration *SharePointDataSourceConfiguration `locationName:"sharePointConfiguration" type:"structure"`

	// The type of data source.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"DataSourceType"`

	// The configuration of web URLs to crawl for your data source. You should be
	// authorized to crawl the URLs.
	//
	// Crawling web URLs as your data source is in preview release and is subject
	// to change.
	WebConfiguration *WebDataSourceConfiguration `locationName:"webConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The connection configuration for the data source.

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) SetConfluenceConfiguration added in v1.54.18 

func (s *DataSourceConfiguration) SetConfluenceConfiguration(v *ConfluenceDataSourceConfiguration) *DataSourceConfiguration

SetConfluenceConfiguration sets the ConfluenceConfiguration field's value.

func (*DataSourceConfiguration) SetS3Configuration 

func (s *DataSourceConfiguration) SetS3Configuration(v *S3DataSourceConfiguration) *DataSourceConfiguration

SetS3Configuration sets the S3Configuration field's value.

func (*DataSourceConfiguration) SetSalesforceConfiguration added in v1.54.18 

func (s *DataSourceConfiguration) SetSalesforceConfiguration(v *SalesforceDataSourceConfiguration) *DataSourceConfiguration

SetSalesforceConfiguration sets the SalesforceConfiguration field's value.

func (*DataSourceConfiguration) SetSharePointConfiguration added in v1.54.18 

func (s *DataSourceConfiguration) SetSharePointConfiguration(v *SharePointDataSourceConfiguration) *DataSourceConfiguration

SetSharePointConfiguration sets the SharePointConfiguration field's value.

func (*DataSourceConfiguration) SetType 

func (s *DataSourceConfiguration) SetType(v string) *DataSourceConfiguration

SetType sets the Type field's value.

func (*DataSourceConfiguration) SetWebConfiguration added in v1.54.18 

func (s *DataSourceConfiguration) SetWebConfiguration(v *WebDataSourceConfiguration) *DataSourceConfiguration

SetWebConfiguration sets the WebConfiguration 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 

func (s *DataSourceSummary) SetName(v string) *DataSourceSummary

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 

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

SetActionGroupId sets the ActionGroupId field's value.

func (*DeleteAgentActionGroupInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*DeleteAgentActionGroupInput) SetAgentVersion 

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

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 

func (s DeleteAgentActionGroupInput) 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 (*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 

func (s DeleteAgentActionGroupOutput) 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 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 

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

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 

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

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 

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

SetAgentId sets the AgentId field's value.

func (*DeleteAgentVersionInput) SetAgentVersion 

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

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 

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

SetAgentId sets the AgentId field's value.

func (*DeleteAgentVersionOutput) SetAgentStatus 

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

SetAgentStatus sets the AgentStatus field's value.

func (*DeleteAgentVersionOutput) SetAgentVersion 

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

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 

func (s *DeleteDataSourceOutput) SetStatus(v string) *DeleteDataSourceOutput

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 DeleteFlowAliasInput added in v1.54.18 

type DeleteFlowAliasInput struct {

	// The unique identifier of the alias to be deleted.
	//
	// AliasIdentifier is a required field
	AliasIdentifier *string `location:"uri" locationName:"aliasIdentifier" type:"string" required:"true"`

	// The unique identifier of the flow that the alias belongs to.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowAliasInput) GoString added in v1.54.18 

func (s DeleteFlowAliasInput) 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 (*DeleteFlowAliasInput) SetAliasIdentifier added in v1.54.18 

func (s *DeleteFlowAliasInput) SetAliasIdentifier(v string) *DeleteFlowAliasInput

SetAliasIdentifier sets the AliasIdentifier field's value.

func (*DeleteFlowAliasInput) SetFlowIdentifier added in v1.54.18 

func (s *DeleteFlowAliasInput) SetFlowIdentifier(v string) *DeleteFlowAliasInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (DeleteFlowAliasInput) String added in v1.54.18 

func (s DeleteFlowAliasInput) 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 (*DeleteFlowAliasInput) Validate added in v1.54.18 

func (s *DeleteFlowAliasInput) Validate() error

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

type DeleteFlowAliasOutput added in v1.54.18 

type DeleteFlowAliasOutput struct {

	// The unique identifier of the flow that the alias belongs to.
	//
	// FlowId is a required field
	FlowId *string `locationName:"flowId" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowAliasOutput) GoString added in v1.54.18 

func (s DeleteFlowAliasOutput) 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 (*DeleteFlowAliasOutput) SetFlowId added in v1.54.18 

func (s *DeleteFlowAliasOutput) SetFlowId(v string) *DeleteFlowAliasOutput

SetFlowId sets the FlowId field's value.

func (*DeleteFlowAliasOutput) SetId added in v1.54.18 

func (s *DeleteFlowAliasOutput) SetId(v string) *DeleteFlowAliasOutput

SetId sets the Id field's value.

func (DeleteFlowAliasOutput) String added in v1.54.18 

func (s DeleteFlowAliasOutput) 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 DeleteFlowInput added in v1.54.18 

type DeleteFlowInput struct {

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" 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 (DeleteFlowInput) GoString added in v1.54.18 

func (s DeleteFlowInput) 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 (*DeleteFlowInput) SetFlowIdentifier added in v1.54.18 

func (s *DeleteFlowInput) SetFlowIdentifier(v string) *DeleteFlowInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*DeleteFlowInput) SetSkipResourceInUseCheck added in v1.54.18 

func (s *DeleteFlowInput) SetSkipResourceInUseCheck(v bool) *DeleteFlowInput

SetSkipResourceInUseCheck sets the SkipResourceInUseCheck field's value.

func (DeleteFlowInput) String added in v1.54.18 

func (s DeleteFlowInput) 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 (*DeleteFlowInput) Validate added in v1.54.18 

func (s *DeleteFlowInput) Validate() error

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

type DeleteFlowOutput added in v1.54.18 

type DeleteFlowOutput struct {

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowOutput) GoString added in v1.54.18 

func (s DeleteFlowOutput) 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 (*DeleteFlowOutput) SetId added in v1.54.18 

func (s *DeleteFlowOutput) SetId(v string) *DeleteFlowOutput

SetId sets the Id field's value.

func (DeleteFlowOutput) String added in v1.54.18 

func (s DeleteFlowOutput) 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 DeleteFlowVersionInput added in v1.54.18 

type DeleteFlowVersionInput struct {

	// The unique identifier of the flow whose version that you want to delete
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`

	// The version of the flow that you want to delete.
	//
	// FlowVersion is a required field
	FlowVersion *string `location:"uri" locationName:"flowVersion" 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 (DeleteFlowVersionInput) GoString added in v1.54.18 

func (s DeleteFlowVersionInput) 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 (*DeleteFlowVersionInput) SetFlowIdentifier added in v1.54.18 

func (s *DeleteFlowVersionInput) SetFlowIdentifier(v string) *DeleteFlowVersionInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*DeleteFlowVersionInput) SetFlowVersion added in v1.54.18 

func (s *DeleteFlowVersionInput) SetFlowVersion(v string) *DeleteFlowVersionInput

SetFlowVersion sets the FlowVersion field's value.

func (*DeleteFlowVersionInput) SetSkipResourceInUseCheck added in v1.54.18 

func (s *DeleteFlowVersionInput) SetSkipResourceInUseCheck(v bool) *DeleteFlowVersionInput

SetSkipResourceInUseCheck sets the SkipResourceInUseCheck field's value.

func (DeleteFlowVersionInput) String added in v1.54.18 

func (s DeleteFlowVersionInput) 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 (*DeleteFlowVersionInput) Validate added in v1.54.18 

func (s *DeleteFlowVersionInput) Validate() error

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

type DeleteFlowVersionOutput added in v1.54.18 

type DeleteFlowVersionOutput struct {

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The version of the flow being deleted.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFlowVersionOutput) GoString added in v1.54.18 

func (s DeleteFlowVersionOutput) 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 (*DeleteFlowVersionOutput) SetId added in v1.54.18 

func (s *DeleteFlowVersionOutput) SetId(v string) *DeleteFlowVersionOutput

SetId sets the Id field's value.

func (*DeleteFlowVersionOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (DeleteFlowVersionOutput) String added in v1.54.18 

func (s DeleteFlowVersionOutput) 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 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*DeleteKnowledgeBaseOutput) SetStatus 

func (s *DeleteKnowledgeBaseOutput) SetStatus(v string) *DeleteKnowledgeBaseOutput

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 DeletePromptInput added in v1.54.18 

type DeletePromptInput struct {

	// The unique identifier of the prompt.
	//
	// PromptIdentifier is a required field
	PromptIdentifier *string `location:"uri" locationName:"promptIdentifier" type:"string" required:"true"`

	// The version of the prompt to delete.
	PromptVersion *string `location:"querystring" locationName:"promptVersion" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePromptInput) GoString added in v1.54.18 

func (s DeletePromptInput) 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 (*DeletePromptInput) SetPromptIdentifier added in v1.54.18 

func (s *DeletePromptInput) SetPromptIdentifier(v string) *DeletePromptInput

SetPromptIdentifier sets the PromptIdentifier field's value.

func (*DeletePromptInput) SetPromptVersion added in v1.54.18 

func (s *DeletePromptInput) SetPromptVersion(v string) *DeletePromptInput

SetPromptVersion sets the PromptVersion field's value.

func (DeletePromptInput) String added in v1.54.18 

func (s DeletePromptInput) 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 (*DeletePromptInput) Validate added in v1.54.18 

func (s *DeletePromptInput) Validate() error

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

type DeletePromptOutput added in v1.54.18 

type DeletePromptOutput struct {

	// The unique identifier of the prompt that was deleted.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The version of the prompt that was deleted.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePromptOutput) GoString added in v1.54.18 

func (s DeletePromptOutput) 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 (*DeletePromptOutput) SetId added in v1.54.18 

func (s *DeletePromptOutput) SetId(v string) *DeletePromptOutput

SetId sets the Id field's value.

func (*DeletePromptOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (DeletePromptOutput) String added in v1.54.18 

func (s DeletePromptOutput) 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 

func (s DisassociateAgentKnowledgeBaseInput) 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 (*DisassociateAgentKnowledgeBaseInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*DisassociateAgentKnowledgeBaseInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*DisassociateAgentKnowledgeBaseInput) SetKnowledgeBaseId 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (DisassociateAgentKnowledgeBaseInput) String 

func (s DisassociateAgentKnowledgeBaseInput) 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 (*DisassociateAgentKnowledgeBaseInput) Validate 

func (s *DisassociateAgentKnowledgeBaseInput) Validate() error

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 

func (s DisassociateAgentKnowledgeBaseOutput) 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 (DisassociateAgentKnowledgeBaseOutput) String 

func (s DisassociateAgentKnowledgeBaseOutput) 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 EmbeddingModelConfiguration added in v1.53.13 

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 added in v1.53.13 

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 added in v1.53.13 

func (s *EmbeddingModelConfiguration) SetBedrockEmbeddingModelConfiguration(v *BedrockEmbeddingModelConfiguration) *EmbeddingModelConfiguration

SetBedrockEmbeddingModelConfiguration sets the BedrockEmbeddingModelConfiguration field's value.

func (EmbeddingModelConfiguration) String added in v1.53.13 

func (s EmbeddingModelConfiguration) 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 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 

func (s FixedSizeChunkingConfiguration) 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 (*FixedSizeChunkingConfiguration) SetMaxTokens 

func (s *FixedSizeChunkingConfiguration) SetMaxTokens(v int64) *FixedSizeChunkingConfiguration

SetMaxTokens sets the MaxTokens field's value.

func (*FixedSizeChunkingConfiguration) SetOverlapPercentage 

func (s *FixedSizeChunkingConfiguration) SetOverlapPercentage(v int64) *FixedSizeChunkingConfiguration

SetOverlapPercentage sets the OverlapPercentage field's value.

func (FixedSizeChunkingConfiguration) String 

func (s FixedSizeChunkingConfiguration) 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 (*FixedSizeChunkingConfiguration) Validate 

func (s *FixedSizeChunkingConfiguration) Validate() error

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

type FlowAliasRoutingConfigurationListItem added in v1.54.18 

type FlowAliasRoutingConfigurationListItem struct {

	// The version that the alias maps to.
	FlowVersion *string `locationName:"flowVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a version that the alias maps to.

func (FlowAliasRoutingConfigurationListItem) GoString added in v1.54.18 

func (s FlowAliasRoutingConfigurationListItem) 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 (*FlowAliasRoutingConfigurationListItem) SetFlowVersion added in v1.54.18 

func (s *FlowAliasRoutingConfigurationListItem) SetFlowVersion(v string) *FlowAliasRoutingConfigurationListItem

SetFlowVersion sets the FlowVersion field's value.

func (FlowAliasRoutingConfigurationListItem) String added in v1.54.18 

func (s FlowAliasRoutingConfigurationListItem) 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 (*FlowAliasRoutingConfigurationListItem) Validate added in v1.54.18 

func (s *FlowAliasRoutingConfigurationListItem) Validate() error

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

type FlowAliasSummary added in v1.54.18 

type FlowAliasSummary struct {

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

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

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

	// The unique identifier of the flow.
	//
	// FlowId is a required field
	FlowId *string `locationName:"flowId" type:"string" required:"true"`

	// The unique identifier of the alias of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

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

	// A list of configurations about the versions that the alias maps to. Currently,
	// you can only specify one.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" 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 information about an alias of a flow.

This data type is used in the following API operations:

func (FlowAliasSummary) GoString added in v1.54.18 

func (s FlowAliasSummary) 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 (*FlowAliasSummary) SetArn added in v1.54.18 

func (s *FlowAliasSummary) SetArn(v string) *FlowAliasSummary

SetArn sets the Arn field's value.

func (*FlowAliasSummary) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*FlowAliasSummary) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*FlowAliasSummary) SetFlowId added in v1.54.18 

func (s *FlowAliasSummary) SetFlowId(v string) *FlowAliasSummary

SetFlowId sets the FlowId field's value.

func (*FlowAliasSummary) SetId added in v1.54.18 

func (s *FlowAliasSummary) SetId(v string) *FlowAliasSummary

SetId sets the Id field's value.

func (*FlowAliasSummary) SetName added in v1.54.18 

func (s *FlowAliasSummary) SetName(v string) *FlowAliasSummary

SetName sets the Name field's value.

func (*FlowAliasSummary) SetRoutingConfiguration added in v1.54.18 

func (s *FlowAliasSummary) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *FlowAliasSummary

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*FlowAliasSummary) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (FlowAliasSummary) String added in v1.54.18 

func (s FlowAliasSummary) 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 FlowCondition added in v1.54.18 

type FlowCondition struct {

	// Defines the condition. You must refer to at least one of the inputs in the
	// condition. For more information, expand the Condition node section in Node
	// types in prompt flows (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes).
	//
	// Expression is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FlowCondition's
	// String and GoString methods.
	Expression *string `locationName:"expression" min:"1" type:"string" sensitive:"true"`

	// A name for the condition that you can reference.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Defines a condition in the condition node.

func (FlowCondition) GoString added in v1.54.18 

func (s FlowCondition) 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 (*FlowCondition) SetExpression added in v1.54.18 

func (s *FlowCondition) SetExpression(v string) *FlowCondition

SetExpression sets the Expression field's value.

func (*FlowCondition) SetName added in v1.54.18 

func (s *FlowCondition) SetName(v string) *FlowCondition

SetName sets the Name field's value.

func (FlowCondition) String added in v1.54.18 

func (s FlowCondition) 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 (*FlowCondition) Validate added in v1.54.18 

func (s *FlowCondition) Validate() error

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

type FlowConditionalConnectionConfiguration added in v1.54.18 

type FlowConditionalConnectionConfiguration struct {

	// The condition that triggers this connection. For more information about how
	// to write conditions, see the Condition node type in the Node types (https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html)
	// topic in the Amazon Bedrock User Guide.
	//
	// Condition is a required field
	Condition *string `locationName:"condition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration of a connection between a condition node and another node.

func (FlowConditionalConnectionConfiguration) GoString added in v1.54.18 

func (s FlowConditionalConnectionConfiguration) 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 (*FlowConditionalConnectionConfiguration) SetCondition added in v1.54.18 

func (s *FlowConditionalConnectionConfiguration) SetCondition(v string) *FlowConditionalConnectionConfiguration

SetCondition sets the Condition field's value.

func (FlowConditionalConnectionConfiguration) String added in v1.54.18 

func (s FlowConditionalConnectionConfiguration) 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 (*FlowConditionalConnectionConfiguration) Validate added in v1.54.18 

func (s *FlowConditionalConnectionConfiguration) Validate() error

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

type FlowConnection added in v1.54.18 

type FlowConnection struct {

	// The configuration of the connection.
	Configuration *FlowConnectionConfiguration `locationName:"configuration" type:"structure"`

	// A name for the connection that you can reference.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The node that the connection starts at.
	//
	// Source is a required field
	Source *string `locationName:"source" type:"string" required:"true"`

	// The node that the connection ends at.
	//
	// Target is a required field
	Target *string `locationName:"target" type:"string" required:"true"`

	// Whether the source node that the connection begins from is a condition node
	// (Conditional) or not (Data).
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"FlowConnectionType"`
	// contains filtered or unexported fields
}

Contains information about a connection between two nodes in the flow.

func (FlowConnection) GoString added in v1.54.18 

func (s FlowConnection) 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 (*FlowConnection) SetConfiguration added in v1.54.18 

func (s *FlowConnection) SetConfiguration(v *FlowConnectionConfiguration) *FlowConnection

SetConfiguration sets the Configuration field's value.

func (*FlowConnection) SetName added in v1.54.18 

func (s *FlowConnection) SetName(v string) *FlowConnection

SetName sets the Name field's value.

func (*FlowConnection) SetSource added in v1.54.18 

func (s *FlowConnection) SetSource(v string) *FlowConnection

SetSource sets the Source field's value.

func (*FlowConnection) SetTarget added in v1.54.18 

func (s *FlowConnection) SetTarget(v string) *FlowConnection

SetTarget sets the Target field's value.

func (*FlowConnection) SetType added in v1.54.18 

func (s *FlowConnection) SetType(v string) *FlowConnection

SetType sets the Type field's value.

func (FlowConnection) String added in v1.54.18 

func (s FlowConnection) 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 (*FlowConnection) Validate added in v1.54.18 

func (s *FlowConnection) Validate() error

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

type FlowConnectionConfiguration added in v1.54.18 

type FlowConnectionConfiguration struct {

	// The configuration of a connection originating from a Condition node.
	Conditional *FlowConditionalConnectionConfiguration `locationName:"conditional" type:"structure"`

	// The configuration of a connection originating from a node that isn't a Condition
	// node.
	Data *FlowDataConnectionConfiguration `locationName:"data" type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the connection.

func (FlowConnectionConfiguration) GoString added in v1.54.18 

func (s FlowConnectionConfiguration) 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 (*FlowConnectionConfiguration) SetConditional added in v1.54.18 

func (s *FlowConnectionConfiguration) SetConditional(v *FlowConditionalConnectionConfiguration) *FlowConnectionConfiguration

SetConditional sets the Conditional field's value.

func (*FlowConnectionConfiguration) SetData added in v1.54.18 

func (s *FlowConnectionConfiguration) SetData(v *FlowDataConnectionConfiguration) *FlowConnectionConfiguration

SetData sets the Data field's value.

func (FlowConnectionConfiguration) String added in v1.54.18 

func (s FlowConnectionConfiguration) 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 (*FlowConnectionConfiguration) Validate added in v1.54.18 

func (s *FlowConnectionConfiguration) Validate() error

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

type FlowDataConnectionConfiguration added in v1.54.18 

type FlowDataConnectionConfiguration struct {

	// The name of the output in the source node that the connection begins from.
	//
	// SourceOutput is a required field
	SourceOutput *string `locationName:"sourceOutput" type:"string" required:"true"`

	// The name of the input in the target node that the connection ends at.
	//
	// TargetInput is a required field
	TargetInput *string `locationName:"targetInput" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The configuration of a connection originating from a node that isn't a Condition node.

func (FlowDataConnectionConfiguration) GoString added in v1.54.18 

func (s FlowDataConnectionConfiguration) 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 (*FlowDataConnectionConfiguration) SetSourceOutput added in v1.54.18 

func (s *FlowDataConnectionConfiguration) SetSourceOutput(v string) *FlowDataConnectionConfiguration

SetSourceOutput sets the SourceOutput field's value.

func (*FlowDataConnectionConfiguration) SetTargetInput added in v1.54.18 

func (s *FlowDataConnectionConfiguration) SetTargetInput(v string) *FlowDataConnectionConfiguration

SetTargetInput sets the TargetInput field's value.

func (FlowDataConnectionConfiguration) String added in v1.54.18 

func (s FlowDataConnectionConfiguration) 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 (*FlowDataConnectionConfiguration) Validate added in v1.54.18 

func (s *FlowDataConnectionConfiguration) Validate() error

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

type FlowDefinition added in v1.54.18 

type FlowDefinition struct {

	// An array of connection definitions in the flow.
	Connections []*FlowConnection `locationName:"connections" type:"list"`

	// An array of node definitions in the flow.
	//
	// Nodes is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FlowDefinition's
	// String and GoString methods.
	Nodes []*FlowNode `locationName:"nodes" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

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

func (FlowDefinition) GoString added in v1.54.18 

func (s FlowDefinition) 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 (*FlowDefinition) SetConnections added in v1.54.18 

func (s *FlowDefinition) SetConnections(v []*FlowConnection) *FlowDefinition

SetConnections sets the Connections field's value.

func (*FlowDefinition) SetNodes added in v1.54.18 

func (s *FlowDefinition) SetNodes(v []*FlowNode) *FlowDefinition

SetNodes sets the Nodes field's value.

func (FlowDefinition) String added in v1.54.18 

func (s FlowDefinition) 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 (*FlowDefinition) Validate added in v1.54.18 

func (s *FlowDefinition) Validate() error

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

type FlowNode added in v1.54.18 

type FlowNode struct {

	// Contains configurations for the node.
	Configuration *FlowNodeConfiguration `locationName:"configuration" type:"structure"`

	// An array of objects, each of which contains information about an input into
	// the node.
	Inputs []*FlowNodeInput_ `locationName:"inputs" type:"list"`

	// A name for the node.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// A list of objects, each of which contains information about an output from
	// the node.
	Outputs []*FlowNodeOutput_ `locationName:"outputs" type:"list"`

	// The type of node. This value must match the name of the key that you provide
	// in the configuration you provide in the FlowNodeConfiguration field.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"FlowNodeType"`
	// contains filtered or unexported fields
}

Contains configurations about a node in the flow.

func (FlowNode) GoString added in v1.54.18 

func (s FlowNode) 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 (*FlowNode) SetConfiguration added in v1.54.18 

func (s *FlowNode) SetConfiguration(v *FlowNodeConfiguration) *FlowNode

SetConfiguration sets the Configuration field's value.

func (*FlowNode) SetInputs added in v1.54.18 

func (s *FlowNode) SetInputs(v []*FlowNodeInput_) *FlowNode

SetInputs sets the Inputs field's value.

func (*FlowNode) SetName added in v1.54.18 

func (s *FlowNode) SetName(v string) *FlowNode

SetName sets the Name field's value.

func (*FlowNode) SetOutputs added in v1.54.18 

func (s *FlowNode) SetOutputs(v []*FlowNodeOutput_) *FlowNode

SetOutputs sets the Outputs field's value.

func (*FlowNode) SetType added in v1.54.18 

func (s *FlowNode) SetType(v string) *FlowNode

SetType sets the Type field's value.

func (FlowNode) String added in v1.54.18 

func (s FlowNode) 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 (*FlowNode) Validate added in v1.54.18 

func (s *FlowNode) Validate() error

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

type FlowNodeConfiguration added in v1.54.18 

type FlowNodeConfiguration struct {

	// Contains configurations for an agent node in your flow. Invokes an alias
	// of an agent and returns the response.
	Agent *AgentFlowNodeConfiguration `locationName:"agent" type:"structure"`

	// Contains configurations for a collector node in your flow. Collects an iteration
	// of inputs and consolidates them into an array of outputs.
	Collector *CollectorFlowNodeConfiguration `locationName:"collector" type:"structure"`

	// Contains configurations for a Condition node in your flow. Defines conditions
	// that lead to different branches of the flow.
	Condition *ConditionFlowNodeConfiguration `locationName:"condition" type:"structure"`

	// Contains configurations for an input flow node in your flow. The first node
	// in the flow. inputs can't be specified for this node.
	Input *InputFlowNodeConfiguration `locationName:"input" type:"structure"`

	// Contains configurations for an iterator node in your flow. Takes an input
	// that is an array and iteratively sends each item of the array as an output
	// to the following node. The size of the array is also returned in the output.
	//
	// The output flow node at the end of the flow iteration will return a response
	// for each member of the array. To return only one response, you can include
	// a collector node downstream from the iterator node.
	Iterator *IteratorFlowNodeConfiguration `locationName:"iterator" type:"structure"`

	// Contains configurations for a knowledge base node in your flow. Queries a
	// knowledge base and returns the retrieved results or generated response.
	KnowledgeBase *KnowledgeBaseFlowNodeConfiguration `locationName:"knowledgeBase" type:"structure"`

	// Contains configurations for a Lambda function node in your flow. Invokes
	// an Lambda function.
	LambdaFunction *LambdaFunctionFlowNodeConfiguration `locationName:"lambdaFunction" type:"structure"`

	// Contains configurations for a Lex node in your flow. Invokes an Amazon Lex
	// bot to identify the intent of the input and return the intent as the output.
	Lex *LexFlowNodeConfiguration `locationName:"lex" type:"structure"`

	// Contains configurations for an output flow node in your flow. The last node
	// in the flow. outputs can't be specified for this node.
	Output *OutputFlowNodeConfiguration `locationName:"output" type:"structure"`

	// Contains configurations for a prompt node in your flow. Runs a prompt and
	// generates the model response as the output. You can use a prompt from Prompt
	// management or you can configure one in this node.
	Prompt *PromptFlowNodeConfiguration `locationName:"prompt" type:"structure"`

	// Contains configurations for a Retrieval node in your flow. Retrieves data
	// from an Amazon S3 location and returns it as the output.
	Retrieval *RetrievalFlowNodeConfiguration `locationName:"retrieval" type:"structure"`

	// Contains configurations for a Storage node in your flow. Stores an input
	// in an Amazon S3 location.
	Storage *StorageFlowNodeConfiguration `locationName:"storage" type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations for a node in your flow. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (FlowNodeConfiguration) GoString added in v1.54.18 

func (s FlowNodeConfiguration) 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 (*FlowNodeConfiguration) SetAgent added in v1.54.18 

func (s *FlowNodeConfiguration) SetAgent(v *AgentFlowNodeConfiguration) *FlowNodeConfiguration

SetAgent sets the Agent field's value.

func (*FlowNodeConfiguration) SetCollector added in v1.54.18 

func (s *FlowNodeConfiguration) SetCollector(v *CollectorFlowNodeConfiguration) *FlowNodeConfiguration

SetCollector sets the Collector field's value.

func (*FlowNodeConfiguration) SetCondition added in v1.54.18 

func (s *FlowNodeConfiguration) SetCondition(v *ConditionFlowNodeConfiguration) *FlowNodeConfiguration

SetCondition sets the Condition field's value.

func (*FlowNodeConfiguration) SetInput added in v1.54.18 

func (s *FlowNodeConfiguration) SetInput(v *InputFlowNodeConfiguration) *FlowNodeConfiguration

SetInput sets the Input field's value.

func (*FlowNodeConfiguration) SetIterator added in v1.54.18 

func (s *FlowNodeConfiguration) SetIterator(v *IteratorFlowNodeConfiguration) *FlowNodeConfiguration

SetIterator sets the Iterator field's value.

func (*FlowNodeConfiguration) SetKnowledgeBase added in v1.54.18 

func (s *FlowNodeConfiguration) SetKnowledgeBase(v *KnowledgeBaseFlowNodeConfiguration) *FlowNodeConfiguration

SetKnowledgeBase sets the KnowledgeBase field's value.

func (*FlowNodeConfiguration) SetLambdaFunction added in v1.54.18 

func (s *FlowNodeConfiguration) SetLambdaFunction(v *LambdaFunctionFlowNodeConfiguration) *FlowNodeConfiguration

SetLambdaFunction sets the LambdaFunction field's value.

func (*FlowNodeConfiguration) SetLex added in v1.54.18 

func (s *FlowNodeConfiguration) SetLex(v *LexFlowNodeConfiguration) *FlowNodeConfiguration

SetLex sets the Lex field's value.

func (*FlowNodeConfiguration) SetOutput added in v1.54.18 

func (s *FlowNodeConfiguration) SetOutput(v *OutputFlowNodeConfiguration) *FlowNodeConfiguration

SetOutput sets the Output field's value.

func (*FlowNodeConfiguration) SetPrompt added in v1.54.18 

func (s *FlowNodeConfiguration) SetPrompt(v *PromptFlowNodeConfiguration) *FlowNodeConfiguration

SetPrompt sets the Prompt field's value.

func (*FlowNodeConfiguration) SetRetrieval added in v1.54.18 

func (s *FlowNodeConfiguration) SetRetrieval(v *RetrievalFlowNodeConfiguration) *FlowNodeConfiguration

SetRetrieval sets the Retrieval field's value.

func (*FlowNodeConfiguration) SetStorage added in v1.54.18 

func (s *FlowNodeConfiguration) SetStorage(v *StorageFlowNodeConfiguration) *FlowNodeConfiguration

SetStorage sets the Storage field's value.

func (FlowNodeConfiguration) String added in v1.54.18 

func (s FlowNodeConfiguration) 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 (*FlowNodeConfiguration) Validate added in v1.54.18 

func (s *FlowNodeConfiguration) Validate() error

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

type FlowNodeInput_ added in v1.54.18 

type FlowNodeInput_ struct {

	// An expression that formats the input for the node. For an explanation of
	// how to create expressions, see Expressions in Prompt flows in Amazon Bedrock
	// (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html).
	//
	// Expression is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by FlowNodeInput_'s
	// String and GoString methods.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" min:"1" type:"string" required:"true" sensitive:"true"`

	// A name for the input that you can reference.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The data type of the input. If the input doesn't match this type at runtime,
	// a validation error will be thrown.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"FlowNodeIODataType"`
	// contains filtered or unexported fields
}

Contains configurations for an input to a node.

func (FlowNodeInput_) GoString added in v1.54.18 

func (s FlowNodeInput_) 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 (*FlowNodeInput_) SetExpression added in v1.54.18 

func (s *FlowNodeInput_) SetExpression(v string) *FlowNodeInput_

SetExpression sets the Expression field's value.

func (*FlowNodeInput_) SetName added in v1.54.18 

func (s *FlowNodeInput_) SetName(v string) *FlowNodeInput_

SetName sets the Name field's value.

func (*FlowNodeInput_) SetType added in v1.54.18 

func (s *FlowNodeInput_) SetType(v string) *FlowNodeInput_

SetType sets the Type field's value.

func (FlowNodeInput_) String added in v1.54.18 

func (s FlowNodeInput_) 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 (*FlowNodeInput_) Validate added in v1.54.18 

func (s *FlowNodeInput_) Validate() error

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

type FlowNodeOutput_ added in v1.54.18 

type FlowNodeOutput_ struct {

	// A name for the output that you can reference.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The data type of the output. If the output doesn't match this type at runtime,
	// a validation error will be thrown.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"FlowNodeIODataType"`
	// contains filtered or unexported fields
}

Contains configurations for an output from a node.

func (FlowNodeOutput_) GoString added in v1.54.18 

func (s FlowNodeOutput_) 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 (*FlowNodeOutput_) SetName added in v1.54.18 

func (s *FlowNodeOutput_) SetName(v string) *FlowNodeOutput_

SetName sets the Name field's value.

func (*FlowNodeOutput_) SetType added in v1.54.18 

func (s *FlowNodeOutput_) SetType(v string) *FlowNodeOutput_

SetType sets the Type field's value.

func (FlowNodeOutput_) String added in v1.54.18 

func (s FlowNodeOutput_) 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 (*FlowNodeOutput_) Validate added in v1.54.18 

func (s *FlowNodeOutput_) Validate() error

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

type FlowSummary added in v1.54.18 

type FlowSummary struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

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

	// A description of the flow.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow. The following statuses are possible:
	//
	//    * NotPrepared – The flow has been created or updated, but hasn't been
	//    prepared. If you just created the flow, you can't test it. If you updated
	//    the flow, the DRAFT version won't contain the latest changes for testing.
	//    Send a PrepareFlow (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html)
	//    request to package the latest changes into the DRAFT version.
	//
	//    * Preparing – The flow is being prepared so that the DRAFT version contains
	//    the latest changes for testing.
	//
	//    * Prepared – The flow is prepared and the DRAFT version contains the
	//    latest changes for testing.
	//
	//    * Failed – The last API operation that you invoked on the flow failed.
	//    Send a GetFlow (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html)
	//    request and check the error message in the validations field.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

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

	// The latest version of the flow.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the definition of a flow.

func (FlowSummary) GoString added in v1.54.18 

func (s FlowSummary) 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 (*FlowSummary) SetArn added in v1.54.18 

func (s *FlowSummary) SetArn(v string) *FlowSummary

SetArn sets the Arn field's value.

func (*FlowSummary) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*FlowSummary) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*FlowSummary) SetId added in v1.54.18 

func (s *FlowSummary) SetId(v string) *FlowSummary

SetId sets the Id field's value.

func (*FlowSummary) SetName added in v1.54.18 

func (s *FlowSummary) SetName(v string) *FlowSummary

SetName sets the Name field's value.

func (*FlowSummary) SetStatus added in v1.54.18 

func (s *FlowSummary) SetStatus(v string) *FlowSummary

SetStatus sets the Status field's value.

func (*FlowSummary) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*FlowSummary) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (FlowSummary) String added in v1.54.18 

func (s FlowSummary) 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 FlowValidation added in v1.54.18 

type FlowValidation struct {

	// A message describing the validation error.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The severity of the issue described in the message.
	//
	// Severity is a required field
	Severity *string `locationName:"severity" type:"string" required:"true" enum:"FlowValidationSeverity"`
	// contains filtered or unexported fields
}

Contains information about validation of the flow.

This data type is used in the following API operations:

func (FlowValidation) GoString added in v1.54.18 

func (s FlowValidation) 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 (*FlowValidation) SetMessage added in v1.54.18 

func (s *FlowValidation) SetMessage(v string) *FlowValidation

SetMessage sets the Message field's value.

func (*FlowValidation) SetSeverity added in v1.54.18 

func (s *FlowValidation) SetSeverity(v string) *FlowValidation

SetSeverity sets the Severity field's value.

func (FlowValidation) String added in v1.54.18 

func (s FlowValidation) 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 FlowVersionSummary added in v1.54.18 

type FlowVersionSummary struct {

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

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

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The status of the flow.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

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

Contains information about the flow version.

This data type is used in the following API operations:

func (FlowVersionSummary) GoString added in v1.54.18 

func (s FlowVersionSummary) 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 (*FlowVersionSummary) SetArn added in v1.54.18 

func (s *FlowVersionSummary) SetArn(v string) *FlowVersionSummary

SetArn sets the Arn field's value.

func (*FlowVersionSummary) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*FlowVersionSummary) SetId added in v1.54.18 

func (s *FlowVersionSummary) SetId(v string) *FlowVersionSummary

SetId sets the Id field's value.

func (*FlowVersionSummary) SetStatus added in v1.54.18 

func (s *FlowVersionSummary) SetStatus(v string) *FlowVersionSummary

SetStatus sets the Status field's value.

func (*FlowVersionSummary) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (FlowVersionSummary) String added in v1.54.18 

func (s FlowVersionSummary) 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 Function added in v1.51.26 

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 added in v1.51.26 

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 added in v1.51.26 

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

SetDescription sets the Description field's value.

func (*Function) SetName added in v1.51.26 

func (s *Function) SetName(v string) *Function

SetName sets the Name field's value.

func (*Function) SetParameters added in v1.51.26 

func (s *Function) SetParameters(v map[string]*ParameterDetail) *Function

SetParameters sets the Parameters field's value.

func (Function) String added in v1.51.26 

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 added in v1.51.26 

func (s *Function) Validate() error

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

type FunctionSchema added in v1.51.26 

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 added in v1.51.26 

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 added in v1.51.26 

func (s *FunctionSchema) SetFunctions(v []*Function) *FunctionSchema

SetFunctions sets the Functions field's value.

func (FunctionSchema) String added in v1.51.26 

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 added in v1.51.26 

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 

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

SetActionGroupId sets the ActionGroupId field's value.

func (*GetAgentActionGroupInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*GetAgentActionGroupInput) SetAgentVersion 

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

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 

func (s *GetAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) *GetAgentActionGroupOutput

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 

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

SetAgentId sets the AgentId field's value.

func (*GetAgentKnowledgeBaseInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*GetAgentKnowledgeBaseInput) SetKnowledgeBaseId 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (GetAgentKnowledgeBaseInput) String 

func (s GetAgentKnowledgeBaseInput) 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 (*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 

func (s *GetAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowledgeBase) *GetAgentKnowledgeBaseOutput

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (GetAgentKnowledgeBaseOutput) String 

func (s GetAgentKnowledgeBaseOutput) 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 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 

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

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 

func (s *GetAgentVersionOutput) SetAgentVersion(v *AgentVersion) *GetAgentVersionOutput

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 GetFlowAliasInput added in v1.54.18 

type GetFlowAliasInput struct {

	// The unique identifier of the alias for which to retrieve information.
	//
	// AliasIdentifier is a required field
	AliasIdentifier *string `location:"uri" locationName:"aliasIdentifier" type:"string" required:"true"`

	// The unique identifier of the flow that the alias belongs to.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFlowAliasInput) GoString added in v1.54.18 

func (s GetFlowAliasInput) 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 (*GetFlowAliasInput) SetAliasIdentifier added in v1.54.18 

func (s *GetFlowAliasInput) SetAliasIdentifier(v string) *GetFlowAliasInput

SetAliasIdentifier sets the AliasIdentifier field's value.

func (*GetFlowAliasInput) SetFlowIdentifier added in v1.54.18 

func (s *GetFlowAliasInput) SetFlowIdentifier(v string) *GetFlowAliasInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (GetFlowAliasInput) String added in v1.54.18 

func (s GetFlowAliasInput) 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 (*GetFlowAliasInput) Validate added in v1.54.18 

func (s *GetFlowAliasInput) Validate() error

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

type GetFlowAliasOutput added in v1.54.18 

type GetFlowAliasOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

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

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

	// The unique identifier of the flow that the alias belongs to.
	//
	// FlowId is a required field
	FlowId *string `locationName:"flowId" type:"string" required:"true"`

	// The unique identifier of the alias of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

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

	// Contains information about the version that the alias is mapped to.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`

	// The time at which the flow 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
}

func (GetFlowAliasOutput) GoString added in v1.54.18 

func (s GetFlowAliasOutput) 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 (*GetFlowAliasOutput) SetArn added in v1.54.18 

func (s *GetFlowAliasOutput) SetArn(v string) *GetFlowAliasOutput

SetArn sets the Arn field's value.

func (*GetFlowAliasOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetFlowAliasOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*GetFlowAliasOutput) SetFlowId added in v1.54.18 

func (s *GetFlowAliasOutput) SetFlowId(v string) *GetFlowAliasOutput

SetFlowId sets the FlowId field's value.

func (*GetFlowAliasOutput) SetId added in v1.54.18 

func (s *GetFlowAliasOutput) SetId(v string) *GetFlowAliasOutput

SetId sets the Id field's value.

func (*GetFlowAliasOutput) SetName added in v1.54.18 

func (s *GetFlowAliasOutput) SetName(v string) *GetFlowAliasOutput

SetName sets the Name field's value.

func (*GetFlowAliasOutput) SetRoutingConfiguration added in v1.54.18 

func (s *GetFlowAliasOutput) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *GetFlowAliasOutput

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*GetFlowAliasOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (GetFlowAliasOutput) String added in v1.54.18 

func (s GetFlowAliasOutput) 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 GetFlowInput added in v1.54.18 

type GetFlowInput struct {

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFlowInput) GoString added in v1.54.18 

func (s GetFlowInput) 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 (*GetFlowInput) SetFlowIdentifier added in v1.54.18 

func (s *GetFlowInput) SetFlowIdentifier(v string) *GetFlowInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (GetFlowInput) String added in v1.54.18 

func (s GetFlowInput) 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 (*GetFlowInput) Validate added in v1.54.18 

func (s *GetFlowInput) Validate() error

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

type GetFlowOutput added in v1.54.18 

type GetFlowOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the flow 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 the flow is encrypted
	// with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The definition of the nodes and connections between the nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

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

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// a flow. For more information, see Create a service row for flows (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow. The following statuses are possible:
	//
	//    * NotPrepared – The flow has been created or updated, but hasn't been
	//    prepared. If you just created the flow, you can't test it. If you updated
	//    the flow, the DRAFT version won't contain the latest changes for testing.
	//    Send a PrepareFlow (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html)
	//    request to package the latest changes into the DRAFT version.
	//
	//    * Preparing – The flow is being prepared so that the DRAFT version contains
	//    the latest changes for testing.
	//
	//    * Prepared – The flow is prepared and the DRAFT version contains the
	//    latest changes for testing.
	//
	//    * Failed – The last API operation that you invoked on the flow failed.
	//    Send a GetFlow (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html)
	//    request and check the error message in the validations field.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

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

	// A list of validation error messages related to the last failed operation
	// on the flow.
	Validations []*FlowValidation `locationName:"validations" type:"list"`

	// The version of the flow for which information was retrieved.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFlowOutput) GoString added in v1.54.18 

func (s GetFlowOutput) 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 (*GetFlowOutput) SetArn added in v1.54.18 

func (s *GetFlowOutput) SetArn(v string) *GetFlowOutput

SetArn sets the Arn field's value.

func (*GetFlowOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetFlowOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*GetFlowOutput) SetDefinition added in v1.54.18 

func (s *GetFlowOutput) SetDefinition(v *FlowDefinition) *GetFlowOutput

SetDefinition sets the Definition field's value.

func (*GetFlowOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*GetFlowOutput) SetExecutionRoleArn added in v1.54.18 

func (s *GetFlowOutput) SetExecutionRoleArn(v string) *GetFlowOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*GetFlowOutput) SetId added in v1.54.18 

func (s *GetFlowOutput) SetId(v string) *GetFlowOutput

SetId sets the Id field's value.

func (*GetFlowOutput) SetName added in v1.54.18 

func (s *GetFlowOutput) SetName(v string) *GetFlowOutput

SetName sets the Name field's value.

func (*GetFlowOutput) SetStatus added in v1.54.18 

func (s *GetFlowOutput) SetStatus(v string) *GetFlowOutput

SetStatus sets the Status field's value.

func (*GetFlowOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetFlowOutput) SetValidations added in v1.54.18 

func (s *GetFlowOutput) SetValidations(v []*FlowValidation) *GetFlowOutput

SetValidations sets the Validations field's value.

func (*GetFlowOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (GetFlowOutput) String added in v1.54.18 

func (s GetFlowOutput) 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 GetFlowVersionInput added in v1.54.18 

type GetFlowVersionInput struct {

	// The unique identifier of the flow for which to get information.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`

	// The version of the flow for which to get information.
	//
	// FlowVersion is a required field
	FlowVersion *string `location:"uri" locationName:"flowVersion" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFlowVersionInput) GoString added in v1.54.18 

func (s GetFlowVersionInput) 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 (*GetFlowVersionInput) SetFlowIdentifier added in v1.54.18 

func (s *GetFlowVersionInput) SetFlowIdentifier(v string) *GetFlowVersionInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*GetFlowVersionInput) SetFlowVersion added in v1.54.18 

func (s *GetFlowVersionInput) SetFlowVersion(v string) *GetFlowVersionInput

SetFlowVersion sets the FlowVersion field's value.

func (GetFlowVersionInput) String added in v1.54.18 

func (s GetFlowVersionInput) 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 (*GetFlowVersionInput) Validate added in v1.54.18 

func (s *GetFlowVersionInput) Validate() error

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

type GetFlowVersionOutput added in v1.54.18 

type GetFlowVersionOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the flow 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 the version of the flow
	// is encrypted with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The definition of the nodes and connections between nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

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

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// a flow. For more information, see Create a service role for flows in Amazon
	// Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow version.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

	// The version of the flow for which information was retrieved.
	//
	// Version is a required field
	Version *string `locationName:"version" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFlowVersionOutput) GoString added in v1.54.18 

func (s GetFlowVersionOutput) 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 (*GetFlowVersionOutput) SetArn added in v1.54.18 

func (s *GetFlowVersionOutput) SetArn(v string) *GetFlowVersionOutput

SetArn sets the Arn field's value.

func (*GetFlowVersionOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetFlowVersionOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*GetFlowVersionOutput) SetDefinition added in v1.54.18 

func (s *GetFlowVersionOutput) SetDefinition(v *FlowDefinition) *GetFlowVersionOutput

SetDefinition sets the Definition field's value.

func (*GetFlowVersionOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*GetFlowVersionOutput) SetExecutionRoleArn added in v1.54.18 

func (s *GetFlowVersionOutput) SetExecutionRoleArn(v string) *GetFlowVersionOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*GetFlowVersionOutput) SetId added in v1.54.18 

func (s *GetFlowVersionOutput) SetId(v string) *GetFlowVersionOutput

SetId sets the Id field's value.

func (*GetFlowVersionOutput) SetName added in v1.54.18 

func (s *GetFlowVersionOutput) SetName(v string) *GetFlowVersionOutput

SetName sets the Name field's value.

func (*GetFlowVersionOutput) SetStatus added in v1.54.18 

func (s *GetFlowVersionOutput) SetStatus(v string) *GetFlowVersionOutput

SetStatus sets the Status field's value.

func (*GetFlowVersionOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (GetFlowVersionOutput) String added in v1.54.18 

func (s GetFlowVersionOutput) 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 

func (s *GetIngestionJobOutput) SetIngestionJob(v *IngestionJob) *GetIngestionJobOutput

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 

func (s *GetKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *GetKnowledgeBaseOutput

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 GetPromptInput added in v1.54.18 

type GetPromptInput struct {

	// The unique identifier of the prompt.
	//
	// PromptIdentifier is a required field
	PromptIdentifier *string `location:"uri" locationName:"promptIdentifier" type:"string" required:"true"`

	// The version of the prompt about which you want to retrieve information.
	PromptVersion *string `location:"querystring" locationName:"promptVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetPromptInput) GoString added in v1.54.18 

func (s GetPromptInput) 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 (*GetPromptInput) SetPromptIdentifier added in v1.54.18 

func (s *GetPromptInput) SetPromptIdentifier(v string) *GetPromptInput

SetPromptIdentifier sets the PromptIdentifier field's value.

func (*GetPromptInput) SetPromptVersion added in v1.54.18 

func (s *GetPromptInput) SetPromptVersion(v string) *GetPromptInput

SetPromptVersion sets the PromptVersion field's value.

func (GetPromptInput) String added in v1.54.18 

func (s GetPromptInput) 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 (*GetPromptInput) Validate added in v1.54.18 

func (s *GetPromptInput) Validate() error

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

type GetPromptOutput added in v1.54.18 

type GetPromptOutput struct {

	// The Amazon Resource Name (ARN) of the prompt.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the prompt 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 the prompt is encrypted
	// with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The name of the default variant for the prompt. This value must match the
	// name field in the relevant PromptVariant (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html)
	// object.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

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

	// The unique identifier of the prompt.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

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

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetPromptOutput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`

	// The version of the prompt.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetPromptOutput) GoString added in v1.54.18 

func (s GetPromptOutput) 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 (*GetPromptOutput) SetArn added in v1.54.18 

func (s *GetPromptOutput) SetArn(v string) *GetPromptOutput

SetArn sets the Arn field's value.

func (*GetPromptOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetPromptOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*GetPromptOutput) SetDefaultVariant added in v1.54.18 

func (s *GetPromptOutput) SetDefaultVariant(v string) *GetPromptOutput

SetDefaultVariant sets the DefaultVariant field's value.

func (*GetPromptOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*GetPromptOutput) SetId added in v1.54.18 

func (s *GetPromptOutput) SetId(v string) *GetPromptOutput

SetId sets the Id field's value.

func (*GetPromptOutput) SetName added in v1.54.18 

func (s *GetPromptOutput) SetName(v string) *GetPromptOutput

SetName sets the Name field's value.

func (*GetPromptOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetPromptOutput) SetVariants added in v1.54.18 

func (s *GetPromptOutput) SetVariants(v []*PromptVariant) *GetPromptOutput

SetVariants sets the Variants field's value.

func (*GetPromptOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (GetPromptOutput) String added in v1.54.18 

func (s GetPromptOutput) 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 added in v1.53.6 

type GuardrailConfiguration struct {

	// The unique identifier of the guardrail.
	GuardrailIdentifier *string `locationName:"guardrailIdentifier" type:"string"`

	// The version of the guardrail.
	GuardrailVersion *string `locationName:"guardrailVersion" type:"string"`
	// contains filtered or unexported fields
}

Details about the guardrail associated with an agent.

func (GuardrailConfiguration) GoString added in v1.53.6 

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 added in v1.53.6 

func (s *GuardrailConfiguration) SetGuardrailIdentifier(v string) *GuardrailConfiguration

SetGuardrailIdentifier sets the GuardrailIdentifier field's value.

func (*GuardrailConfiguration) SetGuardrailVersion added in v1.53.6 

func (s *GuardrailConfiguration) SetGuardrailVersion(v string) *GuardrailConfiguration

SetGuardrailVersion sets the GuardrailVersion field's value.

func (GuardrailConfiguration) String added in v1.53.6 

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 HierarchicalChunkingConfiguration added in v1.54.18 

type HierarchicalChunkingConfiguration struct {

	// Token settings for each layer.
	//
	// LevelConfigurations is a required field
	LevelConfigurations []*HierarchicalChunkingLevelConfiguration `locationName:"levelConfigurations" min:"2" type:"list" required:"true"`

	// The number of tokens to repeat across chunks in the same layer.
	//
	// OverlapTokens is a required field
	OverlapTokens *int64 `locationName:"overlapTokens" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.

func (HierarchicalChunkingConfiguration) GoString added in v1.54.18 

func (s HierarchicalChunkingConfiguration) 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 (*HierarchicalChunkingConfiguration) SetLevelConfigurations added in v1.54.18 

func (s *HierarchicalChunkingConfiguration) SetLevelConfigurations(v []*HierarchicalChunkingLevelConfiguration) *HierarchicalChunkingConfiguration

SetLevelConfigurations sets the LevelConfigurations field's value.

func (*HierarchicalChunkingConfiguration) SetOverlapTokens added in v1.54.18 

func (s *HierarchicalChunkingConfiguration) SetOverlapTokens(v int64) *HierarchicalChunkingConfiguration

SetOverlapTokens sets the OverlapTokens field's value.

func (HierarchicalChunkingConfiguration) String added in v1.54.18 

func (s HierarchicalChunkingConfiguration) 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 (*HierarchicalChunkingConfiguration) Validate added in v1.54.18 

func (s *HierarchicalChunkingConfiguration) Validate() error

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

type HierarchicalChunkingLevelConfiguration added in v1.54.18 

type HierarchicalChunkingLevelConfiguration struct {

	// The maximum number of tokens that a chunk can contain in this layer.
	//
	// MaxTokens is a required field
	MaxTokens *int64 `locationName:"maxTokens" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Token settings for a layer in a hierarchical chunking configuration.

func (HierarchicalChunkingLevelConfiguration) GoString added in v1.54.18 

func (s HierarchicalChunkingLevelConfiguration) 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 (*HierarchicalChunkingLevelConfiguration) SetMaxTokens added in v1.54.18 

func (s *HierarchicalChunkingLevelConfiguration) SetMaxTokens(v int64) *HierarchicalChunkingLevelConfiguration

SetMaxTokens sets the MaxTokens field's value.

func (HierarchicalChunkingLevelConfiguration) String added in v1.54.18 

func (s HierarchicalChunkingLevelConfiguration) 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 (*HierarchicalChunkingLevelConfiguration) Validate added in v1.54.18 

func (s *HierarchicalChunkingLevelConfiguration) Validate() error

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

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 

func (s *InferenceConfiguration) SetTemperature(v float64) *InferenceConfiguration

SetTemperature sets the Temperature field's value.

func (*InferenceConfiguration) SetTopK 

func (s *InferenceConfiguration) SetTopK(v int64) *InferenceConfiguration

SetTopK sets the TopK field's value.

func (*InferenceConfiguration) SetTopP 

func (s *InferenceConfiguration) SetTopP(v float64) *InferenceConfiguration

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 

func (s *IngestionJobSortBy) SetOrder(v string) *IngestionJobSortBy

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 added in v1.51.9 

func (s *IngestionJobStatistics) SetNumberOfMetadataDocumentsModified(v int64) *IngestionJobStatistics

SetNumberOfMetadataDocumentsModified sets the NumberOfMetadataDocumentsModified field's value.

func (*IngestionJobStatistics) SetNumberOfMetadataDocumentsScanned added in v1.51.9 

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 

func (s *IngestionJobSummary) SetStatistics(v *IngestionJobStatistics) *IngestionJobSummary

SetStatistics sets the Statistics field's value.

func (*IngestionJobSummary) SetStatus 

func (s *IngestionJobSummary) SetStatus(v string) *IngestionJobSummary

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 InputFlowNodeConfiguration added in v1.54.18 

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

Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.

func (InputFlowNodeConfiguration) GoString added in v1.54.18 

func (s InputFlowNodeConfiguration) 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 (InputFlowNodeConfiguration) String added in v1.54.18 

func (s InputFlowNodeConfiguration) 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 IntermediateStorage added in v1.54.18 

type IntermediateStorage struct {

	// An S3 bucket path.
	//
	// S3Location is a required field
	S3Location *S3Location `locationName:"s3Location" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.

func (IntermediateStorage) GoString added in v1.54.18 

func (s IntermediateStorage) 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 (*IntermediateStorage) SetS3Location added in v1.54.18 

func (s *IntermediateStorage) SetS3Location(v *S3Location) *IntermediateStorage

SetS3Location sets the S3Location field's value.

func (IntermediateStorage) String added in v1.54.18 

func (s IntermediateStorage) 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 (*IntermediateStorage) Validate added in v1.54.18 

func (s *IntermediateStorage) Validate() error

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

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 IteratorFlowNodeConfiguration added in v1.54.18 

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

Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.

The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.

func (IteratorFlowNodeConfiguration) GoString added in v1.54.18 

func (s IteratorFlowNodeConfiguration) 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 (IteratorFlowNodeConfiguration) String added in v1.54.18 

func (s IteratorFlowNodeConfiguration) 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 

func (s *KnowledgeBaseConfiguration) SetType(v string) *KnowledgeBaseConfiguration

SetType sets the Type field's value.

func (*KnowledgeBaseConfiguration) SetVectorKnowledgeBaseConfiguration 

func (s *KnowledgeBaseConfiguration) SetVectorKnowledgeBaseConfiguration(v *VectorKnowledgeBaseConfiguration) *KnowledgeBaseConfiguration

SetVectorKnowledgeBaseConfiguration sets the VectorKnowledgeBaseConfiguration field's value.

func (KnowledgeBaseConfiguration) String 

func (s KnowledgeBaseConfiguration) 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 (*KnowledgeBaseConfiguration) Validate 

func (s *KnowledgeBaseConfiguration) Validate() error

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

type KnowledgeBaseFlowNodeConfiguration added in v1.54.18 

type KnowledgeBaseFlowNodeConfiguration struct {

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

	// The unique identifier of the model to use to generate a response from the
	// query results. Omit this field if you want to return the retrieved results
	// as an array.
	ModelId *string `locationName:"modelId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (KnowledgeBaseFlowNodeConfiguration) GoString added in v1.54.18 

func (s KnowledgeBaseFlowNodeConfiguration) 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 (*KnowledgeBaseFlowNodeConfiguration) SetKnowledgeBaseId added in v1.54.18 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*KnowledgeBaseFlowNodeConfiguration) SetModelId added in v1.54.18 

func (s *KnowledgeBaseFlowNodeConfiguration) SetModelId(v string) *KnowledgeBaseFlowNodeConfiguration

SetModelId sets the ModelId field's value.

func (KnowledgeBaseFlowNodeConfiguration) String added in v1.54.18 

func (s KnowledgeBaseFlowNodeConfiguration) 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 (*KnowledgeBaseFlowNodeConfiguration) Validate added in v1.54.18 

func (s *KnowledgeBaseFlowNodeConfiguration) 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 

func (s *KnowledgeBaseSummary) SetName(v string) *KnowledgeBaseSummary

SetName sets the Name field's value.

func (*KnowledgeBaseSummary) SetStatus 

func (s *KnowledgeBaseSummary) SetStatus(v string) *KnowledgeBaseSummary

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 LambdaFunctionFlowNodeConfiguration added in v1.54.18 

type LambdaFunctionFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the Lambda function to invoke.
	//
	// LambdaArn is a required field
	LambdaArn *string `locationName:"lambdaArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (LambdaFunctionFlowNodeConfiguration) GoString added in v1.54.18 

func (s LambdaFunctionFlowNodeConfiguration) 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 (*LambdaFunctionFlowNodeConfiguration) SetLambdaArn added in v1.54.18 

func (s *LambdaFunctionFlowNodeConfiguration) SetLambdaArn(v string) *LambdaFunctionFlowNodeConfiguration

SetLambdaArn sets the LambdaArn field's value.

func (LambdaFunctionFlowNodeConfiguration) String added in v1.54.18 

func (s LambdaFunctionFlowNodeConfiguration) 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 (*LambdaFunctionFlowNodeConfiguration) Validate added in v1.54.18 

func (s *LambdaFunctionFlowNodeConfiguration) Validate() error

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

type LexFlowNodeConfiguration added in v1.54.18 

type LexFlowNodeConfiguration struct {

	// The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
	//
	// BotAliasArn is a required field
	BotAliasArn *string `locationName:"botAliasArn" type:"string" required:"true"`

	// The Region to invoke the Amazon Lex bot in.
	//
	// LocaleId is a required field
	LocaleId *string `locationName:"localeId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (LexFlowNodeConfiguration) GoString added in v1.54.18 

func (s LexFlowNodeConfiguration) 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 (*LexFlowNodeConfiguration) SetBotAliasArn added in v1.54.18 

func (s *LexFlowNodeConfiguration) SetBotAliasArn(v string) *LexFlowNodeConfiguration

SetBotAliasArn sets the BotAliasArn field's value.

func (*LexFlowNodeConfiguration) SetLocaleId added in v1.54.18 

func (s *LexFlowNodeConfiguration) SetLocaleId(v string) *LexFlowNodeConfiguration

SetLocaleId sets the LocaleId field's value.

func (LexFlowNodeConfiguration) String added in v1.54.18 

func (s LexFlowNodeConfiguration) 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 (*LexFlowNodeConfiguration) Validate added in v1.54.18 

func (s *LexFlowNodeConfiguration) Validate() error

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

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 

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

SetAgentId sets the AgentId field's value.

func (*ListAgentActionGroupsInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*ListAgentActionGroupsInput) SetMaxResults 

func (s *ListAgentActionGroupsInput) SetMaxResults(v int64) *ListAgentActionGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgentActionGroupsInput) SetNextToken 

func (s *ListAgentActionGroupsInput) SetNextToken(v string) *ListAgentActionGroupsInput

SetNextToken sets the NextToken field's value.

func (ListAgentActionGroupsInput) String 

func (s ListAgentActionGroupsInput) 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 (*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 

func (s *ListAgentActionGroupsOutput) SetActionGroupSummaries(v []*ActionGroupSummary) *ListAgentActionGroupsOutput

SetActionGroupSummaries sets the ActionGroupSummaries field's value.

func (*ListAgentActionGroupsOutput) SetNextToken 

func (s *ListAgentActionGroupsOutput) SetNextToken(v string) *ListAgentActionGroupsOutput

SetNextToken sets the NextToken field's value.

func (ListAgentActionGroupsOutput) String 

func (s ListAgentActionGroupsOutput) 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 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 

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

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 

func (s *ListAgentAliasesInput) SetNextToken(v string) *ListAgentAliasesInput

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 

func (s *ListAgentAliasesOutput) SetNextToken(v string) *ListAgentAliasesOutput

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 

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

SetAgentId sets the AgentId field's value.

func (*ListAgentKnowledgeBasesInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*ListAgentKnowledgeBasesInput) SetMaxResults 

func (s *ListAgentKnowledgeBasesInput) SetMaxResults(v int64) *ListAgentKnowledgeBasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgentKnowledgeBasesInput) SetNextToken 

func (s *ListAgentKnowledgeBasesInput) SetNextToken(v string) *ListAgentKnowledgeBasesInput

SetNextToken sets the NextToken field's value.

func (ListAgentKnowledgeBasesInput) String 

func (s ListAgentKnowledgeBasesInput) 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 (*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 

func (s ListAgentKnowledgeBasesOutput) 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 (*ListAgentKnowledgeBasesOutput) SetAgentKnowledgeBaseSummaries 

func (s *ListAgentKnowledgeBasesOutput) SetAgentKnowledgeBaseSummaries(v []*AgentKnowledgeBaseSummary) *ListAgentKnowledgeBasesOutput

SetAgentKnowledgeBaseSummaries sets the AgentKnowledgeBaseSummaries field's value.

func (*ListAgentKnowledgeBasesOutput) SetNextToken 

func (s *ListAgentKnowledgeBasesOutput) SetNextToken(v string) *ListAgentKnowledgeBasesOutput

SetNextToken sets the NextToken field's value.

func (ListAgentKnowledgeBasesOutput) String 

func (s ListAgentKnowledgeBasesOutput) 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 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 

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

SetAgentId sets the AgentId field's value.

func (*ListAgentVersionsInput) SetMaxResults 

func (s *ListAgentVersionsInput) SetMaxResults(v int64) *ListAgentVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAgentVersionsInput) SetNextToken 

func (s *ListAgentVersionsInput) SetNextToken(v string) *ListAgentVersionsInput

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 

func (s *ListAgentVersionsOutput) SetNextToken(v string) *ListAgentVersionsOutput

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 

func (s *ListDataSourcesOutput) SetNextToken(v string) *ListDataSourcesOutput

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 ListFlowAliasesInput added in v1.54.18 

type ListFlowAliasesInput struct {

	// The unique identifier of the flow for which aliases are being returned.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" 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 `location:"querystring" 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowAliasesInput) GoString added in v1.54.18 

func (s ListFlowAliasesInput) 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 (*ListFlowAliasesInput) SetFlowIdentifier added in v1.54.18 

func (s *ListFlowAliasesInput) SetFlowIdentifier(v string) *ListFlowAliasesInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*ListFlowAliasesInput) SetMaxResults added in v1.54.18 

func (s *ListFlowAliasesInput) SetMaxResults(v int64) *ListFlowAliasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlowAliasesInput) SetNextToken added in v1.54.18 

func (s *ListFlowAliasesInput) SetNextToken(v string) *ListFlowAliasesInput

SetNextToken sets the NextToken field's value.

func (ListFlowAliasesInput) String added in v1.54.18 

func (s ListFlowAliasesInput) 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 (*ListFlowAliasesInput) Validate added in v1.54.18 

func (s *ListFlowAliasesInput) Validate() error

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

type ListFlowAliasesOutput added in v1.54.18 

type ListFlowAliasesOutput struct {

	// A list, each member of which contains information about a flow alias.
	//
	// FlowAliasSummaries is a required field
	FlowAliasSummaries []*FlowAliasSummary `locationName:"flowAliasSummaries" 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 (ListFlowAliasesOutput) GoString added in v1.54.18 

func (s ListFlowAliasesOutput) 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 (*ListFlowAliasesOutput) SetFlowAliasSummaries added in v1.54.18 

func (s *ListFlowAliasesOutput) SetFlowAliasSummaries(v []*FlowAliasSummary) *ListFlowAliasesOutput

SetFlowAliasSummaries sets the FlowAliasSummaries field's value.

func (*ListFlowAliasesOutput) SetNextToken added in v1.54.18 

func (s *ListFlowAliasesOutput) SetNextToken(v string) *ListFlowAliasesOutput

SetNextToken sets the NextToken field's value.

func (ListFlowAliasesOutput) String added in v1.54.18 

func (s ListFlowAliasesOutput) 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 ListFlowVersionsInput added in v1.54.18 

type ListFlowVersionsInput struct {

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" 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 `location:"querystring" 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowVersionsInput) GoString added in v1.54.18 

func (s ListFlowVersionsInput) 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 (*ListFlowVersionsInput) SetFlowIdentifier added in v1.54.18 

func (s *ListFlowVersionsInput) SetFlowIdentifier(v string) *ListFlowVersionsInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*ListFlowVersionsInput) SetMaxResults added in v1.54.18 

func (s *ListFlowVersionsInput) SetMaxResults(v int64) *ListFlowVersionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlowVersionsInput) SetNextToken added in v1.54.18 

func (s *ListFlowVersionsInput) SetNextToken(v string) *ListFlowVersionsInput

SetNextToken sets the NextToken field's value.

func (ListFlowVersionsInput) String added in v1.54.18 

func (s ListFlowVersionsInput) 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 (*ListFlowVersionsInput) Validate added in v1.54.18 

func (s *ListFlowVersionsInput) Validate() error

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

type ListFlowVersionsOutput added in v1.54.18 

type ListFlowVersionsOutput struct {

	// A list, each member of which contains information about a flow.
	//
	// FlowVersionSummaries is a required field
	FlowVersionSummaries []*FlowVersionSummary `locationName:"flowVersionSummaries" 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 (ListFlowVersionsOutput) GoString added in v1.54.18 

func (s ListFlowVersionsOutput) 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 (*ListFlowVersionsOutput) SetFlowVersionSummaries added in v1.54.18 

func (s *ListFlowVersionsOutput) SetFlowVersionSummaries(v []*FlowVersionSummary) *ListFlowVersionsOutput

SetFlowVersionSummaries sets the FlowVersionSummaries field's value.

func (*ListFlowVersionsOutput) SetNextToken added in v1.54.18 

func (s *ListFlowVersionsOutput) SetNextToken(v string) *ListFlowVersionsOutput

SetNextToken sets the NextToken field's value.

func (ListFlowVersionsOutput) String added in v1.54.18 

func (s ListFlowVersionsOutput) 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 ListFlowsInput added in v1.54.18 

type ListFlowsInput 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 `location:"querystring" 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFlowsInput) GoString added in v1.54.18 

func (s ListFlowsInput) 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 (*ListFlowsInput) SetMaxResults added in v1.54.18 

func (s *ListFlowsInput) SetMaxResults(v int64) *ListFlowsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFlowsInput) SetNextToken added in v1.54.18 

func (s *ListFlowsInput) SetNextToken(v string) *ListFlowsInput

SetNextToken sets the NextToken field's value.

func (ListFlowsInput) String added in v1.54.18 

func (s ListFlowsInput) 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 (*ListFlowsInput) Validate added in v1.54.18 

func (s *ListFlowsInput) Validate() error

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

type ListFlowsOutput added in v1.54.18 

type ListFlowsOutput struct {

	// A list, each member of which contains information about a flow.
	//
	// FlowSummaries is a required field
	FlowSummaries []*FlowSummary `locationName:"flowSummaries" 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 (ListFlowsOutput) GoString added in v1.54.18 

func (s ListFlowsOutput) 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 (*ListFlowsOutput) SetFlowSummaries added in v1.54.18 

func (s *ListFlowsOutput) SetFlowSummaries(v []*FlowSummary) *ListFlowsOutput

SetFlowSummaries sets the FlowSummaries field's value.

func (*ListFlowsOutput) SetNextToken added in v1.54.18 

func (s *ListFlowsOutput) SetNextToken(v string) *ListFlowsOutput

SetNextToken sets the NextToken field's value.

func (ListFlowsOutput) String added in v1.54.18 

func (s ListFlowsOutput) 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 

func (s *ListIngestionJobsInput) SetFilters(v []*IngestionJobFilter) *ListIngestionJobsInput

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 

func (s *ListIngestionJobsInput) SetMaxResults(v int64) *ListIngestionJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListIngestionJobsInput) SetNextToken 

func (s *ListIngestionJobsInput) SetNextToken(v string) *ListIngestionJobsInput

SetNextToken sets the NextToken field's value.

func (*ListIngestionJobsInput) SetSortBy 

func (s *ListIngestionJobsInput) SetSortBy(v *IngestionJobSortBy) *ListIngestionJobsInput

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 

func (s *ListIngestionJobsOutput) SetNextToken(v string) *ListIngestionJobsOutput

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 

func (s *ListKnowledgeBasesInput) SetMaxResults(v int64) *ListKnowledgeBasesInput

SetMaxResults sets the MaxResults field's value.

func (*ListKnowledgeBasesInput) SetNextToken 

func (s *ListKnowledgeBasesInput) SetNextToken(v string) *ListKnowledgeBasesInput

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 

func (s *ListKnowledgeBasesOutput) SetNextToken(v string) *ListKnowledgeBasesOutput

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 ListPromptsInput added in v1.54.18 

type ListPromptsInput 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 `location:"querystring" 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The unique identifier of the prompt.
	PromptIdentifier *string `location:"querystring" locationName:"promptIdentifier" type:"string"`
	// contains filtered or unexported fields
}

func (ListPromptsInput) GoString added in v1.54.18 

func (s ListPromptsInput) 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 (*ListPromptsInput) SetMaxResults added in v1.54.18 

func (s *ListPromptsInput) SetMaxResults(v int64) *ListPromptsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPromptsInput) SetNextToken added in v1.54.18 

func (s *ListPromptsInput) SetNextToken(v string) *ListPromptsInput

SetNextToken sets the NextToken field's value.

func (*ListPromptsInput) SetPromptIdentifier added in v1.54.18 

func (s *ListPromptsInput) SetPromptIdentifier(v string) *ListPromptsInput

SetPromptIdentifier sets the PromptIdentifier field's value.

func (ListPromptsInput) String added in v1.54.18 

func (s ListPromptsInput) 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 (*ListPromptsInput) Validate added in v1.54.18 

func (s *ListPromptsInput) Validate() error

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

type ListPromptsOutput added in v1.54.18 

type ListPromptsOutput struct {

	// 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"`

	// A list, each member of which contains information about a prompt using Prompt
	// management.
	//
	// PromptSummaries is a required field
	PromptSummaries []*PromptSummary `locationName:"promptSummaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListPromptsOutput) GoString added in v1.54.18 

func (s ListPromptsOutput) 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 (*ListPromptsOutput) SetNextToken added in v1.54.18 

func (s *ListPromptsOutput) SetNextToken(v string) *ListPromptsOutput

SetNextToken sets the NextToken field's value.

func (*ListPromptsOutput) SetPromptSummaries added in v1.54.18 

func (s *ListPromptsOutput) SetPromptSummaries(v []*PromptSummary) *ListPromptsOutput

SetPromptSummaries sets the PromptSummaries field's value.

func (ListPromptsOutput) String added in v1.54.18 

func (s ListPromptsOutput) 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 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

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 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

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 MemoryConfiguration added in v1.54.18 

type MemoryConfiguration struct {

	// The type of memory that is stored.
	//
	// EnabledMemoryTypes is a required field
	EnabledMemoryTypes []*string `locationName:"enabledMemoryTypes" min:"1" type:"list" required:"true" enum:"MemoryType"`

	// The number of days the agent is configured to retain the conversational context.
	StorageDays *int64 `locationName:"storageDays" type:"integer"`
	// contains filtered or unexported fields
}

Details of the memory configuration.

func (MemoryConfiguration) GoString added in v1.54.18 

func (s MemoryConfiguration) 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 (*MemoryConfiguration) SetEnabledMemoryTypes added in v1.54.18 

func (s *MemoryConfiguration) SetEnabledMemoryTypes(v []*string) *MemoryConfiguration

SetEnabledMemoryTypes sets the EnabledMemoryTypes field's value.

func (*MemoryConfiguration) SetStorageDays added in v1.54.18 

func (s *MemoryConfiguration) SetStorageDays(v int64) *MemoryConfiguration

SetStorageDays sets the StorageDays field's value.

func (MemoryConfiguration) String added in v1.54.18 

func (s MemoryConfiguration) 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 (*MemoryConfiguration) Validate added in v1.54.18 

func (s *MemoryConfiguration) Validate() error

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

type MongoDbAtlasConfiguration added in v1.52.0 

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 added in v1.52.0 

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 added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetCollectionName(v string) *MongoDbAtlasConfiguration

SetCollectionName sets the CollectionName field's value.

func (*MongoDbAtlasConfiguration) SetCredentialsSecretArn added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetCredentialsSecretArn(v string) *MongoDbAtlasConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*MongoDbAtlasConfiguration) SetDatabaseName added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetDatabaseName(v string) *MongoDbAtlasConfiguration

SetDatabaseName sets the DatabaseName field's value.

func (*MongoDbAtlasConfiguration) SetEndpoint added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetEndpoint(v string) *MongoDbAtlasConfiguration

SetEndpoint sets the Endpoint field's value.

func (*MongoDbAtlasConfiguration) SetEndpointServiceName added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetEndpointServiceName(v string) *MongoDbAtlasConfiguration

SetEndpointServiceName sets the EndpointServiceName field's value.

func (*MongoDbAtlasConfiguration) SetFieldMapping added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetFieldMapping(v *MongoDbAtlasFieldMapping) *MongoDbAtlasConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*MongoDbAtlasConfiguration) SetVectorIndexName added in v1.52.0 

func (s *MongoDbAtlasConfiguration) SetVectorIndexName(v string) *MongoDbAtlasConfiguration

SetVectorIndexName sets the VectorIndexName field's value.

func (MongoDbAtlasConfiguration) String added in v1.52.0 

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 added in v1.52.0 

func (s *MongoDbAtlasConfiguration) Validate() error

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

type MongoDbAtlasFieldMapping added in v1.52.0 

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 added in v1.52.0 

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 added in v1.52.0 

func (s *MongoDbAtlasFieldMapping) SetMetadataField(v string) *MongoDbAtlasFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*MongoDbAtlasFieldMapping) SetTextField added in v1.52.0 

func (s *MongoDbAtlasFieldMapping) SetTextField(v string) *MongoDbAtlasFieldMapping

SetTextField sets the TextField field's value.

func (*MongoDbAtlasFieldMapping) SetVectorField added in v1.52.0 

func (s *MongoDbAtlasFieldMapping) SetVectorField(v string) *MongoDbAtlasFieldMapping

SetVectorField sets the VectorField field's value.

func (MongoDbAtlasFieldMapping) String added in v1.52.0 

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 added in v1.52.0 

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 

func (s OpenSearchServerlessConfiguration) 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 (*OpenSearchServerlessConfiguration) SetCollectionArn 

func (s *OpenSearchServerlessConfiguration) SetCollectionArn(v string) *OpenSearchServerlessConfiguration

SetCollectionArn sets the CollectionArn field's value.

func (*OpenSearchServerlessConfiguration) SetFieldMapping 

func (s *OpenSearchServerlessConfiguration) SetFieldMapping(v *OpenSearchServerlessFieldMapping) *OpenSearchServerlessConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*OpenSearchServerlessConfiguration) SetVectorIndexName 

func (s *OpenSearchServerlessConfiguration) SetVectorIndexName(v string) *OpenSearchServerlessConfiguration

SetVectorIndexName sets the VectorIndexName field's value.

func (OpenSearchServerlessConfiguration) String 

func (s OpenSearchServerlessConfiguration) 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 (*OpenSearchServerlessConfiguration) Validate 

func (s *OpenSearchServerlessConfiguration) Validate() error

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 

func (s OpenSearchServerlessFieldMapping) 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 (*OpenSearchServerlessFieldMapping) SetMetadataField 

func (s *OpenSearchServerlessFieldMapping) SetMetadataField(v string) *OpenSearchServerlessFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*OpenSearchServerlessFieldMapping) SetTextField 

func (s *OpenSearchServerlessFieldMapping) SetTextField(v string) *OpenSearchServerlessFieldMapping

SetTextField sets the TextField field's value.

func (*OpenSearchServerlessFieldMapping) SetVectorField 

func (s *OpenSearchServerlessFieldMapping) SetVectorField(v string) *OpenSearchServerlessFieldMapping

SetVectorField sets the VectorField field's value.

func (OpenSearchServerlessFieldMapping) String 

func (s OpenSearchServerlessFieldMapping) 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 (*OpenSearchServerlessFieldMapping) Validate 

func (s *OpenSearchServerlessFieldMapping) Validate() error

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

type OutputFlowNodeConfiguration added in v1.54.18 

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

Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the type field and how to return the final output in the expression field.

func (OutputFlowNodeConfiguration) GoString added in v1.54.18 

func (s OutputFlowNodeConfiguration) 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 (OutputFlowNodeConfiguration) String added in v1.54.18 

func (s OutputFlowNodeConfiguration) 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 ParameterDetail added in v1.51.26 

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 added in v1.51.26 

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 added in v1.51.26 

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

SetDescription sets the Description field's value.

func (*ParameterDetail) SetRequired added in v1.51.26 

func (s *ParameterDetail) SetRequired(v bool) *ParameterDetail

SetRequired sets the Required field's value.

func (*ParameterDetail) SetType added in v1.51.26 

func (s *ParameterDetail) SetType(v string) *ParameterDetail

SetType sets the Type field's value.

func (ParameterDetail) String added in v1.51.26 

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 added in v1.51.26 

func (s *ParameterDetail) Validate() error

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

type ParsingConfiguration added in v1.54.18 

type ParsingConfiguration struct {

	// Settings for a foundation model used to parse documents for a data source.
	BedrockFoundationModelConfiguration *BedrockFoundationModelConfiguration `locationName:"bedrockFoundationModelConfiguration" type:"structure"`

	// The parsing strategy for the data source.
	//
	// ParsingStrategy is a required field
	ParsingStrategy *string `locationName:"parsingStrategy" type:"string" required:"true" enum:"ParsingStrategy"`
	// contains filtered or unexported fields
}

Settings for parsing document contents. By default, the service converts the contents of each document into text before splitting it into chunks. To improve processing of PDF files with tables and images, you can configure the data source to convert the pages of text into images and use a model to describe the contents of each page.

To use a model to parse PDF documents, set the parsing strategy to BEDROCK_FOUNDATION_MODEL and specify the model to use by ARN. You can also override the default parsing prompt with instructions for how to interpret images and tables in your documents. The following models are supported.

  • Anthropic Claude 3 Sonnet - anthropic.claude-3-sonnet-20240229-v1:0

  • Anthropic Claude 3 Haiku - anthropic.claude-3-haiku-20240307-v1:0

You can get the ARN of a model with the action. Standard model usage charges apply for the foundation model parsing strategy.

func (ParsingConfiguration) GoString added in v1.54.18 

func (s ParsingConfiguration) 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 (*ParsingConfiguration) SetBedrockFoundationModelConfiguration added in v1.54.18 

func (s *ParsingConfiguration) SetBedrockFoundationModelConfiguration(v *BedrockFoundationModelConfiguration) *ParsingConfiguration

SetBedrockFoundationModelConfiguration sets the BedrockFoundationModelConfiguration field's value.

func (*ParsingConfiguration) SetParsingStrategy added in v1.54.18 

func (s *ParsingConfiguration) SetParsingStrategy(v string) *ParsingConfiguration

SetParsingStrategy sets the ParsingStrategy field's value.

func (ParsingConfiguration) String added in v1.54.18 

func (s ParsingConfiguration) 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 (*ParsingConfiguration) Validate added in v1.54.18 

func (s *ParsingConfiguration) Validate() error

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

type ParsingPrompt added in v1.54.18 

type ParsingPrompt struct {

	// Instructions for interpreting the contents of a document.
	//
	// ParsingPromptText is a required field
	ParsingPromptText *string `locationName:"parsingPromptText" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Instructions for interpreting the contents of a document.

func (ParsingPrompt) GoString added in v1.54.18 

func (s ParsingPrompt) 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 (*ParsingPrompt) SetParsingPromptText added in v1.54.18 

func (s *ParsingPrompt) SetParsingPromptText(v string) *ParsingPrompt

SetParsingPromptText sets the ParsingPromptText field's value.

func (ParsingPrompt) String added in v1.54.18 

func (s ParsingPrompt) 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 (*ParsingPrompt) Validate added in v1.54.18 

func (s *ParsingPrompt) Validate() error

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

type PatternObjectFilter added in v1.54.18 

type PatternObjectFilter struct {

	// A list of one or more exclusion regular expression patterns to exclude certain
	// object types that adhere to the pattern. If you specify an inclusion and
	// exclusion filter/pattern and both match a document, the exclusion filter
	// takes precedence and the document isn’t crawled.
	//
	// ExclusionFilters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PatternObjectFilter's
	// String and GoString methods.
	ExclusionFilters []*string `locationName:"exclusionFilters" min:"1" type:"list" sensitive:"true"`

	// A list of one or more inclusion regular expression patterns to include certain
	// object types that adhere to the pattern. If you specify an inclusion and
	// exclusion filter/pattern and both match a document, the exclusion filter
	// takes precedence and the document isn’t crawled.
	//
	// InclusionFilters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PatternObjectFilter's
	// String and GoString methods.
	InclusionFilters []*string `locationName:"inclusionFilters" min:"1" type:"list" sensitive:"true"`

	// The supported object type or content type of the data source.
	//
	// ObjectType is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PatternObjectFilter's
	// String and GoString methods.
	//
	// ObjectType is a required field
	ObjectType *string `locationName:"objectType" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The specific filters applied to your data source content. You can filter out or include certain content.

func (PatternObjectFilter) GoString added in v1.54.18 

func (s PatternObjectFilter) 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 (*PatternObjectFilter) SetExclusionFilters added in v1.54.18 

func (s *PatternObjectFilter) SetExclusionFilters(v []*string) *PatternObjectFilter

SetExclusionFilters sets the ExclusionFilters field's value.

func (*PatternObjectFilter) SetInclusionFilters added in v1.54.18 

func (s *PatternObjectFilter) SetInclusionFilters(v []*string) *PatternObjectFilter

SetInclusionFilters sets the InclusionFilters field's value.

func (*PatternObjectFilter) SetObjectType added in v1.54.18 

func (s *PatternObjectFilter) SetObjectType(v string) *PatternObjectFilter

SetObjectType sets the ObjectType field's value.

func (PatternObjectFilter) String added in v1.54.18 

func (s PatternObjectFilter) 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 (*PatternObjectFilter) Validate added in v1.54.18 

func (s *PatternObjectFilter) Validate() error

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

type PatternObjectFilterConfiguration added in v1.54.18 

type PatternObjectFilterConfiguration struct {

	// The configuration of specific filters applied to your data source content.
	// You can filter out or include certain content.
	//
	// Filters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PatternObjectFilterConfiguration's
	// String and GoString methods.
	//
	// Filters is a required field
	Filters []*PatternObjectFilter `locationName:"filters" min:"1" type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

The configuration of filtering certain objects or content types of the data source.

func (PatternObjectFilterConfiguration) GoString added in v1.54.18 

func (s PatternObjectFilterConfiguration) 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 (*PatternObjectFilterConfiguration) SetFilters added in v1.54.18 

func (s *PatternObjectFilterConfiguration) SetFilters(v []*PatternObjectFilter) *PatternObjectFilterConfiguration

SetFilters sets the Filters field's value.

func (PatternObjectFilterConfiguration) String added in v1.54.18 

func (s PatternObjectFilterConfiguration) 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 (*PatternObjectFilterConfiguration) Validate added in v1.54.18 

func (s *PatternObjectFilterConfiguration) 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 

func (s *PineconeConfiguration) SetFieldMapping(v *PineconeFieldMapping) *PineconeConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*PineconeConfiguration) SetNamespace 

func (s *PineconeConfiguration) SetNamespace(v string) *PineconeConfiguration

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 PrepareFlowInput added in v1.54.18 

type PrepareFlowInput struct {

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PrepareFlowInput) GoString added in v1.54.18 

func (s PrepareFlowInput) 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 (*PrepareFlowInput) SetFlowIdentifier added in v1.54.18 

func (s *PrepareFlowInput) SetFlowIdentifier(v string) *PrepareFlowInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (PrepareFlowInput) String added in v1.54.18 

func (s PrepareFlowInput) 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 (*PrepareFlowInput) Validate added in v1.54.18 

func (s *PrepareFlowInput) Validate() error

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

type PrepareFlowOutput added in v1.54.18 

type PrepareFlowOutput struct {

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The status of the flow. When you submit this request, the status will be
	// NotPrepared. If preparation succeeds, the status becomes Prepared. If it
	// fails, the status becomes FAILED.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`
	// contains filtered or unexported fields
}

func (PrepareFlowOutput) GoString added in v1.54.18 

func (s PrepareFlowOutput) 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 (*PrepareFlowOutput) SetId added in v1.54.18 

func (s *PrepareFlowOutput) SetId(v string) *PrepareFlowOutput

SetId sets the Id field's value.

func (*PrepareFlowOutput) SetStatus added in v1.54.18 

func (s *PrepareFlowOutput) SetStatus(v string) *PrepareFlowOutput

SetStatus sets the Status field's value.

func (PrepareFlowOutput) String added in v1.54.18 

func (s PrepareFlowOutput) 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PromptConfiguration's
	// String and GoString methods.
	BasePromptTemplate *string `locationName:"basePromptTemplate" min:"1" type:"string" sensitive:"true"`

	// 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 PromptFlowNodeConfiguration added in v1.54.18 

type PromptFlowNodeConfiguration struct {

	// Specifies whether the prompt is from Prompt management or defined inline.
	//
	// SourceConfiguration is a required field
	SourceConfiguration *PromptFlowNodeSourceConfiguration `locationName:"sourceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see Node types in Amazon Bedrock works (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.

func (PromptFlowNodeConfiguration) GoString added in v1.54.18 

func (s PromptFlowNodeConfiguration) 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 (*PromptFlowNodeConfiguration) SetSourceConfiguration added in v1.54.18 

func (s *PromptFlowNodeConfiguration) SetSourceConfiguration(v *PromptFlowNodeSourceConfiguration) *PromptFlowNodeConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (PromptFlowNodeConfiguration) String added in v1.54.18 

func (s PromptFlowNodeConfiguration) 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 (*PromptFlowNodeConfiguration) Validate added in v1.54.18 

func (s *PromptFlowNodeConfiguration) Validate() error

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

type PromptFlowNodeInlineConfiguration added in v1.54.18 

type PromptFlowNodeInlineConfiguration struct {

	// Contains inference configurations for the prompt.
	InferenceConfiguration *PromptInferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`

	// The unique identifier of the model to run inference with.
	//
	// ModelId is a required field
	ModelId *string `locationName:"modelId" min:"1" type:"string" required:"true"`

	// Contains a prompt and variables in the prompt that can be replaced with values
	// at runtime.
	//
	// TemplateConfiguration is a required field
	TemplateConfiguration *PromptTemplateConfiguration `locationName:"templateConfiguration" type:"structure" required:"true"`

	// The type of prompt template.
	//
	// TemplateType is a required field
	TemplateType *string `locationName:"templateType" type:"string" required:"true" enum:"PromptTemplateType"`
	// contains filtered or unexported fields
}

Contains configurations for a prompt defined inline in the node.

func (PromptFlowNodeInlineConfiguration) GoString added in v1.54.18 

func (s PromptFlowNodeInlineConfiguration) 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 (*PromptFlowNodeInlineConfiguration) SetInferenceConfiguration added in v1.54.18 

func (s *PromptFlowNodeInlineConfiguration) SetInferenceConfiguration(v *PromptInferenceConfiguration) *PromptFlowNodeInlineConfiguration

SetInferenceConfiguration sets the InferenceConfiguration field's value.

func (*PromptFlowNodeInlineConfiguration) SetModelId added in v1.54.18 

func (s *PromptFlowNodeInlineConfiguration) SetModelId(v string) *PromptFlowNodeInlineConfiguration

SetModelId sets the ModelId field's value.

func (*PromptFlowNodeInlineConfiguration) SetTemplateConfiguration added in v1.54.18 

func (s *PromptFlowNodeInlineConfiguration) SetTemplateConfiguration(v *PromptTemplateConfiguration) *PromptFlowNodeInlineConfiguration

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*PromptFlowNodeInlineConfiguration) SetTemplateType added in v1.54.18 

func (s *PromptFlowNodeInlineConfiguration) SetTemplateType(v string) *PromptFlowNodeInlineConfiguration

SetTemplateType sets the TemplateType field's value.

func (PromptFlowNodeInlineConfiguration) String added in v1.54.18 

func (s PromptFlowNodeInlineConfiguration) 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 (*PromptFlowNodeInlineConfiguration) Validate added in v1.54.18 

func (s *PromptFlowNodeInlineConfiguration) Validate() error

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

type PromptFlowNodeResourceConfiguration added in v1.54.18 

type PromptFlowNodeResourceConfiguration struct {

	// The Amazon Resource Name (ARN) of the prompt from Prompt management.
	//
	// PromptArn is a required field
	PromptArn *string `locationName:"promptArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a prompt from Prompt management to use in a node.

func (PromptFlowNodeResourceConfiguration) GoString added in v1.54.18 

func (s PromptFlowNodeResourceConfiguration) 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 (*PromptFlowNodeResourceConfiguration) SetPromptArn added in v1.54.18 

func (s *PromptFlowNodeResourceConfiguration) SetPromptArn(v string) *PromptFlowNodeResourceConfiguration

SetPromptArn sets the PromptArn field's value.

func (PromptFlowNodeResourceConfiguration) String added in v1.54.18 

func (s PromptFlowNodeResourceConfiguration) 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 (*PromptFlowNodeResourceConfiguration) Validate added in v1.54.18 

func (s *PromptFlowNodeResourceConfiguration) Validate() error

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

type PromptFlowNodeSourceConfiguration added in v1.54.18 

type PromptFlowNodeSourceConfiguration struct {

	// Contains configurations for a prompt that is defined inline
	Inline *PromptFlowNodeInlineConfiguration `locationName:"inline" type:"structure"`

	// Contains configurations for a prompt from Prompt management.
	Resource *PromptFlowNodeResourceConfiguration `locationName:"resource" type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations for a prompt and whether it is from Prompt management or defined inline.

func (PromptFlowNodeSourceConfiguration) GoString added in v1.54.18 

func (s PromptFlowNodeSourceConfiguration) 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 (*PromptFlowNodeSourceConfiguration) SetInline added in v1.54.18 

func (s *PromptFlowNodeSourceConfiguration) SetInline(v *PromptFlowNodeInlineConfiguration) *PromptFlowNodeSourceConfiguration

SetInline sets the Inline field's value.

func (*PromptFlowNodeSourceConfiguration) SetResource added in v1.54.18 

func (s *PromptFlowNodeSourceConfiguration) SetResource(v *PromptFlowNodeResourceConfiguration) *PromptFlowNodeSourceConfiguration

SetResource sets the Resource field's value.

func (PromptFlowNodeSourceConfiguration) String added in v1.54.18 

func (s PromptFlowNodeSourceConfiguration) 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 (*PromptFlowNodeSourceConfiguration) Validate added in v1.54.18 

func (s *PromptFlowNodeSourceConfiguration) Validate() error

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

type PromptInferenceConfiguration added in v1.54.18 

type PromptInferenceConfiguration struct {

	// Contains inference configurations for a text prompt.
	Text *PromptModelInferenceConfiguration `locationName:"text" type:"structure"`
	// contains filtered or unexported fields
}

Contains inference configurations for the prompt.

func (PromptInferenceConfiguration) GoString added in v1.54.18 

func (s PromptInferenceConfiguration) 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 (*PromptInferenceConfiguration) SetText added in v1.54.18 

func (s *PromptInferenceConfiguration) SetText(v *PromptModelInferenceConfiguration) *PromptInferenceConfiguration

SetText sets the Text field's value.

func (PromptInferenceConfiguration) String added in v1.54.18 

func (s PromptInferenceConfiguration) 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 PromptInputVariable added in v1.54.18 

type PromptInputVariable struct {

	// The name of the variable.
	Name *string `locationName:"name" type:"string"`
	// contains filtered or unexported fields
}

Contains information about a variable in the prompt.

func (PromptInputVariable) GoString added in v1.54.18 

func (s PromptInputVariable) 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 (*PromptInputVariable) SetName added in v1.54.18 

func (s *PromptInputVariable) SetName(v string) *PromptInputVariable

SetName sets the Name field's value.

func (PromptInputVariable) String added in v1.54.18 

func (s PromptInputVariable) 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 PromptModelInferenceConfiguration added in v1.54.18 

type PromptModelInferenceConfiguration struct {

	// The maximum number of tokens to return in the response.
	MaxTokens *int64 `locationName:"maxTokens" type:"integer"`

	// A list of strings that define sequences after which the model will stop generating.
	StopSequences []*string `locationName:"stopSequences" type:"list"`

	// Controls the randomness of the response. Choose a lower value for more predictable
	// outputs and a higher value for more surprising outputs.
	Temperature *float64 `locationName:"temperature" type:"float"`

	// The number of most-likely candidates that the model considers for the next
	// token during generation.
	TopK *int64 `locationName:"topK" type:"integer"`

	// The percentage of most-likely candidates that the model considers for the
	// next token.
	TopP *float64 `locationName:"topP" type:"float"`
	// contains filtered or unexported fields
}

Contains inference configurations related to model inference for a prompt. For more information, see Inference parameters (https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).

func (PromptModelInferenceConfiguration) GoString added in v1.54.18 

func (s PromptModelInferenceConfiguration) 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 (*PromptModelInferenceConfiguration) SetMaxTokens added in v1.54.18 

func (s *PromptModelInferenceConfiguration) SetMaxTokens(v int64) *PromptModelInferenceConfiguration

SetMaxTokens sets the MaxTokens field's value.

func (*PromptModelInferenceConfiguration) SetStopSequences added in v1.54.18 

func (s *PromptModelInferenceConfiguration) SetStopSequences(v []*string) *PromptModelInferenceConfiguration

SetStopSequences sets the StopSequences field's value.

func (*PromptModelInferenceConfiguration) SetTemperature added in v1.54.18 

func (s *PromptModelInferenceConfiguration) SetTemperature(v float64) *PromptModelInferenceConfiguration

SetTemperature sets the Temperature field's value.

func (*PromptModelInferenceConfiguration) SetTopK added in v1.54.18 

func (s *PromptModelInferenceConfiguration) SetTopK(v int64) *PromptModelInferenceConfiguration

SetTopK sets the TopK field's value.

func (*PromptModelInferenceConfiguration) SetTopP added in v1.54.18 

func (s *PromptModelInferenceConfiguration) SetTopP(v float64) *PromptModelInferenceConfiguration

SetTopP sets the TopP field's value.

func (PromptModelInferenceConfiguration) String added in v1.54.18 

func (s PromptModelInferenceConfiguration) 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 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 

func (s *PromptOverrideConfiguration) SetOverrideLambda(v string) *PromptOverrideConfiguration

SetOverrideLambda sets the OverrideLambda field's value.

func (*PromptOverrideConfiguration) SetPromptConfigurations 

func (s *PromptOverrideConfiguration) SetPromptConfigurations(v []*PromptConfiguration) *PromptOverrideConfiguration

SetPromptConfigurations sets the PromptConfigurations field's value.

func (PromptOverrideConfiguration) String 

func (s PromptOverrideConfiguration) 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 (*PromptOverrideConfiguration) Validate 

func (s *PromptOverrideConfiguration) Validate() error

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

type PromptSummary added in v1.54.18 

type PromptSummary struct {

	// The Amazon Resource Name (ARN) of the prompt.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

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

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

	// The unique identifier of the prompt.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

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

	// The version of the prompt that this summary applies to.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a prompt in your Prompt management tool.

This data type is used in the following API operations:

func (PromptSummary) GoString added in v1.54.18 

func (s PromptSummary) 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 (*PromptSummary) SetArn added in v1.54.18 

func (s *PromptSummary) SetArn(v string) *PromptSummary

SetArn sets the Arn field's value.

func (*PromptSummary) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*PromptSummary) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*PromptSummary) SetId added in v1.54.18 

func (s *PromptSummary) SetId(v string) *PromptSummary

SetId sets the Id field's value.

func (*PromptSummary) SetName added in v1.54.18 

func (s *PromptSummary) SetName(v string) *PromptSummary

SetName sets the Name field's value.

func (*PromptSummary) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*PromptSummary) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (PromptSummary) String added in v1.54.18 

func (s PromptSummary) 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 PromptTemplateConfiguration added in v1.54.18 

type PromptTemplateConfiguration struct {

	// Contains configurations for the text in a message for a prompt.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by PromptTemplateConfiguration's
	// String and GoString methods.
	Text *TextPromptTemplateConfiguration `locationName:"text" type:"structure" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains the message for a prompt. For more information, see Prompt management in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).

func (PromptTemplateConfiguration) GoString added in v1.54.18 

func (s PromptTemplateConfiguration) 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 (*PromptTemplateConfiguration) SetText added in v1.54.18 

func (s *PromptTemplateConfiguration) SetText(v *TextPromptTemplateConfiguration) *PromptTemplateConfiguration

SetText sets the Text field's value.

func (PromptTemplateConfiguration) String added in v1.54.18 

func (s PromptTemplateConfiguration) 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 (*PromptTemplateConfiguration) Validate added in v1.54.18 

func (s *PromptTemplateConfiguration) Validate() error

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

type PromptVariant added in v1.54.18 

type PromptVariant struct {

	// Contains inference configurations for the prompt variant.
	InferenceConfiguration *PromptInferenceConfiguration `locationName:"inferenceConfiguration" type:"structure"`

	// The unique identifier of the model with which to run inference on the prompt.
	ModelId *string `locationName:"modelId" min:"1" type:"string"`

	// The name of the prompt variant.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Contains configurations for the prompt template.
	TemplateConfiguration *PromptTemplateConfiguration `locationName:"templateConfiguration" type:"structure"`

	// The type of prompt template to use.
	//
	// TemplateType is a required field
	TemplateType *string `locationName:"templateType" type:"string" required:"true" enum:"PromptTemplateType"`
	// contains filtered or unexported fields
}

Contains details about a variant of the prompt.

func (PromptVariant) GoString added in v1.54.18 

func (s PromptVariant) 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 (*PromptVariant) SetInferenceConfiguration added in v1.54.18 

func (s *PromptVariant) SetInferenceConfiguration(v *PromptInferenceConfiguration) *PromptVariant

SetInferenceConfiguration sets the InferenceConfiguration field's value.

func (*PromptVariant) SetModelId added in v1.54.18 

func (s *PromptVariant) SetModelId(v string) *PromptVariant

SetModelId sets the ModelId field's value.

func (*PromptVariant) SetName added in v1.54.18 

func (s *PromptVariant) SetName(v string) *PromptVariant

SetName sets the Name field's value.

func (*PromptVariant) SetTemplateConfiguration added in v1.54.18 

func (s *PromptVariant) SetTemplateConfiguration(v *PromptTemplateConfiguration) *PromptVariant

SetTemplateConfiguration sets the TemplateConfiguration field's value.

func (*PromptVariant) SetTemplateType added in v1.54.18 

func (s *PromptVariant) SetTemplateType(v string) *PromptVariant

SetTemplateType sets the TemplateType field's value.

func (PromptVariant) String added in v1.54.18 

func (s PromptVariant) 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 (*PromptVariant) Validate added in v1.54.18 

func (s *PromptVariant) Validate() error

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

type RdsConfiguration added in v1.49.8 

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 added in v1.49.8 

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 added in v1.49.8 

func (s *RdsConfiguration) SetCredentialsSecretArn(v string) *RdsConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*RdsConfiguration) SetDatabaseName added in v1.49.8 

func (s *RdsConfiguration) SetDatabaseName(v string) *RdsConfiguration

SetDatabaseName sets the DatabaseName field's value.

func (*RdsConfiguration) SetFieldMapping added in v1.49.8 

func (s *RdsConfiguration) SetFieldMapping(v *RdsFieldMapping) *RdsConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*RdsConfiguration) SetResourceArn added in v1.49.8 

func (s *RdsConfiguration) SetResourceArn(v string) *RdsConfiguration

SetResourceArn sets the ResourceArn field's value.

func (*RdsConfiguration) SetTableName added in v1.49.8 

func (s *RdsConfiguration) SetTableName(v string) *RdsConfiguration

SetTableName sets the TableName field's value.

func (RdsConfiguration) String added in v1.49.8 

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 added in v1.49.8 

func (s *RdsConfiguration) Validate() error

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

type RdsFieldMapping added in v1.49.8 

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 added in v1.49.8 

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 added in v1.49.8 

func (s *RdsFieldMapping) SetMetadataField(v string) *RdsFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*RdsFieldMapping) SetPrimaryKeyField added in v1.49.8 

func (s *RdsFieldMapping) SetPrimaryKeyField(v string) *RdsFieldMapping

SetPrimaryKeyField sets the PrimaryKeyField field's value.

func (*RdsFieldMapping) SetTextField added in v1.49.8 

func (s *RdsFieldMapping) SetTextField(v string) *RdsFieldMapping

SetTextField sets the TextField field's value.

func (*RdsFieldMapping) SetVectorField added in v1.49.8 

func (s *RdsFieldMapping) SetVectorField(v string) *RdsFieldMapping

SetVectorField sets the VectorField field's value.

func (RdsFieldMapping) String added in v1.49.8 

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 added in v1.49.8 

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 

func (s RedisEnterpriseCloudConfiguration) 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 (*RedisEnterpriseCloudConfiguration) SetCredentialsSecretArn 

func (s *RedisEnterpriseCloudConfiguration) SetCredentialsSecretArn(v string) *RedisEnterpriseCloudConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*RedisEnterpriseCloudConfiguration) SetEndpoint 

func (s *RedisEnterpriseCloudConfiguration) SetEndpoint(v string) *RedisEnterpriseCloudConfiguration

SetEndpoint sets the Endpoint field's value.

func (*RedisEnterpriseCloudConfiguration) SetFieldMapping 

func (s *RedisEnterpriseCloudConfiguration) SetFieldMapping(v *RedisEnterpriseCloudFieldMapping) *RedisEnterpriseCloudConfiguration

SetFieldMapping sets the FieldMapping field's value.

func (*RedisEnterpriseCloudConfiguration) SetVectorIndexName 

func (s *RedisEnterpriseCloudConfiguration) SetVectorIndexName(v string) *RedisEnterpriseCloudConfiguration

SetVectorIndexName sets the VectorIndexName field's value.

func (RedisEnterpriseCloudConfiguration) String 

func (s RedisEnterpriseCloudConfiguration) 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 (*RedisEnterpriseCloudConfiguration) Validate 

func (s *RedisEnterpriseCloudConfiguration) Validate() error

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 

func (s RedisEnterpriseCloudFieldMapping) 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 (*RedisEnterpriseCloudFieldMapping) SetMetadataField 

func (s *RedisEnterpriseCloudFieldMapping) SetMetadataField(v string) *RedisEnterpriseCloudFieldMapping

SetMetadataField sets the MetadataField field's value.

func (*RedisEnterpriseCloudFieldMapping) SetTextField 

func (s *RedisEnterpriseCloudFieldMapping) SetTextField(v string) *RedisEnterpriseCloudFieldMapping

SetTextField sets the TextField field's value.

func (*RedisEnterpriseCloudFieldMapping) SetVectorField 

func (s *RedisEnterpriseCloudFieldMapping) SetVectorField(v string) *RedisEnterpriseCloudFieldMapping

SetVectorField sets the VectorField field's value.

func (RedisEnterpriseCloudFieldMapping) String 

func (s RedisEnterpriseCloudFieldMapping) 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 (*RedisEnterpriseCloudFieldMapping) Validate 

func (s *RedisEnterpriseCloudFieldMapping) Validate() error

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 

func (s *ResourceNotFoundException) Code() string

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 RetrievalFlowNodeConfiguration added in v1.54.18 

type RetrievalFlowNodeConfiguration struct {

	// Contains configurations for the service to use for retrieving data to return
	// as the output from the node.
	//
	// ServiceConfiguration is a required field
	ServiceConfiguration *RetrievalFlowNodeServiceConfiguration `locationName:"serviceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.

func (RetrievalFlowNodeConfiguration) GoString added in v1.54.18 

func (s RetrievalFlowNodeConfiguration) 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 (*RetrievalFlowNodeConfiguration) SetServiceConfiguration added in v1.54.18 

func (s *RetrievalFlowNodeConfiguration) SetServiceConfiguration(v *RetrievalFlowNodeServiceConfiguration) *RetrievalFlowNodeConfiguration

SetServiceConfiguration sets the ServiceConfiguration field's value.

func (RetrievalFlowNodeConfiguration) String added in v1.54.18 

func (s RetrievalFlowNodeConfiguration) 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 (*RetrievalFlowNodeConfiguration) Validate added in v1.54.18 

func (s *RetrievalFlowNodeConfiguration) Validate() error

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

type RetrievalFlowNodeS3Configuration added in v1.54.18 

type RetrievalFlowNodeS3Configuration struct {

	// The name of the Amazon S3 bucket from which to retrieve data.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.

func (RetrievalFlowNodeS3Configuration) GoString added in v1.54.18 

func (s RetrievalFlowNodeS3Configuration) 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 (*RetrievalFlowNodeS3Configuration) SetBucketName added in v1.54.18 

func (s *RetrievalFlowNodeS3Configuration) SetBucketName(v string) *RetrievalFlowNodeS3Configuration

SetBucketName sets the BucketName field's value.

func (RetrievalFlowNodeS3Configuration) String added in v1.54.18 

func (s RetrievalFlowNodeS3Configuration) 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 (*RetrievalFlowNodeS3Configuration) Validate added in v1.54.18 

func (s *RetrievalFlowNodeS3Configuration) Validate() error

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

type RetrievalFlowNodeServiceConfiguration added in v1.54.18 

type RetrievalFlowNodeServiceConfiguration struct {

	// Contains configurations for the Amazon S3 location from which to retrieve
	// data to return as the output from the node.
	S3 *RetrievalFlowNodeS3Configuration `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations for the service to use for retrieving data to return as the output from the node.

func (RetrievalFlowNodeServiceConfiguration) GoString added in v1.54.18 

func (s RetrievalFlowNodeServiceConfiguration) 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 (*RetrievalFlowNodeServiceConfiguration) SetS3 added in v1.54.18 

func (s *RetrievalFlowNodeServiceConfiguration) SetS3(v *RetrievalFlowNodeS3Configuration) *RetrievalFlowNodeServiceConfiguration

SetS3 sets the S3 field's value.

func (RetrievalFlowNodeServiceConfiguration) String added in v1.54.18 

func (s RetrievalFlowNodeServiceConfiguration) 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 (*RetrievalFlowNodeServiceConfiguration) Validate added in v1.54.18 

func (s *RetrievalFlowNodeServiceConfiguration) Validate() error

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

type S3DataSourceConfiguration 

type S3DataSourceConfiguration struct {

	// The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
	//
	// BucketArn is a required field
	BucketArn *string `locationName:"bucketArn" min:"1" type:"string" required:"true"`

	// The account ID for the owner of the S3 bucket.
	BucketOwnerAccountId *string `locationName:"bucketOwnerAccountId" min:"12" type:"string"`

	// A list of S3 prefixes to include certain files or content. 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" sensitive:"true"`
	// contains filtered or unexported fields
}

The configuration information to connect to Amazon S3 as your 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 

func (s *S3DataSourceConfiguration) SetBucketArn(v string) *S3DataSourceConfiguration

SetBucketArn sets the BucketArn field's value.

func (*S3DataSourceConfiguration) SetBucketOwnerAccountId added in v1.51.27 

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 for the S3 resource.
	S3ObjectKey *string `locationName:"s3ObjectKey" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The identifier information for an Amazon S3 bucket.

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 S3Location added in v1.54.18 

type S3Location struct {

	// The location's URI. For example, s3://my-bucket/chunk-processor/.
	//
	// Uri is a required field
	Uri *string `locationName:"uri" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An Amazon S3 location.

func (S3Location) GoString added in v1.54.18 

func (s S3Location) 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 (*S3Location) SetUri added in v1.54.18 

func (s *S3Location) SetUri(v string) *S3Location

SetUri sets the Uri field's value.

func (S3Location) String added in v1.54.18 

func (s S3Location) 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 (*S3Location) Validate added in v1.54.18 

func (s *S3Location) Validate() error

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

type SalesforceCrawlerConfiguration added in v1.54.18 

type SalesforceCrawlerConfiguration struct {

	// The configuration of filtering the Salesforce content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration `locationName:"filterConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

func (SalesforceCrawlerConfiguration) GoString added in v1.54.18 

func (s SalesforceCrawlerConfiguration) 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 (*SalesforceCrawlerConfiguration) SetFilterConfiguration added in v1.54.18 

func (s *SalesforceCrawlerConfiguration) SetFilterConfiguration(v *CrawlFilterConfiguration) *SalesforceCrawlerConfiguration

SetFilterConfiguration sets the FilterConfiguration field's value.

func (SalesforceCrawlerConfiguration) String added in v1.54.18 

func (s SalesforceCrawlerConfiguration) 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 (*SalesforceCrawlerConfiguration) Validate added in v1.54.18 

func (s *SalesforceCrawlerConfiguration) Validate() error

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

type SalesforceDataSourceConfiguration added in v1.54.18 

type SalesforceDataSourceConfiguration struct {

	// The configuration of the Salesforce content. For example, configuring specific
	// types of Salesforce content.
	CrawlerConfiguration *SalesforceCrawlerConfiguration `locationName:"crawlerConfiguration" type:"structure"`

	// The endpoint information to connect to your Salesforce data source.
	//
	// SourceConfiguration is a required field
	SourceConfiguration *SalesforceSourceConfiguration `locationName:"sourceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration information to connect to Salesforce as your data source.

func (SalesforceDataSourceConfiguration) GoString added in v1.54.18 

func (s SalesforceDataSourceConfiguration) 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 (*SalesforceDataSourceConfiguration) SetCrawlerConfiguration added in v1.54.18 

func (s *SalesforceDataSourceConfiguration) SetCrawlerConfiguration(v *SalesforceCrawlerConfiguration) *SalesforceDataSourceConfiguration

SetCrawlerConfiguration sets the CrawlerConfiguration field's value.

func (*SalesforceDataSourceConfiguration) SetSourceConfiguration added in v1.54.18 

func (s *SalesforceDataSourceConfiguration) SetSourceConfiguration(v *SalesforceSourceConfiguration) *SalesforceDataSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (SalesforceDataSourceConfiguration) String added in v1.54.18 

func (s SalesforceDataSourceConfiguration) 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 (*SalesforceDataSourceConfiguration) Validate added in v1.54.18 

func (s *SalesforceDataSourceConfiguration) Validate() error

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

type SalesforceSourceConfiguration added in v1.54.18 

type SalesforceSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your Salesforce
	// instance.
	//
	// AuthType is a required field
	AuthType *string `locationName:"authType" type:"string" required:"true" enum:"SalesforceAuthType"`

	// The Amazon Resource Name of an Secrets Manager secret that stores your authentication
	// credentials for your SharePoint site/sites. For more information on the key-value
	// pairs that must be included in your secret, depending on your authentication
	// type, see Salesforce connection configuration (https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector).
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The Salesforce host URL or instance URL.
	//
	// HostUrl is a required field
	HostUrl *string `locationName:"hostUrl" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The endpoint information to connect to your Salesforce data source.

func (SalesforceSourceConfiguration) GoString added in v1.54.18 

func (s SalesforceSourceConfiguration) 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 (*SalesforceSourceConfiguration) SetAuthType added in v1.54.18 

func (s *SalesforceSourceConfiguration) SetAuthType(v string) *SalesforceSourceConfiguration

SetAuthType sets the AuthType field's value.

func (*SalesforceSourceConfiguration) SetCredentialsSecretArn added in v1.54.18 

func (s *SalesforceSourceConfiguration) SetCredentialsSecretArn(v string) *SalesforceSourceConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*SalesforceSourceConfiguration) SetHostUrl added in v1.54.18 

func (s *SalesforceSourceConfiguration) SetHostUrl(v string) *SalesforceSourceConfiguration

SetHostUrl sets the HostUrl field's value.

func (SalesforceSourceConfiguration) String added in v1.54.18 

func (s SalesforceSourceConfiguration) 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 (*SalesforceSourceConfiguration) Validate added in v1.54.18 

func (s *SalesforceSourceConfiguration) Validate() error

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

type SeedUrl added in v1.54.18 

type SeedUrl struct {

	// A seed or starting point URL.
	Url *string `locationName:"url" type:"string"`
	// contains filtered or unexported fields
}

The seed or starting point URL. You should be authorized to crawl the URL.

func (SeedUrl) GoString added in v1.54.18 

func (s SeedUrl) 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 (*SeedUrl) SetUrl added in v1.54.18 

func (s *SeedUrl) SetUrl(v string) *SeedUrl

SetUrl sets the Url field's value.

func (SeedUrl) String added in v1.54.18 

func (s SeedUrl) 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 SemanticChunkingConfiguration added in v1.54.18 

type SemanticChunkingConfiguration struct {

	// The dissimilarity threshold for splitting chunks.
	//
	// BreakpointPercentileThreshold is a required field
	BreakpointPercentileThreshold *int64 `locationName:"breakpointPercentileThreshold" min:"50" type:"integer" required:"true"`

	// The buffer size.
	//
	// BufferSize is a required field
	BufferSize *int64 `locationName:"bufferSize" type:"integer" required:"true"`

	// The maximum number of tokens that a chunk can contain.
	//
	// MaxTokens is a required field
	MaxTokens *int64 `locationName:"maxTokens" min:"1" type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.

You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to 1, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.

func (SemanticChunkingConfiguration) GoString added in v1.54.18 

func (s SemanticChunkingConfiguration) 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 (*SemanticChunkingConfiguration) SetBreakpointPercentileThreshold added in v1.54.18 

func (s *SemanticChunkingConfiguration) SetBreakpointPercentileThreshold(v int64) *SemanticChunkingConfiguration

SetBreakpointPercentileThreshold sets the BreakpointPercentileThreshold field's value.

func (*SemanticChunkingConfiguration) SetBufferSize added in v1.54.18 

func (s *SemanticChunkingConfiguration) SetBufferSize(v int64) *SemanticChunkingConfiguration

SetBufferSize sets the BufferSize field's value.

func (*SemanticChunkingConfiguration) SetMaxTokens added in v1.54.18 

func (s *SemanticChunkingConfiguration) SetMaxTokens(v int64) *SemanticChunkingConfiguration

SetMaxTokens sets the MaxTokens field's value.

func (SemanticChunkingConfiguration) String added in v1.54.18 

func (s SemanticChunkingConfiguration) 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 (*SemanticChunkingConfiguration) Validate added in v1.54.18 

func (s *SemanticChunkingConfiguration) 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 

func (s ServerSideEncryptionConfiguration) 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 (*ServerSideEncryptionConfiguration) SetKmsKeyArn 

func (s *ServerSideEncryptionConfiguration) SetKmsKeyArn(v string) *ServerSideEncryptionConfiguration

SetKmsKeyArn sets the KmsKeyArn field's value.

func (ServerSideEncryptionConfiguration) String 

func (s ServerSideEncryptionConfiguration) 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 (*ServerSideEncryptionConfiguration) Validate 

func (s *ServerSideEncryptionConfiguration) Validate() error

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 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) 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 (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

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 

func (s ServiceQuotaExceededException) 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 SharePointCrawlerConfiguration added in v1.54.18 

type SharePointCrawlerConfiguration struct {

	// The configuration of filtering the SharePoint content. For example, configuring
	// regular expression patterns to include or exclude certain content.
	FilterConfiguration *CrawlFilterConfiguration `locationName:"filterConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

func (SharePointCrawlerConfiguration) GoString added in v1.54.18 

func (s SharePointCrawlerConfiguration) 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 (*SharePointCrawlerConfiguration) SetFilterConfiguration added in v1.54.18 

func (s *SharePointCrawlerConfiguration) SetFilterConfiguration(v *CrawlFilterConfiguration) *SharePointCrawlerConfiguration

SetFilterConfiguration sets the FilterConfiguration field's value.

func (SharePointCrawlerConfiguration) String added in v1.54.18 

func (s SharePointCrawlerConfiguration) 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 (*SharePointCrawlerConfiguration) Validate added in v1.54.18 

func (s *SharePointCrawlerConfiguration) Validate() error

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

type SharePointDataSourceConfiguration added in v1.54.18 

type SharePointDataSourceConfiguration struct {

	// The configuration of the SharePoint content. For example, configuring specific
	// types of SharePoint content.
	CrawlerConfiguration *SharePointCrawlerConfiguration `locationName:"crawlerConfiguration" type:"structure"`

	// The endpoint information to connect to your SharePoint data source.
	//
	// SourceConfiguration is a required field
	SourceConfiguration *SharePointSourceConfiguration `locationName:"sourceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration information to connect to SharePoint as your data source.

func (SharePointDataSourceConfiguration) GoString added in v1.54.18 

func (s SharePointDataSourceConfiguration) 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 (*SharePointDataSourceConfiguration) SetCrawlerConfiguration added in v1.54.18 

func (s *SharePointDataSourceConfiguration) SetCrawlerConfiguration(v *SharePointCrawlerConfiguration) *SharePointDataSourceConfiguration

SetCrawlerConfiguration sets the CrawlerConfiguration field's value.

func (*SharePointDataSourceConfiguration) SetSourceConfiguration added in v1.54.18 

func (s *SharePointDataSourceConfiguration) SetSourceConfiguration(v *SharePointSourceConfiguration) *SharePointDataSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (SharePointDataSourceConfiguration) String added in v1.54.18 

func (s SharePointDataSourceConfiguration) 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 (*SharePointDataSourceConfiguration) Validate added in v1.54.18 

func (s *SharePointDataSourceConfiguration) Validate() error

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

type SharePointSourceConfiguration added in v1.54.18 

type SharePointSourceConfiguration struct {

	// The supported authentication type to authenticate and connect to your SharePoint
	// site/sites.
	//
	// AuthType is a required field
	AuthType *string `locationName:"authType" type:"string" required:"true" enum:"SharePointAuthType"`

	// The Amazon Resource Name of an Secrets Manager secret that stores your authentication
	// credentials for your SharePoint site/sites. For more information on the key-value
	// pairs that must be included in your secret, depending on your authentication
	// type, see SharePoint connection configuration (https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector).
	//
	// CredentialsSecretArn is a required field
	CredentialsSecretArn *string `locationName:"credentialsSecretArn" type:"string" required:"true"`

	// The domain of your SharePoint instance or site URL/URLs.
	//
	// Domain is a required field
	Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`

	// The supported host type, whether online/cloud or server/on-premises.
	//
	// HostType is a required field
	HostType *string `locationName:"hostType" type:"string" required:"true" enum:"SharePointHostType"`

	// A list of one or more SharePoint site URLs.
	//
	// SiteUrls is a required field
	SiteUrls []*string `locationName:"siteUrls" min:"1" type:"list" required:"true"`

	// The identifier of your Microsoft 365 tenant.
	TenantId *string `locationName:"tenantId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

The endpoint information to connect to your SharePoint data source.

func (SharePointSourceConfiguration) GoString added in v1.54.18 

func (s SharePointSourceConfiguration) 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 (*SharePointSourceConfiguration) SetAuthType added in v1.54.18 

func (s *SharePointSourceConfiguration) SetAuthType(v string) *SharePointSourceConfiguration

SetAuthType sets the AuthType field's value.

func (*SharePointSourceConfiguration) SetCredentialsSecretArn added in v1.54.18 

func (s *SharePointSourceConfiguration) SetCredentialsSecretArn(v string) *SharePointSourceConfiguration

SetCredentialsSecretArn sets the CredentialsSecretArn field's value.

func (*SharePointSourceConfiguration) SetDomain added in v1.54.18 

func (s *SharePointSourceConfiguration) SetDomain(v string) *SharePointSourceConfiguration

SetDomain sets the Domain field's value.

func (*SharePointSourceConfiguration) SetHostType added in v1.54.18 

func (s *SharePointSourceConfiguration) SetHostType(v string) *SharePointSourceConfiguration

SetHostType sets the HostType field's value.

func (*SharePointSourceConfiguration) SetSiteUrls added in v1.54.18 

func (s *SharePointSourceConfiguration) SetSiteUrls(v []*string) *SharePointSourceConfiguration

SetSiteUrls sets the SiteUrls field's value.

func (*SharePointSourceConfiguration) SetTenantId added in v1.54.18 

func (s *SharePointSourceConfiguration) SetTenantId(v string) *SharePointSourceConfiguration

SetTenantId sets the TenantId field's value.

func (SharePointSourceConfiguration) String added in v1.54.18 

func (s SharePointSourceConfiguration) 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 (*SharePointSourceConfiguration) Validate added in v1.54.18 

func (s *SharePointSourceConfiguration) Validate() error

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

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 

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

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 

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

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 

func (s *StartIngestionJobOutput) SetIngestionJob(v *IngestionJob) *StartIngestionJobOutput

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 added in v1.52.0 

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 added in v1.49.8 

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 

func (s *StorageConfiguration) SetType(v string) *StorageConfiguration

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 StorageFlowNodeConfiguration added in v1.54.18 

type StorageFlowNodeConfiguration struct {

	// Contains configurations for the service to use for storing the input into
	// the node.
	//
	// ServiceConfiguration is a required field
	ServiceConfiguration *StorageFlowNodeServiceConfiguration `locationName:"serviceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.

func (StorageFlowNodeConfiguration) GoString added in v1.54.18 

func (s StorageFlowNodeConfiguration) 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 (*StorageFlowNodeConfiguration) SetServiceConfiguration added in v1.54.18 

func (s *StorageFlowNodeConfiguration) SetServiceConfiguration(v *StorageFlowNodeServiceConfiguration) *StorageFlowNodeConfiguration

SetServiceConfiguration sets the ServiceConfiguration field's value.

func (StorageFlowNodeConfiguration) String added in v1.54.18 

func (s StorageFlowNodeConfiguration) 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 (*StorageFlowNodeConfiguration) Validate added in v1.54.18 

func (s *StorageFlowNodeConfiguration) Validate() error

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

type StorageFlowNodeS3Configuration added in v1.54.18 

type StorageFlowNodeS3Configuration struct {

	// The name of the Amazon S3 bucket in which to store the input into the node.
	//
	// BucketName is a required field
	BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains configurations for the Amazon S3 location in which to store the input into the node.

func (StorageFlowNodeS3Configuration) GoString added in v1.54.18 

func (s StorageFlowNodeS3Configuration) 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 (*StorageFlowNodeS3Configuration) SetBucketName added in v1.54.18 

func (s *StorageFlowNodeS3Configuration) SetBucketName(v string) *StorageFlowNodeS3Configuration

SetBucketName sets the BucketName field's value.

func (StorageFlowNodeS3Configuration) String added in v1.54.18 

func (s StorageFlowNodeS3Configuration) 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 (*StorageFlowNodeS3Configuration) Validate added in v1.54.18 

func (s *StorageFlowNodeS3Configuration) Validate() error

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

type StorageFlowNodeServiceConfiguration added in v1.54.18 

type StorageFlowNodeServiceConfiguration struct {

	// Contains configurations for the Amazon S3 location in which to store the
	// input into the node.
	S3 *StorageFlowNodeS3Configuration `locationName:"s3" type:"structure"`
	// contains filtered or unexported fields
}

Contains configurations for the service to use for storing the input into the node.

func (StorageFlowNodeServiceConfiguration) GoString added in v1.54.18 

func (s StorageFlowNodeServiceConfiguration) 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 (*StorageFlowNodeServiceConfiguration) SetS3 added in v1.54.18 

func (s *StorageFlowNodeServiceConfiguration) SetS3(v *StorageFlowNodeS3Configuration) *StorageFlowNodeServiceConfiguration

SetS3 sets the S3 field's value.

func (StorageFlowNodeServiceConfiguration) String added in v1.54.18 

func (s StorageFlowNodeServiceConfiguration) 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 (*StorageFlowNodeServiceConfiguration) Validate added in v1.54.18 

func (s *StorageFlowNodeServiceConfiguration) 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 TextPromptTemplateConfiguration added in v1.54.18 

type TextPromptTemplateConfiguration struct {

	// An array of the variables in the prompt template.
	//
	// InputVariables is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TextPromptTemplateConfiguration's
	// String and GoString methods.
	InputVariables []*PromptInputVariable `locationName:"inputVariables" type:"list" sensitive:"true"`

	// The message for the prompt.
	//
	// Text is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TextPromptTemplateConfiguration's
	// String and GoString methods.
	//
	// Text is a required field
	Text *string `locationName:"text" min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in {{variable}}.

func (TextPromptTemplateConfiguration) GoString added in v1.54.18 

func (s TextPromptTemplateConfiguration) 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 (*TextPromptTemplateConfiguration) SetInputVariables added in v1.54.18 

func (s *TextPromptTemplateConfiguration) SetInputVariables(v []*PromptInputVariable) *TextPromptTemplateConfiguration

SetInputVariables sets the InputVariables field's value.

func (*TextPromptTemplateConfiguration) SetText added in v1.54.18 

func (s *TextPromptTemplateConfiguration) SetText(v string) *TextPromptTemplateConfiguration

SetText sets the Text field's value.

func (TextPromptTemplateConfiguration) String added in v1.54.18 

func (s TextPromptTemplateConfiguration) 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 (*TextPromptTemplateConfiguration) Validate added in v1.54.18 

func (s *TextPromptTemplateConfiguration) Validate() error

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

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 Transformation added in v1.54.18 

type Transformation struct {

	// When the service applies the transformation.
	//
	// StepToApply is a required field
	StepToApply *string `locationName:"stepToApply" type:"string" required:"true" enum:"StepType"`

	// A Lambda function that processes documents.
	//
	// TransformationFunction is a required field
	TransformationFunction *TransformationFunction `locationName:"transformationFunction" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING.

func (Transformation) GoString added in v1.54.18 

func (s Transformation) 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 (*Transformation) SetStepToApply added in v1.54.18 

func (s *Transformation) SetStepToApply(v string) *Transformation

SetStepToApply sets the StepToApply field's value.

func (*Transformation) SetTransformationFunction added in v1.54.18 

func (s *Transformation) SetTransformationFunction(v *TransformationFunction) *Transformation

SetTransformationFunction sets the TransformationFunction field's value.

func (Transformation) String added in v1.54.18 

func (s Transformation) 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 (*Transformation) Validate added in v1.54.18 

func (s *Transformation) Validate() error

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

type TransformationFunction added in v1.54.18 

type TransformationFunction struct {

	// The Lambda function.
	//
	// TransformationLambdaConfiguration is a required field
	TransformationLambdaConfiguration *TransformationLambdaConfiguration `locationName:"transformationLambdaConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A Lambda function that processes documents.

func (TransformationFunction) GoString added in v1.54.18 

func (s TransformationFunction) 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 (*TransformationFunction) SetTransformationLambdaConfiguration added in v1.54.18 

func (s *TransformationFunction) SetTransformationLambdaConfiguration(v *TransformationLambdaConfiguration) *TransformationFunction

SetTransformationLambdaConfiguration sets the TransformationLambdaConfiguration field's value.

func (TransformationFunction) String added in v1.54.18 

func (s TransformationFunction) 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 (*TransformationFunction) Validate added in v1.54.18 

func (s *TransformationFunction) Validate() error

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

type TransformationLambdaConfiguration added in v1.54.18 

type TransformationLambdaConfiguration struct {

	// The function's ARN identifier.
	//
	// LambdaArn is a required field
	LambdaArn *string `locationName:"lambdaArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A Lambda function that processes documents.

func (TransformationLambdaConfiguration) GoString added in v1.54.18 

func (s TransformationLambdaConfiguration) 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 (*TransformationLambdaConfiguration) SetLambdaArn added in v1.54.18 

func (s *TransformationLambdaConfiguration) SetLambdaArn(v string) *TransformationLambdaConfiguration

SetLambdaArn sets the LambdaArn field's value.

func (TransformationLambdaConfiguration) String added in v1.54.18 

func (s TransformationLambdaConfiguration) 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 (*TransformationLambdaConfiguration) Validate added in v1.54.18 

func (s *TransformationLambdaConfiguration) Validate() error

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

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 

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

SetActionGroupExecutor sets the ActionGroupExecutor field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupId 

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

SetActionGroupId sets the ActionGroupId field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupName 

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

SetActionGroupName sets the ActionGroupName field's value.

func (*UpdateAgentActionGroupInput) SetActionGroupState 

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

SetActionGroupState sets the ActionGroupState field's value.

func (*UpdateAgentActionGroupInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*UpdateAgentActionGroupInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*UpdateAgentActionGroupInput) SetApiSchema 

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

SetApiSchema sets the ApiSchema field's value.

func (*UpdateAgentActionGroupInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateAgentActionGroupInput) SetFunctionSchema added in v1.51.26 

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

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 

func (s UpdateAgentActionGroupInput) 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 (*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 

func (s *UpdateAgentActionGroupOutput) SetAgentActionGroup(v *AgentActionGroup) *UpdateAgentActionGroupOutput

SetAgentActionGroup sets the AgentActionGroup field's value.

func (UpdateAgentActionGroupOutput) String 

func (s UpdateAgentActionGroupOutput) 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 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 

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

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 

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

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 

func (s *UpdateAgentAliasOutput) SetAgentAlias(v *AgentAlias) *UpdateAgentAliasOutput

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"`

	// Specifies the new memory configuration for the agent.
	MemoryConfiguration *MemoryConfiguration `locationName:"memoryConfiguration" type:"structure"`

	// 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 added in v1.53.6 

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) SetMemoryConfiguration added in v1.54.18 

func (s *UpdateAgentInput) SetMemoryConfiguration(v *MemoryConfiguration) *UpdateAgentInput

SetMemoryConfiguration sets the MemoryConfiguration 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 

func (s UpdateAgentKnowledgeBaseInput) 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 (*UpdateAgentKnowledgeBaseInput) SetAgentId 

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

SetAgentId sets the AgentId field's value.

func (*UpdateAgentKnowledgeBaseInput) SetAgentVersion 

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

SetAgentVersion sets the AgentVersion field's value.

func (*UpdateAgentKnowledgeBaseInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateAgentKnowledgeBaseInput) SetKnowledgeBaseId 

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

SetKnowledgeBaseId sets the KnowledgeBaseId field's value.

func (*UpdateAgentKnowledgeBaseInput) SetKnowledgeBaseState 

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

SetKnowledgeBaseState sets the KnowledgeBaseState field's value.

func (UpdateAgentKnowledgeBaseInput) String 

func (s UpdateAgentKnowledgeBaseInput) 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 (*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 

func (s UpdateAgentKnowledgeBaseOutput) 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 (*UpdateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase 

func (s *UpdateAgentKnowledgeBaseOutput) SetAgentKnowledgeBase(v *AgentKnowledgeBase) *UpdateAgentKnowledgeBaseOutput

SetAgentKnowledgeBase sets the AgentKnowledgeBase field's value.

func (UpdateAgentKnowledgeBaseOutput) String 

func (s UpdateAgentKnowledgeBaseOutput) 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 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 for the data source that you want to update.
	DataDeletionPolicy *string `locationName:"dataDeletionPolicy" type:"string" enum:"DataDeletionPolicy"`

	// The connection configuration for the data source that you want to update.
	//
	// 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 for the data source.
	//
	// 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 added in v1.51.27 

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 

func (s *UpdateDataSourceInput) SetName(v string) *UpdateDataSourceInput

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 

func (s *UpdateDataSourceOutput) SetDataSource(v *DataSource) *UpdateDataSourceOutput

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 UpdateFlowAliasInput added in v1.54.18 

type UpdateFlowAliasInput struct {

	// The unique identifier of the alias.
	//
	// AliasIdentifier is a required field
	AliasIdentifier *string `location:"uri" locationName:"aliasIdentifier" type:"string" required:"true"`

	// A description for the flow alias.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`

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

	// Contains information about the version to which to map the alias.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFlowAliasInput) GoString added in v1.54.18 

func (s UpdateFlowAliasInput) 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 (*UpdateFlowAliasInput) SetAliasIdentifier added in v1.54.18 

func (s *UpdateFlowAliasInput) SetAliasIdentifier(v string) *UpdateFlowAliasInput

SetAliasIdentifier sets the AliasIdentifier field's value.

func (*UpdateFlowAliasInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdateFlowAliasInput) SetFlowIdentifier added in v1.54.18 

func (s *UpdateFlowAliasInput) SetFlowIdentifier(v string) *UpdateFlowAliasInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*UpdateFlowAliasInput) SetName added in v1.54.18 

func (s *UpdateFlowAliasInput) SetName(v string) *UpdateFlowAliasInput

SetName sets the Name field's value.

func (*UpdateFlowAliasInput) SetRoutingConfiguration added in v1.54.18 

func (s *UpdateFlowAliasInput) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *UpdateFlowAliasInput

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (UpdateFlowAliasInput) String added in v1.54.18 

func (s UpdateFlowAliasInput) 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 (*UpdateFlowAliasInput) Validate added in v1.54.18 

func (s *UpdateFlowAliasInput) Validate() error

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

type UpdateFlowAliasOutput added in v1.54.18 

type UpdateFlowAliasOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

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

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

	// The unique identifier of the flow.
	//
	// FlowId is a required field
	FlowId *string `locationName:"flowId" type:"string" required:"true"`

	// The unique identifier of the alias.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

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

	// Contains information about the version that the alias is mapped to.
	//
	// RoutingConfiguration is a required field
	RoutingConfiguration []*FlowAliasRoutingConfigurationListItem `locationName:"routingConfiguration" min:"1" type:"list" required:"true"`

	// The time at which the flow 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
}

func (UpdateFlowAliasOutput) GoString added in v1.54.18 

func (s UpdateFlowAliasOutput) 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 (*UpdateFlowAliasOutput) SetArn added in v1.54.18 

func (s *UpdateFlowAliasOutput) SetArn(v string) *UpdateFlowAliasOutput

SetArn sets the Arn field's value.

func (*UpdateFlowAliasOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateFlowAliasOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdateFlowAliasOutput) SetFlowId added in v1.54.18 

func (s *UpdateFlowAliasOutput) SetFlowId(v string) *UpdateFlowAliasOutput

SetFlowId sets the FlowId field's value.

func (*UpdateFlowAliasOutput) SetId added in v1.54.18 

func (s *UpdateFlowAliasOutput) SetId(v string) *UpdateFlowAliasOutput

SetId sets the Id field's value.

func (*UpdateFlowAliasOutput) SetName added in v1.54.18 

func (s *UpdateFlowAliasOutput) SetName(v string) *UpdateFlowAliasOutput

SetName sets the Name field's value.

func (*UpdateFlowAliasOutput) SetRoutingConfiguration added in v1.54.18 

func (s *UpdateFlowAliasOutput) SetRoutingConfiguration(v []*FlowAliasRoutingConfigurationListItem) *UpdateFlowAliasOutput

SetRoutingConfiguration sets the RoutingConfiguration field's value.

func (*UpdateFlowAliasOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (UpdateFlowAliasOutput) String added in v1.54.18 

func (s UpdateFlowAliasOutput) 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 UpdateFlowInput added in v1.54.18 

type UpdateFlowInput struct {

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

	// A definition of the nodes and the connections between the nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

	// A description for the flow.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// and manage a flow. For more information, see Create a service role for flows
	// in Amazon Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// FlowIdentifier is a required field
	FlowIdentifier *string `location:"uri" locationName:"flowIdentifier" type:"string" required:"true"`

	// A name for the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFlowInput) GoString added in v1.54.18 

func (s UpdateFlowInput) 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 (*UpdateFlowInput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*UpdateFlowInput) SetDefinition added in v1.54.18 

func (s *UpdateFlowInput) SetDefinition(v *FlowDefinition) *UpdateFlowInput

SetDefinition sets the Definition field's value.

func (*UpdateFlowInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdateFlowInput) SetExecutionRoleArn added in v1.54.18 

func (s *UpdateFlowInput) SetExecutionRoleArn(v string) *UpdateFlowInput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateFlowInput) SetFlowIdentifier added in v1.54.18 

func (s *UpdateFlowInput) SetFlowIdentifier(v string) *UpdateFlowInput

SetFlowIdentifier sets the FlowIdentifier field's value.

func (*UpdateFlowInput) SetName added in v1.54.18 

func (s *UpdateFlowInput) SetName(v string) *UpdateFlowInput

SetName sets the Name field's value.

func (UpdateFlowInput) String added in v1.54.18 

func (s UpdateFlowInput) 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 (*UpdateFlowInput) Validate added in v1.54.18 

func (s *UpdateFlowInput) Validate() error

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

type UpdateFlowOutput added in v1.54.18 

type UpdateFlowOutput struct {

	// The Amazon Resource Name (ARN) of the flow.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the flow 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 the flow was encrypted
	// with.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// A definition of the nodes and the connections between nodes in the flow.
	Definition *FlowDefinition `locationName:"definition" type:"structure"`

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

	// The Amazon Resource Name (ARN) of the service role with permissions to create
	// a flow. For more information, see Create a service role for flows in Amazon
	// Bedrock (https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html)
	// in the Amazon Bedrock User Guide.
	//
	// ExecutionRoleArn is a required field
	ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string" required:"true"`

	// The unique identifier of the flow.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the flow.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The status of the flow. When you submit this request, the status will be
	// NotPrepared. If updating fails, the status becomes Failed.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"FlowStatus"`

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

	// The version of the flow. When you update a flow, the version updated is the
	// DRAFT version.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFlowOutput) GoString added in v1.54.18 

func (s UpdateFlowOutput) 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 (*UpdateFlowOutput) SetArn added in v1.54.18 

func (s *UpdateFlowOutput) SetArn(v string) *UpdateFlowOutput

SetArn sets the Arn field's value.

func (*UpdateFlowOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateFlowOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*UpdateFlowOutput) SetDefinition added in v1.54.18 

func (s *UpdateFlowOutput) SetDefinition(v *FlowDefinition) *UpdateFlowOutput

SetDefinition sets the Definition field's value.

func (*UpdateFlowOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdateFlowOutput) SetExecutionRoleArn added in v1.54.18 

func (s *UpdateFlowOutput) SetExecutionRoleArn(v string) *UpdateFlowOutput

SetExecutionRoleArn sets the ExecutionRoleArn field's value.

func (*UpdateFlowOutput) SetId added in v1.54.18 

func (s *UpdateFlowOutput) SetId(v string) *UpdateFlowOutput

SetId sets the Id field's value.

func (*UpdateFlowOutput) SetName added in v1.54.18 

func (s *UpdateFlowOutput) SetName(v string) *UpdateFlowOutput

SetName sets the Name field's value.

func (*UpdateFlowOutput) SetStatus added in v1.54.18 

func (s *UpdateFlowOutput) SetStatus(v string) *UpdateFlowOutput

SetStatus sets the Status field's value.

func (*UpdateFlowOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*UpdateFlowOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (UpdateFlowOutput) String added in v1.54.18 

func (s UpdateFlowOutput) 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 

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

SetDescription sets the Description field's value.

func (*UpdateKnowledgeBaseInput) SetKnowledgeBaseConfiguration 

func (s *UpdateKnowledgeBaseInput) SetKnowledgeBaseConfiguration(v *KnowledgeBaseConfiguration) *UpdateKnowledgeBaseInput

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 

func (s *UpdateKnowledgeBaseInput) SetName(v string) *UpdateKnowledgeBaseInput

SetName sets the Name field's value.

func (*UpdateKnowledgeBaseInput) SetRoleArn 

func (s *UpdateKnowledgeBaseInput) SetRoleArn(v string) *UpdateKnowledgeBaseInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateKnowledgeBaseInput) SetStorageConfiguration 

func (s *UpdateKnowledgeBaseInput) SetStorageConfiguration(v *StorageConfiguration) *UpdateKnowledgeBaseInput

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 

func (s *UpdateKnowledgeBaseOutput) SetKnowledgeBase(v *KnowledgeBase) *UpdateKnowledgeBaseOutput

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 UpdatePromptInput added in v1.54.18 

type UpdatePromptInput struct {

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

	// The name of the default variant for the prompt. This value must match the
	// name field in the relevant PromptVariant (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html)
	// object.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

	// A description for the prompt.
	Description *string `locationName:"description" min:"1" type:"string"`

	// A name for the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// The unique identifier of the prompt.
	//
	// PromptIdentifier is a required field
	PromptIdentifier *string `location:"uri" locationName:"promptIdentifier" type:"string" required:"true"`

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdatePromptInput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdatePromptInput) GoString added in v1.54.18 

func (s UpdatePromptInput) 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 (*UpdatePromptInput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*UpdatePromptInput) SetDefaultVariant added in v1.54.18 

func (s *UpdatePromptInput) SetDefaultVariant(v string) *UpdatePromptInput

SetDefaultVariant sets the DefaultVariant field's value.

func (*UpdatePromptInput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdatePromptInput) SetName added in v1.54.18 

func (s *UpdatePromptInput) SetName(v string) *UpdatePromptInput

SetName sets the Name field's value.

func (*UpdatePromptInput) SetPromptIdentifier added in v1.54.18 

func (s *UpdatePromptInput) SetPromptIdentifier(v string) *UpdatePromptInput

SetPromptIdentifier sets the PromptIdentifier field's value.

func (*UpdatePromptInput) SetVariants added in v1.54.18 

func (s *UpdatePromptInput) SetVariants(v []*PromptVariant) *UpdatePromptInput

SetVariants sets the Variants field's value.

func (UpdatePromptInput) String added in v1.54.18 

func (s UpdatePromptInput) 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 (*UpdatePromptInput) Validate added in v1.54.18 

func (s *UpdatePromptInput) Validate() error

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

type UpdatePromptOutput added in v1.54.18 

type UpdatePromptOutput struct {

	// The Amazon Resource Name (ARN) of the prompt.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time at which the prompt 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 to encrypt the prompt.
	CustomerEncryptionKeyArn *string `locationName:"customerEncryptionKeyArn" min:"1" type:"string"`

	// The name of the default variant for the prompt. This value must match the
	// name field in the relevant PromptVariant (https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html)
	// object.
	DefaultVariant *string `locationName:"defaultVariant" type:"string"`

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

	// The unique identifier of the prompt.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The name of the prompt.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

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

	// A list of objects, each containing details about a variant of the prompt.
	//
	// Variants is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdatePromptOutput's
	// String and GoString methods.
	Variants []*PromptVariant `locationName:"variants" type:"list" sensitive:"true"`

	// The version of the prompt. When you update a prompt, the version updated
	// is the DRAFT version.
	//
	// Version is a required field
	Version *string `locationName:"version" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePromptOutput) GoString added in v1.54.18 

func (s UpdatePromptOutput) 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 (*UpdatePromptOutput) SetArn added in v1.54.18 

func (s *UpdatePromptOutput) SetArn(v string) *UpdatePromptOutput

SetArn sets the Arn field's value.

func (*UpdatePromptOutput) SetCreatedAt added in v1.54.18 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UpdatePromptOutput) SetCustomerEncryptionKeyArn added in v1.54.18 

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

SetCustomerEncryptionKeyArn sets the CustomerEncryptionKeyArn field's value.

func (*UpdatePromptOutput) SetDefaultVariant added in v1.54.18 

func (s *UpdatePromptOutput) SetDefaultVariant(v string) *UpdatePromptOutput

SetDefaultVariant sets the DefaultVariant field's value.

func (*UpdatePromptOutput) SetDescription added in v1.54.18 

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

SetDescription sets the Description field's value.

func (*UpdatePromptOutput) SetId added in v1.54.18 

func (s *UpdatePromptOutput) SetId(v string) *UpdatePromptOutput

SetId sets the Id field's value.

func (*UpdatePromptOutput) SetName added in v1.54.18 

func (s *UpdatePromptOutput) SetName(v string) *UpdatePromptOutput

SetName sets the Name field's value.

func (*UpdatePromptOutput) SetUpdatedAt added in v1.54.18 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*UpdatePromptOutput) SetVariants added in v1.54.18 

func (s *UpdatePromptOutput) SetVariants(v []*PromptVariant) *UpdatePromptOutput

SetVariants sets the Variants field's value.

func (*UpdatePromptOutput) SetVersion added in v1.54.18 

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

SetVersion sets the Version field's value.

func (UpdatePromptOutput) String added in v1.54.18 

func (s UpdatePromptOutput) 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 UrlConfiguration added in v1.54.18 

type UrlConfiguration struct {

	// One or more seed or starting point URLs.
	SeedUrls []*SeedUrl `locationName:"seedUrls" min:"1" type:"list"`
	// contains filtered or unexported fields
}

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

func (UrlConfiguration) GoString added in v1.54.18 

func (s UrlConfiguration) 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 (*UrlConfiguration) SetSeedUrls added in v1.54.18 

func (s *UrlConfiguration) SetSeedUrls(v []*SeedUrl) *UrlConfiguration

SetSeedUrls sets the SeedUrls field's value.

func (UrlConfiguration) String added in v1.54.18 

func (s UrlConfiguration) 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 (*UrlConfiguration) Validate added in v1.54.18 

func (s *UrlConfiguration) Validate() error

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

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 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

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"`

	// A custom document transformer for parsed data source documents.
	CustomTransformationConfiguration *CustomTransformationConfiguration `locationName:"customTransformationConfiguration" type:"structure"`

	// A custom parser for data source documents.
	ParsingConfiguration *ParsingConfiguration `locationName:"parsingConfiguration" 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 

func (s *VectorIngestionConfiguration) SetChunkingConfiguration(v *ChunkingConfiguration) *VectorIngestionConfiguration

SetChunkingConfiguration sets the ChunkingConfiguration field's value.

func (*VectorIngestionConfiguration) SetCustomTransformationConfiguration added in v1.54.18 

func (s *VectorIngestionConfiguration) SetCustomTransformationConfiguration(v *CustomTransformationConfiguration) *VectorIngestionConfiguration

SetCustomTransformationConfiguration sets the CustomTransformationConfiguration field's value.

func (*VectorIngestionConfiguration) SetParsingConfiguration added in v1.54.18 

func (s *VectorIngestionConfiguration) SetParsingConfiguration(v *ParsingConfiguration) *VectorIngestionConfiguration

SetParsingConfiguration sets the ParsingConfiguration field's value.

func (VectorIngestionConfiguration) String 

func (s VectorIngestionConfiguration) 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 (*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 

func (s VectorKnowledgeBaseConfiguration) 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 (*VectorKnowledgeBaseConfiguration) SetEmbeddingModelArn 

func (s *VectorKnowledgeBaseConfiguration) SetEmbeddingModelArn(v string) *VectorKnowledgeBaseConfiguration

SetEmbeddingModelArn sets the EmbeddingModelArn field's value.

func (*VectorKnowledgeBaseConfiguration) SetEmbeddingModelConfiguration added in v1.53.13 

func (s *VectorKnowledgeBaseConfiguration) SetEmbeddingModelConfiguration(v *EmbeddingModelConfiguration) *VectorKnowledgeBaseConfiguration

SetEmbeddingModelConfiguration sets the EmbeddingModelConfiguration field's value.

func (VectorKnowledgeBaseConfiguration) String 

func (s VectorKnowledgeBaseConfiguration) 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 (*VectorKnowledgeBaseConfiguration) Validate 

func (s *VectorKnowledgeBaseConfiguration) Validate() error

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

type WebCrawlerConfiguration added in v1.54.18 

type WebCrawlerConfiguration struct {

	// The configuration of crawl limits for the web URLs.
	CrawlerLimits *WebCrawlerLimits `locationName:"crawlerLimits" type:"structure"`

	// A list of one or more exclusion regular expression patterns to exclude certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match
	// a URL, the exclusion filter takes precedence and the web content of the URL
	// isn’t crawled.
	//
	// ExclusionFilters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WebCrawlerConfiguration's
	// String and GoString methods.
	ExclusionFilters []*string `locationName:"exclusionFilters" min:"1" type:"list" sensitive:"true"`

	// A list of one or more inclusion regular expression patterns to include certain
	// URLs. If you specify an inclusion and exclusion filter/pattern and both match
	// a URL, the exclusion filter takes precedence and the web content of the URL
	// isn’t crawled.
	//
	// InclusionFilters is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WebCrawlerConfiguration's
	// String and GoString methods.
	InclusionFilters []*string `locationName:"inclusionFilters" min:"1" type:"list" sensitive:"true"`

	// The scope of what is crawled for your URLs.
	//
	// You can choose to crawl only web pages that belong to the same host or primary
	// domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/"
	// and no other domains. You can choose to include sub domains in addition to
	// the host or primary domain. For example, web pages that contain "aws.amazon.com"
	// can also include sub domain "docs.aws.amazon.com".
	Scope *string `locationName:"scope" type:"string" enum:"WebScopeType"`
	// contains filtered or unexported fields
}

The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.

func (WebCrawlerConfiguration) GoString added in v1.54.18 

func (s WebCrawlerConfiguration) 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 (*WebCrawlerConfiguration) SetCrawlerLimits added in v1.54.18 

func (s *WebCrawlerConfiguration) SetCrawlerLimits(v *WebCrawlerLimits) *WebCrawlerConfiguration

SetCrawlerLimits sets the CrawlerLimits field's value.

func (*WebCrawlerConfiguration) SetExclusionFilters added in v1.54.18 

func (s *WebCrawlerConfiguration) SetExclusionFilters(v []*string) *WebCrawlerConfiguration

SetExclusionFilters sets the ExclusionFilters field's value.

func (*WebCrawlerConfiguration) SetInclusionFilters added in v1.54.18 

func (s *WebCrawlerConfiguration) SetInclusionFilters(v []*string) *WebCrawlerConfiguration

SetInclusionFilters sets the InclusionFilters field's value.

func (*WebCrawlerConfiguration) SetScope added in v1.54.18 

func (s *WebCrawlerConfiguration) SetScope(v string) *WebCrawlerConfiguration

SetScope sets the Scope field's value.

func (WebCrawlerConfiguration) String added in v1.54.18 

func (s WebCrawlerConfiguration) 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 (*WebCrawlerConfiguration) Validate added in v1.54.18 

func (s *WebCrawlerConfiguration) Validate() error

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

type WebCrawlerLimits added in v1.54.18 

type WebCrawlerLimits struct {

	// The max rate at which pages are crawled, up to 300 per minute per host.
	RateLimit *int64 `locationName:"rateLimit" min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.

func (WebCrawlerLimits) GoString added in v1.54.18 

func (s WebCrawlerLimits) 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 (*WebCrawlerLimits) SetRateLimit added in v1.54.18 

func (s *WebCrawlerLimits) SetRateLimit(v int64) *WebCrawlerLimits

SetRateLimit sets the RateLimit field's value.

func (WebCrawlerLimits) String added in v1.54.18 

func (s WebCrawlerLimits) 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 (*WebCrawlerLimits) Validate added in v1.54.18 

func (s *WebCrawlerLimits) Validate() error

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

type WebDataSourceConfiguration added in v1.54.18 

type WebDataSourceConfiguration struct {

	// The Web Crawler configuration details for the web data source.
	CrawlerConfiguration *WebCrawlerConfiguration `locationName:"crawlerConfiguration" type:"structure"`

	// The source configuration details for the web data source.
	//
	// SourceConfiguration is a required field
	SourceConfiguration *WebSourceConfiguration `locationName:"sourceConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration details for the web data source.

func (WebDataSourceConfiguration) GoString added in v1.54.18 

func (s WebDataSourceConfiguration) 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 (*WebDataSourceConfiguration) SetCrawlerConfiguration added in v1.54.18 

func (s *WebDataSourceConfiguration) SetCrawlerConfiguration(v *WebCrawlerConfiguration) *WebDataSourceConfiguration

SetCrawlerConfiguration sets the CrawlerConfiguration field's value.

func (*WebDataSourceConfiguration) SetSourceConfiguration added in v1.54.18 

func (s *WebDataSourceConfiguration) SetSourceConfiguration(v *WebSourceConfiguration) *WebDataSourceConfiguration

SetSourceConfiguration sets the SourceConfiguration field's value.

func (WebDataSourceConfiguration) String added in v1.54.18 

func (s WebDataSourceConfiguration) 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 (*WebDataSourceConfiguration) Validate added in v1.54.18 

func (s *WebDataSourceConfiguration) Validate() error

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

type WebSourceConfiguration added in v1.54.18 

type WebSourceConfiguration struct {

	// The configuration of the URL/URLs.
	//
	// UrlConfiguration is a required field
	UrlConfiguration *UrlConfiguration `locationName:"urlConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.

func (WebSourceConfiguration) GoString added in v1.54.18 

func (s WebSourceConfiguration) 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 (*WebSourceConfiguration) SetUrlConfiguration added in v1.54.18 

func (s *WebSourceConfiguration) SetUrlConfiguration(v *UrlConfiguration) *WebSourceConfiguration

SetUrlConfiguration sets the UrlConfiguration field's value.

func (WebSourceConfiguration) String added in v1.54.18 

func (s WebSourceConfiguration) 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 (*WebSourceConfiguration) Validate added in v1.54.18 

func (s *WebSourceConfiguration) Validate() error

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

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.