types

package
v1.3.3 Latest Latest
Warning

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

 Go to latest Published: Oct 28, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The client is not authorized to perform the requested operation.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AppDefinition 

type AppDefinition struct {

	// The version of the app definition schema or specification.
	//
	// This member is required.
	AppDefinitionVersion *string

	// The cards that make up the Q App, such as text input, file upload, or query
	// cards.
	//
	// This member is required.
	Cards []Card

	// A flag indicating whether the Q App's definition can be edited by the user.
	CanEdit *bool
	// contains filtered or unexported fields
}

The definition of the Q App, specifying the cards and flow.

type AppDefinitionInput 

type AppDefinitionInput struct {

	// The cards that make up the Q App definition.
	//
	// This member is required.
	Cards []CardInput

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string
	// contains filtered or unexported fields
}

The input for defining an Q App.

type AppRequiredCapability 

type AppRequiredCapability string
const (
	AppRequiredCapabilityFileUpload    AppRequiredCapability = "FileUpload"
	AppRequiredCapabilityCreatorMode   AppRequiredCapability = "CreatorMode"
	AppRequiredCapabilityRetrievalMode AppRequiredCapability = "RetrievalMode"
	AppRequiredCapabilityPluginMode    AppRequiredCapability = "PluginMode"
)

Enum values for AppRequiredCapability

func (AppRequiredCapability) Values 

func (AppRequiredCapability) Values() []AppRequiredCapability

Values returns all known values for AppRequiredCapability. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AppStatus 

type AppStatus string
const (
	AppStatusPublished AppStatus = "PUBLISHED"
	AppStatusDraft     AppStatus = "DRAFT"
	AppStatusDeleted   AppStatus = "DELETED"
)

Enum values for AppStatus

func (AppStatus) Values 

func (AppStatus) Values() []AppStatus

Values returns all known values for AppStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AttributeFilter 

type AttributeFilter struct {

	// Performs a logical AND operation on all supplied filters.
	AndAllFilters []AttributeFilter

	// Returns true when a document contains all the specified document attributes or
	// metadata fields. Supported for the following [document attribute value types]: stringListValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	ContainsAll *DocumentAttribute

	// Returns true when a document contains any of the specified document attributes
	// or metadata fields. Supported for the following [document attribute value types]: stringListValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	ContainsAny *DocumentAttribute

	// Performs an equals operation on two document attributes or metadata fields.
	// Supported for the following [document attribute value types]: dateValue , longValue , stringListValue and
	// stringValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	EqualsTo *DocumentAttribute

	// Performs a greater than operation on two document attributes or metadata
	// fields. Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	GreaterThan *DocumentAttribute

	// Performs a greater than or equals operation on two document attributes or
	// metadata fields. Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	GreaterThanOrEquals *DocumentAttribute

	// Performs a less than operation on two document attributes or metadata fields.
	// Supported for the following [document attribute value types]: dateValue and longValue .
	//
	// [document attribute value types]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	LessThan *DocumentAttribute

	// Performs a less than or equals operation on two document attributes or metadata
	// fields.Supported for the following [document attribute value type]: dateValue and longValue .
	//
	// [document attribute value type]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html
	LessThanOrEquals *DocumentAttribute

	// Performs a logical NOT operation on all supplied filters.
	NotFilter *AttributeFilter

	//  Performs a logical OR operation on all supplied filters.
	OrAllFilters []AttributeFilter
	// contains filtered or unexported fields
}

The filter criteria used on responses based on document attributes or metadata fields.

type Card 

type Card interface {
	// contains filtered or unexported methods
}

A card representing a component or step in an Amazon Q App's flow.

The following types satisfy this interface: 

CardMemberFileUpload
CardMemberQPlugin
CardMemberQQuery
CardMemberTextInput
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qapps/types"
)

func main() {
	var union types.Card
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CardMemberFileUpload:
		_ = v.Value // Value is types.FileUploadCard

	case *types.CardMemberQPlugin:
		_ = v.Value // Value is types.QPluginCard

	case *types.CardMemberQQuery:
		_ = v.Value // Value is types.QQueryCard

	case *types.CardMemberTextInput:
		_ = v.Value // Value is types.TextInputCard

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type CardInput 

type CardInput interface {
	// contains filtered or unexported methods
}

The properties defining an input card in an Amazon Q App.

The following types satisfy this interface: 

CardInputMemberFileUpload
CardInputMemberQPlugin
CardInputMemberQQuery
CardInputMemberTextInput
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qapps/types"
)

func main() {
	var union types.CardInput
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CardInputMemberFileUpload:
		_ = v.Value // Value is types.FileUploadCardInput

	case *types.CardInputMemberQPlugin:
		_ = v.Value // Value is types.QPluginCardInput

	case *types.CardInputMemberQQuery:
		_ = v.Value // Value is types.QQueryCardInput

	case *types.CardInputMemberTextInput:
		_ = v.Value // Value is types.TextInputCardInput

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type CardInputMemberFileUpload 

type CardInputMemberFileUpload struct {
	Value FileUploadCardInput
	// contains filtered or unexported fields
}

A container for the properties of the file upload input card.

type CardInputMemberQPlugin 

type CardInputMemberQPlugin struct {
	Value QPluginCardInput
	// contains filtered or unexported fields
}

A container for the properties of the plugin input card.

type CardInputMemberQQuery 

type CardInputMemberQQuery struct {
	Value QQueryCardInput
	// contains filtered or unexported fields
}

A container for the properties of the query input card.

type CardInputMemberTextInput 

type CardInputMemberTextInput struct {
	Value TextInputCardInput
	// contains filtered or unexported fields
}

A container for the properties of the text input card.

type CardMemberFileUpload 

type CardMemberFileUpload struct {
	Value FileUploadCard
	// contains filtered or unexported fields
}

A container for the properties of the file upload card.

type CardMemberQPlugin 

type CardMemberQPlugin struct {
	Value QPluginCard
	// contains filtered or unexported fields
}

A container for the properties of the plugin card.

type CardMemberQQuery 

type CardMemberQQuery struct {
	Value QQueryCard
	// contains filtered or unexported fields
}

A container for the properties of the query card.

type CardMemberTextInput 

type CardMemberTextInput struct {
	Value TextInputCard
	// contains filtered or unexported fields
}

A container for the properties of the text input card.

type CardOutputSource 

type CardOutputSource string
const (
	CardOutputSourceApprovedSources CardOutputSource = "approved-sources"
	CardOutputSourceLlm             CardOutputSource = "llm"
)

Enum values for CardOutputSource

func (CardOutputSource) Values 

func (CardOutputSource) Values() []CardOutputSource

Values returns all known values for CardOutputSource. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CardStatus 

type CardStatus struct {

	// The current state of the card.
	//
	// This member is required.
	CurrentState ExecutionStatus

	// The current value or result associated with the card.
	//
	// This member is required.
	CurrentValue *string
	// contains filtered or unexported fields
}

The current status and value of a card in an active Amazon Q App session.

type CardType 

type CardType string
const (
	CardTypeTextInput  CardType = "text-input"
	CardTypeQQuery     CardType = "q-query"
	CardTypeFileUpload CardType = "file-upload"
	CardTypeQPlugin    CardType = "q-plugin"
)

Enum values for CardType

func (CardType) Values 

func (CardType) Values() []CardType

Values returns all known values for CardType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CardValue 

type CardValue struct {

	// The unique identifier of the card.
	//
	// This member is required.
	CardId *string

	// The value or result associated with the card.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

The value or result associated with a card in a Amazon Q App session.

type Category 

type Category struct {

	// The unique identifier of the category.
	//
	// This member is required.
	Id *string

	// The title or name of the category.
	//
	// This member is required.
	Title *string
	// contains filtered or unexported fields
}

A category used to classify and filter library items for Amazon Q Apps.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested operation could not be completed due to a conflict with the current state of the resource.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ContentTooLargeException 

type ContentTooLargeException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested operation could not be completed because the content exceeds the maximum allowed size.

func (*ContentTooLargeException) Error 

func (e *ContentTooLargeException) Error() string

func (*ContentTooLargeException) ErrorCode 

func (e *ContentTooLargeException) ErrorCode() string

func (*ContentTooLargeException) ErrorFault 

func (e *ContentTooLargeException) ErrorFault() smithy.ErrorFault

func (*ContentTooLargeException) ErrorMessage 

func (e *ContentTooLargeException) ErrorMessage() string

type ConversationMessage 

type ConversationMessage struct {

	// The text content of the conversation message.
	//
	// This member is required.
	Body *string

	// The type of the conversation message.
	//
	// This member is required.
	Type Sender
	// contains filtered or unexported fields
}

A message in a conversation, used as input for generating an Amazon Q App definition.

type DocumentAttribute 

type DocumentAttribute struct {

	// The identifier for the attribute.
	//
	// This member is required.
	Name *string

	// The value of the attribute.
	//
	// This member is required.
	Value DocumentAttributeValue
	// contains filtered or unexported fields
}

A document attribute or metadata field.

type DocumentAttributeValue 

type DocumentAttributeValue interface {
	// contains filtered or unexported methods
}

The value of a document attribute. You can only provide one value for a document attribute.

The following types satisfy this interface: 

DocumentAttributeValueMemberDateValue
DocumentAttributeValueMemberLongValue
DocumentAttributeValueMemberStringListValue
DocumentAttributeValueMemberStringValue
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qapps/types"
)

func main() {
	var union types.DocumentAttributeValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DocumentAttributeValueMemberDateValue:
		_ = v.Value // Value is time.Time

	case *types.DocumentAttributeValueMemberLongValue:
		_ = v.Value // Value is int64

	case *types.DocumentAttributeValueMemberStringListValue:
		_ = v.Value // Value is []string

	case *types.DocumentAttributeValueMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DocumentAttributeValueMemberDateValue 

type DocumentAttributeValueMemberDateValue struct {
	Value time.Time
	// contains filtered or unexported fields
}

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

type DocumentAttributeValueMemberLongValue 

type DocumentAttributeValueMemberLongValue struct {
	Value int64
	// contains filtered or unexported fields
}

A long integer value.

type DocumentAttributeValueMemberStringListValue 

type DocumentAttributeValueMemberStringListValue struct {
	Value []string
	// contains filtered or unexported fields
}

A list of strings.

type DocumentAttributeValueMemberStringValue 

type DocumentAttributeValueMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

A string.

type DocumentScope 

type DocumentScope string
const (
	DocumentScopeApplication DocumentScope = "APPLICATION"
	DocumentScopeSession     DocumentScope = "SESSION"
)

Enum values for DocumentScope

func (DocumentScope) Values 

func (DocumentScope) Values() []DocumentScope

Values returns all known values for DocumentScope. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExecutionStatus 

type ExecutionStatus string
const (
	ExecutionStatusInProgress ExecutionStatus = "IN_PROGRESS"
	ExecutionStatusWaiting    ExecutionStatus = "WAITING"
	ExecutionStatusCompleted  ExecutionStatus = "COMPLETED"
)

Enum values for ExecutionStatus

func (ExecutionStatus) Values 

func (ExecutionStatus) Values() []ExecutionStatus

Values returns all known values for ExecutionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FileUploadCard 

type FileUploadCard struct {

	// Any dependencies or requirements for the file upload card.
	//
	// This member is required.
	Dependencies []string

	// The unique identifier of the file upload card.
	//
	// This member is required.
	Id *string

	// The title of the file upload card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// A flag indicating if the user can override the default file for the upload card.
	AllowOverride *bool

	// The unique identifier of the file associated with the card.
	FileId *string

	// The name of the file being uploaded.
	Filename *string
	// contains filtered or unexported fields
}

A card in an Amazon Q App that allows the user to upload a file.

type FileUploadCardInput 

type FileUploadCardInput struct {

	// The unique identifier of the file upload card.
	//
	// This member is required.
	Id *string

	// The title or label of the file upload card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// A flag indicating if the user can override the default file for the upload card.
	AllowOverride *bool

	// The identifier of a pre-uploaded file associated with the card.
	FileId *string

	// The default filename to use for the file upload card.
	Filename *string
	// contains filtered or unexported fields
}

Represents a file upload card. It can optionally receive a filename and fileId to set a default file. If not received, the user must provide the file when the Q App runs.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

An internal service error occurred while processing the request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LibraryItemMember 

type LibraryItemMember struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// This member is required.
	AppId *string

	// The version of the Q App associated with the library item.
	//
	// This member is required.
	AppVersion *int32

	// The categories associated with the library item.
	//
	// This member is required.
	Categories []Category

	// The date and time the library item was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The user who created the library item.
	//
	// This member is required.
	CreatedBy *string

	// The unique identifier of the library item.
	//
	// This member is required.
	LibraryItemId *string

	// The number of ratings the library item has received.
	//
	// This member is required.
	RatingCount *int32

	// The status of the library item.
	//
	// This member is required.
	Status *string

	// Whether the current user has rated the library item.
	IsRatedByUser *bool

	// Indicates whether the library item has been verified.
	IsVerified *bool

	// The date and time the library item was last updated.
	UpdatedAt *time.Time

	// The user who last updated the library item.
	UpdatedBy *string

	// The number of users who have the associated Q App.
	UserCount *int32
	// contains filtered or unexported fields
}

A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.

type LibraryItemStatus 

type LibraryItemStatus string
const (
	LibraryItemStatusPublished LibraryItemStatus = "PUBLISHED"
	LibraryItemStatusDisabled  LibraryItemStatus = "DISABLED"
)

Enum values for LibraryItemStatus

func (LibraryItemStatus) Values 

func (LibraryItemStatus) Values() []LibraryItemStatus

Values returns all known values for LibraryItemStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PluginType 

type PluginType string
const (
	PluginTypeServiceNow PluginType = "SERVICE_NOW"
	PluginTypeSalesforce PluginType = "SALESFORCE"
	PluginTypeJira       PluginType = "JIRA"
	PluginTypeZendesk    PluginType = "ZENDESK"
	PluginTypeCustom     PluginType = "CUSTOM"
)

Enum values for PluginType

func (PluginType) Values 

func (PluginType) Values() []PluginType

Values returns all known values for PluginType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PredictAppDefinition 

type PredictAppDefinition struct {

	// The definition specifying the cards and flow of the generated Q App.
	//
	// This member is required.
	AppDefinition *AppDefinitionInput

	// The title of the generated Q App definition.
	//
	// This member is required.
	Title *string

	// The description of the generated Q App definition.
	Description *string
	// contains filtered or unexported fields
}

The definition of an Amazon Q App generated based on input such as a conversation or problem statement.

type PredictQAppInputOptions 

type PredictQAppInputOptions interface {
	// contains filtered or unexported methods
}

The input options for generating an Q App definition.

The following types satisfy this interface: 

PredictQAppInputOptionsMemberConversation
PredictQAppInputOptionsMemberProblemStatement
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/qapps/types"
)

func main() {
	var union types.PredictQAppInputOptions
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PredictQAppInputOptionsMemberConversation:
		_ = v.Value // Value is []types.ConversationMessage

	case *types.PredictQAppInputOptionsMemberProblemStatement:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PredictQAppInputOptionsMemberConversation 

type PredictQAppInputOptionsMemberConversation struct {
	Value []ConversationMessage
	// contains filtered or unexported fields
}

A conversation to use as input for generating the Q App definition.

type PredictQAppInputOptionsMemberProblemStatement 

type PredictQAppInputOptionsMemberProblemStatement struct {
	Value string
	// contains filtered or unexported fields
}

A problem statement to use as input for generating the Q App definition.

type QPluginCard 

type QPluginCard struct {

	// Any dependencies or requirements for the plugin card.
	//
	// This member is required.
	Dependencies []string

	// The unique identifier of the plugin card.
	//
	// This member is required.
	Id *string

	// The unique identifier of the plugin used by the card.
	//
	// This member is required.
	PluginId *string

	// The type or category of the plugin used by the card.
	//
	// This member is required.
	PluginType PluginType

	// The prompt or instructions displayed for the plugin card.
	//
	// This member is required.
	Prompt *string

	// The title or label of the plugin card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType
	// contains filtered or unexported fields
}

A card in an Q App that integrates with a third-party plugin or service.

type QPluginCardInput 

type QPluginCardInput struct {

	// The unique identifier of the plugin card.
	//
	// This member is required.
	Id *string

	// The unique identifier of the plugin used by the card.
	//
	// This member is required.
	PluginId *string

	// The prompt or instructions displayed for the plugin card.
	//
	// This member is required.
	Prompt *string

	// The title or label of the plugin card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType
	// contains filtered or unexported fields
}

The input shape for defining a plugin card in an Amazon Q App.

type QQueryCard 

type QQueryCard struct {

	// Any dependencies or requirements for the query card.
	//
	// This member is required.
	Dependencies []string

	// The unique identifier of the query card.
	//
	// This member is required.
	Id *string

	// The source or type of output generated by the query card.
	//
	// This member is required.
	OutputSource CardOutputSource

	// The prompt or instructions displayed for the query card.
	//
	// This member is required.
	Prompt *string

	// The title or label of the query card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// The Amazon Q Business filters applied in this query card when resolving data
	// sources
	AttributeFilter *AttributeFilter
	// contains filtered or unexported fields
}

A card in a Amazon Q App that generates a response based on the Amazon Q Business service.

type QQueryCardInput 

type QQueryCardInput struct {

	// The unique identifier of the query card.
	//
	// This member is required.
	Id *string

	// The prompt or instructions displayed for the query card.
	//
	// This member is required.
	Prompt *string

	// The title or label of the query card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// Turns on filtering of responses based on document attributes or metadata fields.
	AttributeFilter *AttributeFilter

	// The source or type of output to generate for the query card.
	OutputSource CardOutputSource
	// contains filtered or unexported fields
}

The input shape for defining a query card in an Amazon Q App.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested resource could not be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type Sender 

type Sender string
const (
	SenderUser   Sender = "USER"
	SenderSystem Sender = "SYSTEM"
)

Enum values for Sender

func (Sender) Values 

func (Sender) Values() []Sender

Values returns all known values for Sender. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

The requested operation could not be completed because it would exceed the service's quota or limit.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type TextInputCard 

type TextInputCard struct {

	// Any dependencies or requirements for the text input card.
	//
	// This member is required.
	Dependencies []string

	// The unique identifier of the text input card.
	//
	// This member is required.
	Id *string

	// The title or label of the text input card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// The default value to pre-populate in the text input field.
	DefaultValue *string

	// The placeholder text to display in the text input field.
	Placeholder *string
	// contains filtered or unexported fields
}

A card in an Amazon Q App that allows the user to input text.

type TextInputCardInput 

type TextInputCardInput struct {

	// The unique identifier of the text input card.
	//
	// This member is required.
	Id *string

	// The title or label of the text input card.
	//
	// This member is required.
	Title *string

	// The type of the card.
	//
	// This member is required.
	Type CardType

	// The default value to pre-populate in the text input field.
	DefaultValue *string

	// The placeholder text to display in the text input field.
	Placeholder *string
	// contains filtered or unexported fields
}

The input shape for defining a text input card in an Amazon Q App.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnauthorizedException 

type UnauthorizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The client is not authenticated or authorized to perform the requested operation.

func (*UnauthorizedException) Error 

func (e *UnauthorizedException) Error() string

func (*UnauthorizedException) ErrorCode 

func (e *UnauthorizedException) ErrorCode() string

func (*UnauthorizedException) ErrorFault 

func (e *UnauthorizedException) ErrorFault() smithy.ErrorFault

func (*UnauthorizedException) ErrorMessage 

func (e *UnauthorizedException) ErrorMessage() string

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UserAppItem 

type UserAppItem struct {

	// The Amazon Resource Name (ARN) of the Q App.
	//
	// This member is required.
	AppArn *string

	// The unique identifier of the Q App.
	//
	// This member is required.
	AppId *string

	// The date and time the user's association with the Q App was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The title of the Q App.
	//
	// This member is required.
	Title *string

	// A flag indicating whether the user can edit the Q App.
	CanEdit *bool

	// The description of the Q App.
	Description *string

	// Indicates whether the Q App has been verified.
	IsVerified bool

	// The status of the user's association with the Q App.
	Status *string
	// contains filtered or unexported fields
}

An Amazon Q App associated with a user, either owned by the user or favorited.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input failed to satisfy the constraints specified by the service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

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.