qapps

package
v1.54.19 Latest Latest
Warning

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

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

Documentation

Overview

Package qapps provides the client and types for making API requests to QApps.

The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see Amazon Q App (https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/purpose-built-qapps.html) in the Amazon Q Business User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27 for more information on this service.

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

Using the Client

To contact QApps 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 QApps client QApps for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/qapps/#New

Index

Examples

Constants

View Source 
const (
	// AppRequiredCapabilityFileUpload is a AppRequiredCapability enum value
	AppRequiredCapabilityFileUpload = "FileUpload"

	// AppRequiredCapabilityCreatorMode is a AppRequiredCapability enum value
	AppRequiredCapabilityCreatorMode = "CreatorMode"

	// AppRequiredCapabilityRetrievalMode is a AppRequiredCapability enum value
	AppRequiredCapabilityRetrievalMode = "RetrievalMode"

	// AppRequiredCapabilityPluginMode is a AppRequiredCapability enum value
	AppRequiredCapabilityPluginMode = "PluginMode"
)
View Source 
const (
	// AppStatusPublished is a AppStatus enum value
	AppStatusPublished = "PUBLISHED"

	// AppStatusDraft is a AppStatus enum value
	AppStatusDraft = "DRAFT"

	// AppStatusDeleted is a AppStatus enum value
	AppStatusDeleted = "DELETED"
)
View Source 
const (
	// CardOutputSourceApprovedSources is a CardOutputSource enum value
	CardOutputSourceApprovedSources = "approved-sources"

	// CardOutputSourceLlm is a CardOutputSource enum value
	CardOutputSourceLlm = "llm"
)
View Source 
const (
	// CardTypeTextInput is a CardType enum value
	CardTypeTextInput = "text-input"

	// CardTypeQQuery is a CardType enum value
	CardTypeQQuery = "q-query"

	// CardTypeFileUpload is a CardType enum value
	CardTypeFileUpload = "file-upload"

	// CardTypeQPlugin is a CardType enum value
	CardTypeQPlugin = "q-plugin"
)
View Source 
const (
	// DocumentScopeApplication is a DocumentScope enum value
	DocumentScopeApplication = "APPLICATION"

	// DocumentScopeSession is a DocumentScope enum value
	DocumentScopeSession = "SESSION"
)
View Source 
const (
	// ExecutionStatusInProgress is a ExecutionStatus enum value
	ExecutionStatusInProgress = "IN_PROGRESS"

	// ExecutionStatusWaiting is a ExecutionStatus enum value
	ExecutionStatusWaiting = "WAITING"

	// ExecutionStatusCompleted is a ExecutionStatus enum value
	ExecutionStatusCompleted = "COMPLETED"
)
View Source 
const (
	// LibraryItemStatusPublished is a LibraryItemStatus enum value
	LibraryItemStatusPublished = "PUBLISHED"

	// LibraryItemStatusDisabled is a LibraryItemStatus enum value
	LibraryItemStatusDisabled = "DISABLED"
)
View Source 
const (
	// PluginTypeServiceNow is a PluginType enum value
	PluginTypeServiceNow = "SERVICE_NOW"

	// PluginTypeSalesforce is a PluginType enum value
	PluginTypeSalesforce = "SALESFORCE"

	// PluginTypeJira is a PluginType enum value
	PluginTypeJira = "JIRA"

	// PluginTypeZendesk is a PluginType enum value
	PluginTypeZendesk = "ZENDESK"

	// PluginTypeCustom is a PluginType enum value
	PluginTypeCustom = "CUSTOM"
)
View Source 
const (
	// SenderUser is a Sender enum value
	SenderUser = "USER"

	// SenderSystem is a Sender enum value
	SenderSystem = "SYSTEM"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// The client is not authorized to perform the requested operation.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The requested operation could not be completed due to a conflict with the
	// current state of the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeContentTooLargeException for service response error code
	// "ContentTooLargeException".
	//
	// The requested operation could not be completed because the content exceeds
	// the maximum allowed size.
	ErrCodeContentTooLargeException = "ContentTooLargeException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal service error occurred while processing the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The requested operation could not be completed because it would exceed the
	// service's quota or limit.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The requested operation could not be completed because too many requests
	// were sent at once. Wait a bit and try again later.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// The client is not authenticated or authorized to perform the requested operation.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input failed to satisfy the constraints specified by the service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "QApps"      // Name of service.
	EndpointsID = "data.qapps" // ID to lookup a service endpoint with.
	ServiceID   = "QApps"      // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AppRequiredCapability_Values 

func AppRequiredCapability_Values() []string

AppRequiredCapability_Values returns all elements of the AppRequiredCapability enum

func AppStatus_Values 

func AppStatus_Values() []string

AppStatus_Values returns all elements of the AppStatus enum

func CardOutputSource_Values 

func CardOutputSource_Values() []string

CardOutputSource_Values returns all elements of the CardOutputSource enum

func CardType_Values 

func CardType_Values() []string

CardType_Values returns all elements of the CardType enum

func DocumentScope_Values 

func DocumentScope_Values() []string

DocumentScope_Values returns all elements of the DocumentScope enum

func ExecutionStatus_Values 

func ExecutionStatus_Values() []string

ExecutionStatus_Values returns all elements of the ExecutionStatus enum

func LibraryItemStatus_Values 

func LibraryItemStatus_Values() []string

LibraryItemStatus_Values returns all elements of the LibraryItemStatus enum

func PluginType_Values 

func PluginType_Values() []string

PluginType_Values returns all elements of the PluginType enum

func Sender_Values 

func Sender_Values() []string

Sender_Values returns all elements of the Sender enum

Types

type AccessDeniedException 

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

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

The client is not authorized to perform the requested operation.

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 AppDefinition 

type AppDefinition struct {

	// The version of the app definition schema or specification.
	//
	// AppDefinitionVersion is a required field
	AppDefinitionVersion *string `locationName:"appDefinitionVersion" type:"string" required:"true"`

	// A flag indicating whether the Q App's definition can be edited by the user.
	CanEdit *bool `locationName:"canEdit" type:"boolean"`

	// The cards that make up the Q App, such as text input, file upload, or query
	// cards.
	//
	// Cards is a required field
	Cards []*Card `locationName:"cards" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (AppDefinition) GoString 

func (s AppDefinition) GoString() string

GoString returns the string representation.

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

func (*AppDefinition) SetAppDefinitionVersion 

func (s *AppDefinition) SetAppDefinitionVersion(v string) *AppDefinition

SetAppDefinitionVersion sets the AppDefinitionVersion field's value.

func (*AppDefinition) SetCanEdit 

func (s *AppDefinition) SetCanEdit(v bool) *AppDefinition

SetCanEdit sets the CanEdit field's value.

func (*AppDefinition) SetCards 

func (s *AppDefinition) SetCards(v []*Card) *AppDefinition

SetCards sets the Cards field's value.

func (AppDefinition) String 

func (s AppDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 AppDefinitionInput_ 

type AppDefinitionInput_ struct {

	// The cards that make up the Q App definition.
	//
	// Cards is a required field
	Cards []*CardInput_ `locationName:"cards" type:"list" required:"true"`

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string `locationName:"initialPrompt" type:"string"`
	// contains filtered or unexported fields
}

The input for defining an Q App.

func (AppDefinitionInput_) GoString 

func (s AppDefinitionInput_) GoString() string

GoString returns the string representation.

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

func (*AppDefinitionInput_) SetCards 

func (s *AppDefinitionInput_) SetCards(v []*CardInput_) *AppDefinitionInput_

SetCards sets the Cards field's value.

func (*AppDefinitionInput_) SetInitialPrompt 

func (s *AppDefinitionInput_) SetInitialPrompt(v string) *AppDefinitionInput_

SetInitialPrompt sets the InitialPrompt field's value.

func (AppDefinitionInput_) String 

func (s AppDefinitionInput_) String() string

String returns the string representation.

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

func (*AppDefinitionInput_) Validate 

func (s *AppDefinitionInput_) Validate() error

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

type AssociateLibraryItemReviewInput 

type AssociateLibraryItemReviewInput struct {

	// The unique identifier for the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the library item to associate the review with.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateLibraryItemReviewInput) GoString 

func (s AssociateLibraryItemReviewInput) GoString() string

GoString returns the string representation.

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

func (*AssociateLibraryItemReviewInput) SetInstanceId 

func (s *AssociateLibraryItemReviewInput) SetInstanceId(v string) *AssociateLibraryItemReviewInput

SetInstanceId sets the InstanceId field's value.

func (*AssociateLibraryItemReviewInput) SetLibraryItemId 

func (s *AssociateLibraryItemReviewInput) SetLibraryItemId(v string) *AssociateLibraryItemReviewInput

SetLibraryItemId sets the LibraryItemId field's value.

func (AssociateLibraryItemReviewInput) String 

func (s AssociateLibraryItemReviewInput) String() string

String returns the string representation.

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

func (*AssociateLibraryItemReviewInput) Validate 

func (s *AssociateLibraryItemReviewInput) Validate() error

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

type AssociateLibraryItemReviewOutput 

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

func (AssociateLibraryItemReviewOutput) GoString 

func (s AssociateLibraryItemReviewOutput) GoString() string

GoString returns the string representation.

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

func (AssociateLibraryItemReviewOutput) String 

func (s AssociateLibraryItemReviewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 AssociateQAppWithUserInput 

type AssociateQAppWithUserInput struct {

	// The ID of the Amazon Q App to associate with the user.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateQAppWithUserInput) GoString 

func (s AssociateQAppWithUserInput) GoString() string

GoString returns the string representation.

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

func (*AssociateQAppWithUserInput) SetAppId 

func (s *AssociateQAppWithUserInput) SetAppId(v string) *AssociateQAppWithUserInput

SetAppId sets the AppId field's value.

func (*AssociateQAppWithUserInput) SetInstanceId 

func (s *AssociateQAppWithUserInput) SetInstanceId(v string) *AssociateQAppWithUserInput

SetInstanceId sets the InstanceId field's value.

func (AssociateQAppWithUserInput) String 

func (s AssociateQAppWithUserInput) String() string

String returns the string representation.

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

func (*AssociateQAppWithUserInput) Validate 

func (s *AssociateQAppWithUserInput) Validate() error

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

type AssociateQAppWithUserOutput 

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

func (AssociateQAppWithUserOutput) GoString 

func (s AssociateQAppWithUserOutput) GoString() string

GoString returns the string representation.

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

func (AssociateQAppWithUserOutput) String 

func (s AssociateQAppWithUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 AttributeFilter 

type AttributeFilter struct {

	// Performs a logical AND operation on all supplied filters.
	AndAllFilters []*AttributeFilter `locationName:"andAllFilters" type:"list"`

	// Returns true when a document contains all the specified document attributes
	// or metadata fields. Supported for the following document attribute value
	// types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// stringListValue.
	ContainsAll *DocumentAttribute `locationName:"containsAll" type:"structure"`

	// Returns true when a document contains any of the specified document attributes
	// or metadata fields. Supported for the following document attribute value
	// types (https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html):
	// stringListValue.
	ContainsAny *DocumentAttribute `locationName:"containsAny" type:"structure"`

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

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

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

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

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

	// Performs a logical NOT operation on all supplied filters.
	NotFilter *AttributeFilter `locationName:"notFilter" type:"structure"`

	// Performs a logical OR operation on all supplied filters.
	OrAllFilters []*AttributeFilter `locationName:"orAllFilters" type:"list"`
	// contains filtered or unexported fields
}

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

func (AttributeFilter) GoString 

func (s AttributeFilter) GoString() string

GoString returns the string representation.

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

func (*AttributeFilter) SetAndAllFilters 

func (s *AttributeFilter) SetAndAllFilters(v []*AttributeFilter) *AttributeFilter

SetAndAllFilters sets the AndAllFilters field's value.

func (*AttributeFilter) SetContainsAll 

func (s *AttributeFilter) SetContainsAll(v *DocumentAttribute) *AttributeFilter

SetContainsAll sets the ContainsAll field's value.

func (*AttributeFilter) SetContainsAny 

func (s *AttributeFilter) SetContainsAny(v *DocumentAttribute) *AttributeFilter

SetContainsAny sets the ContainsAny field's value.

func (*AttributeFilter) SetEqualsTo 

func (s *AttributeFilter) SetEqualsTo(v *DocumentAttribute) *AttributeFilter

SetEqualsTo sets the EqualsTo field's value.

func (*AttributeFilter) SetGreaterThan 

func (s *AttributeFilter) SetGreaterThan(v *DocumentAttribute) *AttributeFilter

SetGreaterThan sets the GreaterThan field's value.

func (*AttributeFilter) SetGreaterThanOrEquals 

func (s *AttributeFilter) SetGreaterThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetGreaterThanOrEquals sets the GreaterThanOrEquals field's value.

func (*AttributeFilter) SetLessThan 

func (s *AttributeFilter) SetLessThan(v *DocumentAttribute) *AttributeFilter

SetLessThan sets the LessThan field's value.

func (*AttributeFilter) SetLessThanOrEquals 

func (s *AttributeFilter) SetLessThanOrEquals(v *DocumentAttribute) *AttributeFilter

SetLessThanOrEquals sets the LessThanOrEquals field's value.

func (*AttributeFilter) SetNotFilter 

func (s *AttributeFilter) SetNotFilter(v *AttributeFilter) *AttributeFilter

SetNotFilter sets the NotFilter field's value.

func (*AttributeFilter) SetOrAllFilters 

func (s *AttributeFilter) SetOrAllFilters(v []*AttributeFilter) *AttributeFilter

SetOrAllFilters sets the OrAllFilters field's value.

func (AttributeFilter) String 

func (s AttributeFilter) String() string

String returns the string representation.

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

func (*AttributeFilter) Validate 

func (s *AttributeFilter) Validate() error

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

type Card 

type Card struct {

	// A container for the properties of the file upload card.
	FileUpload *FileUploadCard `locationName:"fileUpload" type:"structure"`

	// A container for the properties of the plugin card.
	QPlugin *QPluginCard `locationName:"qPlugin" type:"structure"`

	// A container for the properties of the query card.
	QQuery *QQueryCard `locationName:"qQuery" type:"structure"`

	// A container for the properties of the text input card.
	TextInput *TextInputCard `locationName:"textInput" type:"structure"`
	// contains filtered or unexported fields
}

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

func (Card) GoString 

func (s Card) GoString() string

GoString returns the string representation.

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

func (*Card) SetFileUpload 

func (s *Card) SetFileUpload(v *FileUploadCard) *Card

SetFileUpload sets the FileUpload field's value.

func (*Card) SetQPlugin 

func (s *Card) SetQPlugin(v *QPluginCard) *Card

SetQPlugin sets the QPlugin field's value.

func (*Card) SetQQuery 

func (s *Card) SetQQuery(v *QQueryCard) *Card

SetQQuery sets the QQuery field's value.

func (*Card) SetTextInput 

func (s *Card) SetTextInput(v *TextInputCard) *Card

SetTextInput sets the TextInput field's value.

func (Card) String 

func (s Card) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 CardInput_ 

type CardInput_ struct {

	// A container for the properties of the file upload input card.
	FileUpload *FileUploadCardInput_ `locationName:"fileUpload" type:"structure"`

	// A container for the properties of the plugin input card.
	QPlugin *QPluginCardInput_ `locationName:"qPlugin" type:"structure"`

	// A container for the properties of the query input card.
	QQuery *QQueryCardInput_ `locationName:"qQuery" type:"structure"`

	// A container for the properties of the text input card.
	TextInput *TextInputCardInput_ `locationName:"textInput" type:"structure"`
	// contains filtered or unexported fields
}

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

func (CardInput_) GoString 

func (s CardInput_) GoString() string

GoString returns the string representation.

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

func (*CardInput_) SetFileUpload 

func (s *CardInput_) SetFileUpload(v *FileUploadCardInput_) *CardInput_

SetFileUpload sets the FileUpload field's value.

func (*CardInput_) SetQPlugin 

func (s *CardInput_) SetQPlugin(v *QPluginCardInput_) *CardInput_

SetQPlugin sets the QPlugin field's value.

func (*CardInput_) SetQQuery 

func (s *CardInput_) SetQQuery(v *QQueryCardInput_) *CardInput_

SetQQuery sets the QQuery field's value.

func (*CardInput_) SetTextInput 

func (s *CardInput_) SetTextInput(v *TextInputCardInput_) *CardInput_

SetTextInput sets the TextInput field's value.

func (CardInput_) String 

func (s CardInput_) String() string

String returns the string representation.

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

func (*CardInput_) Validate 

func (s *CardInput_) Validate() error

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

type CardStatus 

type CardStatus struct {

	// The current state of the card.
	//
	// CurrentState is a required field
	CurrentState *string `locationName:"currentState" type:"string" required:"true" enum:"ExecutionStatus"`

	// The current value or result associated with the card.
	//
	// CurrentValue is a required field
	CurrentValue *string `locationName:"currentValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CardStatus) GoString 

func (s CardStatus) GoString() string

GoString returns the string representation.

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

func (*CardStatus) SetCurrentState 

func (s *CardStatus) SetCurrentState(v string) *CardStatus

SetCurrentState sets the CurrentState field's value.

func (*CardStatus) SetCurrentValue 

func (s *CardStatus) SetCurrentValue(v string) *CardStatus

SetCurrentValue sets the CurrentValue field's value.

func (CardStatus) String 

func (s CardStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 CardValue 

type CardValue struct {

	// The unique identifier of the card.
	//
	// CardId is a required field
	CardId *string `locationName:"cardId" type:"string" required:"true"`

	// The value or result associated with the card.
	//
	// Value is a required field
	Value *string `locationName:"value" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (CardValue) GoString 

func (s CardValue) GoString() string

GoString returns the string representation.

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

func (*CardValue) SetCardId 

func (s *CardValue) SetCardId(v string) *CardValue

SetCardId sets the CardId field's value.

func (*CardValue) SetValue 

func (s *CardValue) SetValue(v string) *CardValue

SetValue sets the Value field's value.

func (CardValue) String 

func (s CardValue) String() string

String returns the string representation.

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

func (*CardValue) Validate 

func (s *CardValue) Validate() error

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

type Category 

type Category struct {

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

	// The title or name of the category.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Category) GoString 

func (s Category) GoString() string

GoString returns the string representation.

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

func (*Category) SetId 

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

SetId sets the Id field's value.

func (*Category) SetTitle 

func (s *Category) SetTitle(v string) *Category

SetTitle sets the Title field's value.

func (Category) String 

func (s Category) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ConflictException 

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

	Message_ *string `locationName:"message" type:"string"`

	// The unique identifier of the resource
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// 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) 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 ContentTooLargeException 

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

	Message_ *string `locationName:"message" type:"string"`

	// The unique identifier of the resource
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (*ContentTooLargeException) Code 

func (s *ContentTooLargeException) Code() string

Code returns the exception type name.

func (*ContentTooLargeException) Error 

func (s *ContentTooLargeException) Error() string

func (ContentTooLargeException) GoString 

func (s ContentTooLargeException) GoString() string

GoString returns the string representation.

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

func (*ContentTooLargeException) Message 

func (s *ContentTooLargeException) Message() string

Message returns the exception's message.

func (*ContentTooLargeException) OrigErr 

func (s *ContentTooLargeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ContentTooLargeException) RequestID 

func (s *ContentTooLargeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ContentTooLargeException) StatusCode 

func (s *ContentTooLargeException) StatusCode() int

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

func (ContentTooLargeException) String 

func (s ContentTooLargeException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ConversationMessage 

type ConversationMessage struct {

	// The text content of the conversation message.
	//
	// Body is a required field
	Body *string `locationName:"body" type:"string" required:"true"`

	// The type of the conversation message.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"Sender"`
	// contains filtered or unexported fields
}

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

func (ConversationMessage) GoString 

func (s ConversationMessage) GoString() string

GoString returns the string representation.

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

func (*ConversationMessage) SetBody 

func (s *ConversationMessage) SetBody(v string) *ConversationMessage

SetBody sets the Body field's value.

func (*ConversationMessage) SetType 

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

SetType sets the Type field's value.

func (ConversationMessage) String 

func (s ConversationMessage) String() string

String returns the string representation.

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

func (*ConversationMessage) Validate 

func (s *ConversationMessage) Validate() error

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

type CreateLibraryItemInput 

type CreateLibraryItemInput struct {

	// The unique identifier of the Amazon Q App to publish to the library.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Amazon Q App to publish to the library.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The categories to associate with the library item for easier discovery.
	//
	// Categories is a required field
	Categories []*string `locationName:"categories" type:"list" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLibraryItemInput) GoString 

func (s CreateLibraryItemInput) GoString() string

GoString returns the string representation.

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

func (*CreateLibraryItemInput) SetAppId 

func (s *CreateLibraryItemInput) SetAppId(v string) *CreateLibraryItemInput

SetAppId sets the AppId field's value.

func (*CreateLibraryItemInput) SetAppVersion 

func (s *CreateLibraryItemInput) SetAppVersion(v int64) *CreateLibraryItemInput

SetAppVersion sets the AppVersion field's value.

func (*CreateLibraryItemInput) SetCategories 

func (s *CreateLibraryItemInput) SetCategories(v []*string) *CreateLibraryItemInput

SetCategories sets the Categories field's value.

func (*CreateLibraryItemInput) SetInstanceId 

func (s *CreateLibraryItemInput) SetInstanceId(v string) *CreateLibraryItemInput

SetInstanceId sets the InstanceId field's value.

func (CreateLibraryItemInput) String 

func (s CreateLibraryItemInput) String() string

String returns the string representation.

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

func (*CreateLibraryItemInput) Validate 

func (s *CreateLibraryItemInput) Validate() error

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

type CreateLibraryItemOutput 

type CreateLibraryItemOutput struct {

	// The date and time the library item was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who created the library item.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// The unique identifier of the new library item.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`

	// The number of ratings the library item has received from users.
	//
	// RatingCount is a required field
	RatingCount *int64 `locationName:"ratingCount" type:"integer" required:"true"`

	// The status of the new library item, such as "Published".
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The date and time the library item was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The user who last updated the library item.
	UpdatedBy *string `locationName:"updatedBy" type:"string"`
	// contains filtered or unexported fields
}

func (CreateLibraryItemOutput) GoString 

func (s CreateLibraryItemOutput) GoString() string

GoString returns the string representation.

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

func (*CreateLibraryItemOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreateLibraryItemOutput) SetCreatedBy 

func (s *CreateLibraryItemOutput) SetCreatedBy(v string) *CreateLibraryItemOutput

SetCreatedBy sets the CreatedBy field's value.

func (*CreateLibraryItemOutput) SetLibraryItemId 

func (s *CreateLibraryItemOutput) SetLibraryItemId(v string) *CreateLibraryItemOutput

SetLibraryItemId sets the LibraryItemId field's value.

func (*CreateLibraryItemOutput) SetRatingCount 

func (s *CreateLibraryItemOutput) SetRatingCount(v int64) *CreateLibraryItemOutput

SetRatingCount sets the RatingCount field's value.

func (*CreateLibraryItemOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*CreateLibraryItemOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*CreateLibraryItemOutput) SetUpdatedBy 

func (s *CreateLibraryItemOutput) SetUpdatedBy(v string) *CreateLibraryItemOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (CreateLibraryItemOutput) String 

func (s CreateLibraryItemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 CreateQAppInput 

type CreateQAppInput struct {

	// The definition of the new Q App, specifying the cards and flow.
	//
	// AppDefinition is a required field
	AppDefinition *AppDefinitionInput_ `locationName:"appDefinition" type:"structure" required:"true"`

	// The description of the new Q App.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// Optional tags to associate with the new Q App.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The title of the new Q App.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQAppInput) GoString 

func (s CreateQAppInput) GoString() string

GoString returns the string representation.

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

func (*CreateQAppInput) SetAppDefinition 

func (s *CreateQAppInput) SetAppDefinition(v *AppDefinitionInput_) *CreateQAppInput

SetAppDefinition sets the AppDefinition field's value.

func (*CreateQAppInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateQAppInput) SetInstanceId 

func (s *CreateQAppInput) SetInstanceId(v string) *CreateQAppInput

SetInstanceId sets the InstanceId field's value.

func (*CreateQAppInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateQAppInput) SetTitle 

func (s *CreateQAppInput) SetTitle(v string) *CreateQAppInput

SetTitle sets the Title field's value.

func (CreateQAppInput) String 

func (s CreateQAppInput) String() string

String returns the string representation.

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

func (*CreateQAppInput) Validate 

func (s *CreateQAppInput) Validate() error

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

type CreateQAppOutput 

type CreateQAppOutput struct {

	// The Amazon Resource Name (ARN) of the new Q App.
	//
	// AppArn is a required field
	AppArn *string `locationName:"appArn" type:"string" required:"true"`

	// The unique identifier of the new Q App.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the new Q App.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The date and time the Q App was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who created the Q App.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// The description of the new Q App.
	Description *string `locationName:"description" type:"string"`

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string `locationName:"initialPrompt" type:"string"`

	// The capabilities required to run the Q App, such as file upload or third-party
	// integrations.
	RequiredCapabilities []*string `locationName:"requiredCapabilities" type:"list" enum:"AppRequiredCapability"`

	// The status of the new Q App, such as "Created".
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AppStatus"`

	// The title of the new Q App.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The date and time the Q App was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who last updated the Q App.
	//
	// UpdatedBy is a required field
	UpdatedBy *string `locationName:"updatedBy" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateQAppOutput) GoString 

func (s CreateQAppOutput) GoString() string

GoString returns the string representation.

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

func (*CreateQAppOutput) SetAppArn 

func (s *CreateQAppOutput) SetAppArn(v string) *CreateQAppOutput

SetAppArn sets the AppArn field's value.

func (*CreateQAppOutput) SetAppId 

func (s *CreateQAppOutput) SetAppId(v string) *CreateQAppOutput

SetAppId sets the AppId field's value.

func (*CreateQAppOutput) SetAppVersion 

func (s *CreateQAppOutput) SetAppVersion(v int64) *CreateQAppOutput

SetAppVersion sets the AppVersion field's value.

func (*CreateQAppOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*CreateQAppOutput) SetCreatedBy 

func (s *CreateQAppOutput) SetCreatedBy(v string) *CreateQAppOutput

SetCreatedBy sets the CreatedBy field's value.

func (*CreateQAppOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateQAppOutput) SetInitialPrompt 

func (s *CreateQAppOutput) SetInitialPrompt(v string) *CreateQAppOutput

SetInitialPrompt sets the InitialPrompt field's value.

func (*CreateQAppOutput) SetRequiredCapabilities 

func (s *CreateQAppOutput) SetRequiredCapabilities(v []*string) *CreateQAppOutput

SetRequiredCapabilities sets the RequiredCapabilities field's value.

func (*CreateQAppOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*CreateQAppOutput) SetTitle 

func (s *CreateQAppOutput) SetTitle(v string) *CreateQAppOutput

SetTitle sets the Title field's value.

func (*CreateQAppOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*CreateQAppOutput) SetUpdatedBy 

func (s *CreateQAppOutput) SetUpdatedBy(v string) *CreateQAppOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (CreateQAppOutput) String 

func (s CreateQAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DeleteLibraryItemInput 

type DeleteLibraryItemInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the library item to delete.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLibraryItemInput) GoString 

func (s DeleteLibraryItemInput) GoString() string

GoString returns the string representation.

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

func (*DeleteLibraryItemInput) SetInstanceId 

func (s *DeleteLibraryItemInput) SetInstanceId(v string) *DeleteLibraryItemInput

SetInstanceId sets the InstanceId field's value.

func (*DeleteLibraryItemInput) SetLibraryItemId 

func (s *DeleteLibraryItemInput) SetLibraryItemId(v string) *DeleteLibraryItemInput

SetLibraryItemId sets the LibraryItemId field's value.

func (DeleteLibraryItemInput) String 

func (s DeleteLibraryItemInput) String() string

String returns the string representation.

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

func (*DeleteLibraryItemInput) Validate 

func (s *DeleteLibraryItemInput) Validate() error

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

type DeleteLibraryItemOutput 

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

func (DeleteLibraryItemOutput) GoString 

func (s DeleteLibraryItemOutput) GoString() string

GoString returns the string representation.

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

func (DeleteLibraryItemOutput) String 

func (s DeleteLibraryItemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DeleteQAppInput 

type DeleteQAppInput struct {

	// The unique identifier of the Q App to delete.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteQAppInput) GoString 

func (s DeleteQAppInput) GoString() string

GoString returns the string representation.

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

func (*DeleteQAppInput) SetAppId 

func (s *DeleteQAppInput) SetAppId(v string) *DeleteQAppInput

SetAppId sets the AppId field's value.

func (*DeleteQAppInput) SetInstanceId 

func (s *DeleteQAppInput) SetInstanceId(v string) *DeleteQAppInput

SetInstanceId sets the InstanceId field's value.

func (DeleteQAppInput) String 

func (s DeleteQAppInput) String() string

String returns the string representation.

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

func (*DeleteQAppInput) Validate 

func (s *DeleteQAppInput) Validate() error

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

type DeleteQAppOutput 

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

func (DeleteQAppOutput) GoString 

func (s DeleteQAppOutput) GoString() string

GoString returns the string representation.

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

func (DeleteQAppOutput) String 

func (s DeleteQAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DisassociateLibraryItemReviewInput 

type DisassociateLibraryItemReviewInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the library item to remove the review from.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateLibraryItemReviewInput) GoString 

func (s DisassociateLibraryItemReviewInput) GoString() string

GoString returns the string representation.

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

func (*DisassociateLibraryItemReviewInput) SetInstanceId 

func (s *DisassociateLibraryItemReviewInput) SetInstanceId(v string) *DisassociateLibraryItemReviewInput

SetInstanceId sets the InstanceId field's value.

func (*DisassociateLibraryItemReviewInput) SetLibraryItemId 

func (s *DisassociateLibraryItemReviewInput) SetLibraryItemId(v string) *DisassociateLibraryItemReviewInput

SetLibraryItemId sets the LibraryItemId field's value.

func (DisassociateLibraryItemReviewInput) String 

func (s DisassociateLibraryItemReviewInput) String() string

String returns the string representation.

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

func (*DisassociateLibraryItemReviewInput) Validate 

func (s *DisassociateLibraryItemReviewInput) Validate() error

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

type DisassociateLibraryItemReviewOutput 

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

func (DisassociateLibraryItemReviewOutput) GoString 

func (s DisassociateLibraryItemReviewOutput) GoString() string

GoString returns the string representation.

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

func (DisassociateLibraryItemReviewOutput) String 

func (s DisassociateLibraryItemReviewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DisassociateQAppFromUserInput 

type DisassociateQAppFromUserInput struct {

	// The unique identifier of the Q App to disassociate from the user.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateQAppFromUserInput) GoString 

func (s DisassociateQAppFromUserInput) GoString() string

GoString returns the string representation.

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

func (*DisassociateQAppFromUserInput) SetAppId 

func (s *DisassociateQAppFromUserInput) SetAppId(v string) *DisassociateQAppFromUserInput

SetAppId sets the AppId field's value.

func (*DisassociateQAppFromUserInput) SetInstanceId 

func (s *DisassociateQAppFromUserInput) SetInstanceId(v string) *DisassociateQAppFromUserInput

SetInstanceId sets the InstanceId field's value.

func (DisassociateQAppFromUserInput) String 

func (s DisassociateQAppFromUserInput) String() string

String returns the string representation.

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

func (*DisassociateQAppFromUserInput) Validate 

func (s *DisassociateQAppFromUserInput) Validate() error

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

type DisassociateQAppFromUserOutput 

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

func (DisassociateQAppFromUserOutput) GoString 

func (s DisassociateQAppFromUserOutput) GoString() string

GoString returns the string representation.

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

func (DisassociateQAppFromUserOutput) String 

func (s DisassociateQAppFromUserOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 DocumentAttribute 

type DocumentAttribute struct {

	// The identifier for the attribute.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The value of the attribute.
	//
	// Value is a required field
	Value *DocumentAttributeValue `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A document attribute or metadata field.

func (DocumentAttribute) GoString 

func (s DocumentAttribute) GoString() string

GoString returns the string representation.

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

func (*DocumentAttribute) SetName 

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

SetName sets the Name field's value.

func (*DocumentAttribute) SetValue 

func (s *DocumentAttribute) SetValue(v *DocumentAttributeValue) *DocumentAttribute

SetValue sets the Value field's value.

func (DocumentAttribute) String 

func (s DocumentAttribute) String() string

String returns the string representation.

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

func (*DocumentAttribute) Validate 

func (s *DocumentAttribute) Validate() error

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

type DocumentAttributeValue 

type DocumentAttributeValue struct {

	// 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.
	DateValue *time.Time `locationName:"dateValue" type:"timestamp"`

	// A long integer value.
	LongValue *int64 `locationName:"longValue" type:"long"`

	// A list of strings.
	StringListValue []*string `locationName:"stringListValue" type:"list"`

	// A string.
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

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

func (DocumentAttributeValue) GoString 

func (s DocumentAttributeValue) GoString() string

GoString returns the string representation.

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

func (*DocumentAttributeValue) SetDateValue 

func (s *DocumentAttributeValue) SetDateValue(v time.Time) *DocumentAttributeValue

SetDateValue sets the DateValue field's value.

func (*DocumentAttributeValue) SetLongValue 

func (s *DocumentAttributeValue) SetLongValue(v int64) *DocumentAttributeValue

SetLongValue sets the LongValue field's value.

func (*DocumentAttributeValue) SetStringListValue 

func (s *DocumentAttributeValue) SetStringListValue(v []*string) *DocumentAttributeValue

SetStringListValue sets the StringListValue field's value.

func (*DocumentAttributeValue) SetStringValue 

func (s *DocumentAttributeValue) SetStringValue(v string) *DocumentAttributeValue

SetStringValue sets the StringValue field's value.

func (DocumentAttributeValue) String 

func (s DocumentAttributeValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 FileUploadCard 

type FileUploadCard struct {

	// A flag indicating if the user can override the default file for the upload
	// card.
	AllowOverride *bool `locationName:"allowOverride" type:"boolean"`

	// Any dependencies or requirements for the file upload card.
	//
	// Dependencies is a required field
	Dependencies []*string `locationName:"dependencies" type:"list" required:"true"`

	// The unique identifier of the file associated with the card.
	FileId *string `locationName:"fileId" type:"string"`

	// The name of the file being uploaded.
	Filename *string `locationName:"filename" type:"string"`

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

	// The title of the file upload card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (FileUploadCard) GoString 

func (s FileUploadCard) GoString() string

GoString returns the string representation.

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

func (*FileUploadCard) SetAllowOverride 

func (s *FileUploadCard) SetAllowOverride(v bool) *FileUploadCard

SetAllowOverride sets the AllowOverride field's value.

func (*FileUploadCard) SetDependencies 

func (s *FileUploadCard) SetDependencies(v []*string) *FileUploadCard

SetDependencies sets the Dependencies field's value.

func (*FileUploadCard) SetFileId 

func (s *FileUploadCard) SetFileId(v string) *FileUploadCard

SetFileId sets the FileId field's value.

func (*FileUploadCard) SetFilename 

func (s *FileUploadCard) SetFilename(v string) *FileUploadCard

SetFilename sets the Filename field's value.

func (*FileUploadCard) SetId 

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

SetId sets the Id field's value.

func (*FileUploadCard) SetTitle 

func (s *FileUploadCard) SetTitle(v string) *FileUploadCard

SetTitle sets the Title field's value.

func (*FileUploadCard) SetType 

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

SetType sets the Type field's value.

func (FileUploadCard) String 

func (s FileUploadCard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 FileUploadCardInput_ 

type FileUploadCardInput_ struct {

	// A flag indicating if the user can override the default file for the upload
	// card.
	AllowOverride *bool `locationName:"allowOverride" type:"boolean"`

	// The identifier of a pre-uploaded file associated with the card.
	FileId *string `locationName:"fileId" type:"string"`

	// The default filename to use for the file upload card.
	Filename *string `locationName:"filename" type:"string"`

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

	// The title or label of the file upload card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// 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.

func (FileUploadCardInput_) GoString 

func (s FileUploadCardInput_) GoString() string

GoString returns the string representation.

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

func (*FileUploadCardInput_) SetAllowOverride 

func (s *FileUploadCardInput_) SetAllowOverride(v bool) *FileUploadCardInput_

SetAllowOverride sets the AllowOverride field's value.

func (*FileUploadCardInput_) SetFileId 

func (s *FileUploadCardInput_) SetFileId(v string) *FileUploadCardInput_

SetFileId sets the FileId field's value.

func (*FileUploadCardInput_) SetFilename 

func (s *FileUploadCardInput_) SetFilename(v string) *FileUploadCardInput_

SetFilename sets the Filename field's value.

func (*FileUploadCardInput_) SetId 

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

SetId sets the Id field's value.

func (*FileUploadCardInput_) SetTitle 

func (s *FileUploadCardInput_) SetTitle(v string) *FileUploadCardInput_

SetTitle sets the Title field's value.

func (*FileUploadCardInput_) SetType 

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

SetType sets the Type field's value.

func (FileUploadCardInput_) String 

func (s FileUploadCardInput_) String() string

String returns the string representation.

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

func (*FileUploadCardInput_) Validate 

func (s *FileUploadCardInput_) Validate() error

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

type GetLibraryItemInput 

type GetLibraryItemInput struct {

	// The unique identifier of the Amazon Q App associated with the library item.
	AppId *string `location:"querystring" locationName:"appId" type:"string"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the library item to retrieve.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `location:"querystring" locationName:"libraryItemId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLibraryItemInput) GoString 

func (s GetLibraryItemInput) GoString() string

GoString returns the string representation.

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

func (*GetLibraryItemInput) SetAppId 

func (s *GetLibraryItemInput) SetAppId(v string) *GetLibraryItemInput

SetAppId sets the AppId field's value.

func (*GetLibraryItemInput) SetInstanceId 

func (s *GetLibraryItemInput) SetInstanceId(v string) *GetLibraryItemInput

SetInstanceId sets the InstanceId field's value.

func (*GetLibraryItemInput) SetLibraryItemId 

func (s *GetLibraryItemInput) SetLibraryItemId(v string) *GetLibraryItemInput

SetLibraryItemId sets the LibraryItemId field's value.

func (GetLibraryItemInput) String 

func (s GetLibraryItemInput) String() string

String returns the string representation.

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

func (*GetLibraryItemInput) Validate 

func (s *GetLibraryItemInput) Validate() error

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

type GetLibraryItemOutput 

type GetLibraryItemOutput struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Q App associated with the library item.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The categories associated with the library item for discovery.
	//
	// Categories is a required field
	Categories []*Category `locationName:"categories" type:"list" required:"true"`

	// The date and time the library item was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who created the library item.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// Whether the current user has rated the library item.
	IsRatedByUser *bool `locationName:"isRatedByUser" type:"boolean"`

	// The unique identifier of the library item.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`

	// The number of ratings the library item has received from users.
	//
	// RatingCount is a required field
	RatingCount *int64 `locationName:"ratingCount" type:"integer" required:"true"`

	// The status of the library item, such as "Published".
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The date and time the library item was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The user who last updated the library item.
	UpdatedBy *string `locationName:"updatedBy" type:"string"`

	// The number of users who have associated the Q App with their account.
	UserCount *int64 `locationName:"userCount" type:"integer"`
	// contains filtered or unexported fields
}

func (GetLibraryItemOutput) GoString 

func (s GetLibraryItemOutput) GoString() string

GoString returns the string representation.

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

func (*GetLibraryItemOutput) SetAppId 

func (s *GetLibraryItemOutput) SetAppId(v string) *GetLibraryItemOutput

SetAppId sets the AppId field's value.

func (*GetLibraryItemOutput) SetAppVersion 

func (s *GetLibraryItemOutput) SetAppVersion(v int64) *GetLibraryItemOutput

SetAppVersion sets the AppVersion field's value.

func (*GetLibraryItemOutput) SetCategories 

func (s *GetLibraryItemOutput) SetCategories(v []*Category) *GetLibraryItemOutput

SetCategories sets the Categories field's value.

func (*GetLibraryItemOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetLibraryItemOutput) SetCreatedBy 

func (s *GetLibraryItemOutput) SetCreatedBy(v string) *GetLibraryItemOutput

SetCreatedBy sets the CreatedBy field's value.

func (*GetLibraryItemOutput) SetIsRatedByUser 

func (s *GetLibraryItemOutput) SetIsRatedByUser(v bool) *GetLibraryItemOutput

SetIsRatedByUser sets the IsRatedByUser field's value.

func (*GetLibraryItemOutput) SetLibraryItemId 

func (s *GetLibraryItemOutput) SetLibraryItemId(v string) *GetLibraryItemOutput

SetLibraryItemId sets the LibraryItemId field's value.

func (*GetLibraryItemOutput) SetRatingCount 

func (s *GetLibraryItemOutput) SetRatingCount(v int64) *GetLibraryItemOutput

SetRatingCount sets the RatingCount field's value.

func (*GetLibraryItemOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetLibraryItemOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetLibraryItemOutput) SetUpdatedBy 

func (s *GetLibraryItemOutput) SetUpdatedBy(v string) *GetLibraryItemOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (*GetLibraryItemOutput) SetUserCount 

func (s *GetLibraryItemOutput) SetUserCount(v int64) *GetLibraryItemOutput

SetUserCount sets the UserCount field's value.

func (GetLibraryItemOutput) String 

func (s GetLibraryItemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 GetQAppInput 

type GetQAppInput struct {

	// The unique identifier of the Q App to retrieve.
	//
	// AppId is a required field
	AppId *string `location:"querystring" locationName:"appId" type:"string" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQAppInput) GoString 

func (s GetQAppInput) GoString() string

GoString returns the string representation.

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

func (*GetQAppInput) SetAppId 

func (s *GetQAppInput) SetAppId(v string) *GetQAppInput

SetAppId sets the AppId field's value.

func (*GetQAppInput) SetInstanceId 

func (s *GetQAppInput) SetInstanceId(v string) *GetQAppInput

SetInstanceId sets the InstanceId field's value.

func (GetQAppInput) String 

func (s GetQAppInput) String() string

String returns the string representation.

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

func (*GetQAppInput) Validate 

func (s *GetQAppInput) Validate() error

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

type GetQAppOutput 

type GetQAppOutput struct {

	// The Amazon Resource Name (ARN) of the Q App.
	//
	// AppArn is a required field
	AppArn *string `locationName:"appArn" type:"string" required:"true"`

	// The full definition of the Q App, specifying the cards and flow.
	//
	// AppDefinition is a required field
	AppDefinition *AppDefinition `locationName:"appDefinition" type:"structure" required:"true"`

	// The unique identifier of the Q App.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Q App.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The date and time the Q App was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who created the Q App.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// The description of the Q App.
	Description *string `locationName:"description" type:"string"`

	// The initial prompt displayed when the Q App is started.
	InitialPrompt *string `locationName:"initialPrompt" type:"string"`

	// The capabilities required to run the Q App, such as file upload or third-party
	// integrations.
	RequiredCapabilities []*string `locationName:"requiredCapabilities" type:"list" enum:"AppRequiredCapability"`

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

	// The title of the Q App.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The date and time the Q App was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who last updated the Q App.
	//
	// UpdatedBy is a required field
	UpdatedBy *string `locationName:"updatedBy" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQAppOutput) GoString 

func (s GetQAppOutput) GoString() string

GoString returns the string representation.

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

func (*GetQAppOutput) SetAppArn 

func (s *GetQAppOutput) SetAppArn(v string) *GetQAppOutput

SetAppArn sets the AppArn field's value.

func (*GetQAppOutput) SetAppDefinition 

func (s *GetQAppOutput) SetAppDefinition(v *AppDefinition) *GetQAppOutput

SetAppDefinition sets the AppDefinition field's value.

func (*GetQAppOutput) SetAppId 

func (s *GetQAppOutput) SetAppId(v string) *GetQAppOutput

SetAppId sets the AppId field's value.

func (*GetQAppOutput) SetAppVersion 

func (s *GetQAppOutput) SetAppVersion(v int64) *GetQAppOutput

SetAppVersion sets the AppVersion field's value.

func (*GetQAppOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*GetQAppOutput) SetCreatedBy 

func (s *GetQAppOutput) SetCreatedBy(v string) *GetQAppOutput

SetCreatedBy sets the CreatedBy field's value.

func (*GetQAppOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*GetQAppOutput) SetInitialPrompt 

func (s *GetQAppOutput) SetInitialPrompt(v string) *GetQAppOutput

SetInitialPrompt sets the InitialPrompt field's value.

func (*GetQAppOutput) SetRequiredCapabilities 

func (s *GetQAppOutput) SetRequiredCapabilities(v []*string) *GetQAppOutput

SetRequiredCapabilities sets the RequiredCapabilities field's value.

func (*GetQAppOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*GetQAppOutput) SetTitle 

func (s *GetQAppOutput) SetTitle(v string) *GetQAppOutput

SetTitle sets the Title field's value.

func (*GetQAppOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*GetQAppOutput) SetUpdatedBy 

func (s *GetQAppOutput) SetUpdatedBy(v string) *GetQAppOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (GetQAppOutput) String 

func (s GetQAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 GetQAppSessionInput 

type GetQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the Q App session to retrieve.
	//
	// SessionId is a required field
	SessionId *string `location:"querystring" locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetQAppSessionInput) GoString 

func (s GetQAppSessionInput) GoString() string

GoString returns the string representation.

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

func (*GetQAppSessionInput) SetInstanceId 

func (s *GetQAppSessionInput) SetInstanceId(v string) *GetQAppSessionInput

SetInstanceId sets the InstanceId field's value.

func (*GetQAppSessionInput) SetSessionId 

func (s *GetQAppSessionInput) SetSessionId(v string) *GetQAppSessionInput

SetSessionId sets the SessionId field's value.

func (GetQAppSessionInput) String 

func (s GetQAppSessionInput) String() string

String returns the string representation.

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

func (*GetQAppSessionInput) Validate 

func (s *GetQAppSessionInput) Validate() error

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

type GetQAppSessionOutput 

type GetQAppSessionOutput struct {

	// The current status for each card in the Q App session.
	//
	// CardStatus is a required field
	CardStatus map[string]*CardStatus `locationName:"cardStatus" type:"map" required:"true"`

	// The Amazon Resource Name (ARN) of the Q App session.
	//
	// SessionArn is a required field
	SessionArn *string `locationName:"sessionArn" type:"string" required:"true"`

	// The unique identifier of the Q App session.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`

	// The current status of the Q App session.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"ExecutionStatus"`
	// contains filtered or unexported fields
}

func (GetQAppSessionOutput) GoString 

func (s GetQAppSessionOutput) GoString() string

GoString returns the string representation.

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

func (*GetQAppSessionOutput) SetCardStatus 

func (s *GetQAppSessionOutput) SetCardStatus(v map[string]*CardStatus) *GetQAppSessionOutput

SetCardStatus sets the CardStatus field's value.

func (*GetQAppSessionOutput) SetSessionArn 

func (s *GetQAppSessionOutput) SetSessionArn(v string) *GetQAppSessionOutput

SetSessionArn sets the SessionArn field's value.

func (*GetQAppSessionOutput) SetSessionId 

func (s *GetQAppSessionOutput) SetSessionId(v string) *GetQAppSessionOutput

SetSessionId sets the SessionId field's value.

func (*GetQAppSessionOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (GetQAppSessionOutput) String 

func (s GetQAppSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ImportDocumentInput 

type ImportDocumentInput struct {

	// The unique identifier of the Q App the file is associated with.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The unique identifier of the card the file is associated with, if applicable.
	//
	// CardId is a required field
	CardId *string `locationName:"cardId" type:"string" required:"true"`

	// The base64-encoded contents of the file to upload.
	//
	// FileContentsBase64 is a required field
	FileContentsBase64 *string `locationName:"fileContentsBase64" type:"string" required:"true"`

	// The name of the file being uploaded.
	//
	// FileName is a required field
	FileName *string `locationName:"fileName" type:"string" required:"true"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// Whether the file is associated with an Q App definition or a specific Q App
	// session.
	//
	// Scope is a required field
	Scope *string `locationName:"scope" type:"string" required:"true" enum:"DocumentScope"`

	// The unique identifier of the Q App session the file is associated with, if
	// applicable.
	SessionId *string `locationName:"sessionId" type:"string"`
	// contains filtered or unexported fields
}

func (ImportDocumentInput) GoString 

func (s ImportDocumentInput) GoString() string

GoString returns the string representation.

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

func (*ImportDocumentInput) SetAppId 

func (s *ImportDocumentInput) SetAppId(v string) *ImportDocumentInput

SetAppId sets the AppId field's value.

func (*ImportDocumentInput) SetCardId 

func (s *ImportDocumentInput) SetCardId(v string) *ImportDocumentInput

SetCardId sets the CardId field's value.

func (*ImportDocumentInput) SetFileContentsBase64 

func (s *ImportDocumentInput) SetFileContentsBase64(v string) *ImportDocumentInput

SetFileContentsBase64 sets the FileContentsBase64 field's value.

func (*ImportDocumentInput) SetFileName 

func (s *ImportDocumentInput) SetFileName(v string) *ImportDocumentInput

SetFileName sets the FileName field's value.

func (*ImportDocumentInput) SetInstanceId 

func (s *ImportDocumentInput) SetInstanceId(v string) *ImportDocumentInput

SetInstanceId sets the InstanceId field's value.

func (*ImportDocumentInput) SetScope 

func (s *ImportDocumentInput) SetScope(v string) *ImportDocumentInput

SetScope sets the Scope field's value.

func (*ImportDocumentInput) SetSessionId 

func (s *ImportDocumentInput) SetSessionId(v string) *ImportDocumentInput

SetSessionId sets the SessionId field's value.

func (ImportDocumentInput) String 

func (s ImportDocumentInput) String() string

String returns the string representation.

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

func (*ImportDocumentInput) Validate 

func (s *ImportDocumentInput) Validate() error

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

type ImportDocumentOutput 

type ImportDocumentOutput struct {

	// The unique identifier assigned to the uploaded file.
	FileId *string `locationName:"fileId" type:"string"`
	// contains filtered or unexported fields
}

func (ImportDocumentOutput) GoString 

func (s ImportDocumentOutput) GoString() string

GoString returns the string representation.

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

func (*ImportDocumentOutput) SetFileId 

func (s *ImportDocumentOutput) SetFileId(v string) *ImportDocumentOutput

SetFileId sets the FileId field's value.

func (ImportDocumentOutput) String 

func (s ImportDocumentOutput) String() string

String returns the string representation.

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

type InternalServerException 

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

	Message_ *string `locationName:"message" type:"string"`

	// The number of seconds to wait before retrying the operation
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

An internal service error occurred while processing the 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 LibraryItemMember 

type LibraryItemMember struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Q App associated with the library item.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The categories associated with the library item.
	//
	// Categories is a required field
	Categories []*Category `locationName:"categories" type:"list" required:"true"`

	// The date and time the library item was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who created the library item.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// Whether the current user has rated the library item.
	IsRatedByUser *bool `locationName:"isRatedByUser" type:"boolean"`

	// The unique identifier of the library item.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`

	// The number of ratings the library item has received.
	//
	// RatingCount is a required field
	RatingCount *int64 `locationName:"ratingCount" type:"integer" required:"true"`

	// The status of the library item.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The date and time the library item was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The user who last updated the library item.
	UpdatedBy *string `locationName:"updatedBy" type:"string"`

	// The number of users who have the associated Q App.
	UserCount *int64 `locationName:"userCount" type:"integer"`
	// 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.

func (LibraryItemMember) GoString 

func (s LibraryItemMember) GoString() string

GoString returns the string representation.

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

func (*LibraryItemMember) SetAppId 

func (s *LibraryItemMember) SetAppId(v string) *LibraryItemMember

SetAppId sets the AppId field's value.

func (*LibraryItemMember) SetAppVersion 

func (s *LibraryItemMember) SetAppVersion(v int64) *LibraryItemMember

SetAppVersion sets the AppVersion field's value.

func (*LibraryItemMember) SetCategories 

func (s *LibraryItemMember) SetCategories(v []*Category) *LibraryItemMember

SetCategories sets the Categories field's value.

func (*LibraryItemMember) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*LibraryItemMember) SetCreatedBy 

func (s *LibraryItemMember) SetCreatedBy(v string) *LibraryItemMember

SetCreatedBy sets the CreatedBy field's value.

func (*LibraryItemMember) SetIsRatedByUser 

func (s *LibraryItemMember) SetIsRatedByUser(v bool) *LibraryItemMember

SetIsRatedByUser sets the IsRatedByUser field's value.

func (*LibraryItemMember) SetLibraryItemId 

func (s *LibraryItemMember) SetLibraryItemId(v string) *LibraryItemMember

SetLibraryItemId sets the LibraryItemId field's value.

func (*LibraryItemMember) SetRatingCount 

func (s *LibraryItemMember) SetRatingCount(v int64) *LibraryItemMember

SetRatingCount sets the RatingCount field's value.

func (*LibraryItemMember) SetStatus 

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

SetStatus sets the Status field's value.

func (*LibraryItemMember) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*LibraryItemMember) SetUpdatedBy 

func (s *LibraryItemMember) SetUpdatedBy(v string) *LibraryItemMember

SetUpdatedBy sets the UpdatedBy field's value.

func (*LibraryItemMember) SetUserCount 

func (s *LibraryItemMember) SetUserCount(v int64) *LibraryItemMember

SetUserCount sets the UserCount field's value.

func (LibraryItemMember) String 

func (s LibraryItemMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListLibraryItemsInput 

type ListLibraryItemsInput struct {

	// Optional category to filter the library items by.
	CategoryId *string `location:"querystring" locationName:"categoryId" type:"string"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The maximum number of library items to return in the response.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListLibraryItemsInput) GoString 

func (s ListLibraryItemsInput) GoString() string

GoString returns the string representation.

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

func (*ListLibraryItemsInput) SetCategoryId 

func (s *ListLibraryItemsInput) SetCategoryId(v string) *ListLibraryItemsInput

SetCategoryId sets the CategoryId field's value.

func (*ListLibraryItemsInput) SetInstanceId 

func (s *ListLibraryItemsInput) SetInstanceId(v string) *ListLibraryItemsInput

SetInstanceId sets the InstanceId field's value.

func (*ListLibraryItemsInput) SetLimit 

func (s *ListLibraryItemsInput) SetLimit(v int64) *ListLibraryItemsInput

SetLimit sets the Limit field's value.

func (*ListLibraryItemsInput) SetNextToken 

func (s *ListLibraryItemsInput) SetNextToken(v string) *ListLibraryItemsInput

SetNextToken sets the NextToken field's value.

func (ListLibraryItemsInput) String 

func (s ListLibraryItemsInput) String() string

String returns the string representation.

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

func (*ListLibraryItemsInput) Validate 

func (s *ListLibraryItemsInput) Validate() error

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

type ListLibraryItemsOutput 

type ListLibraryItemsOutput struct {

	// The list of library items meeting the request criteria.
	LibraryItems []*LibraryItemMember `locationName:"libraryItems" type:"list"`

	// The token to use to request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListLibraryItemsOutput) GoString 

func (s ListLibraryItemsOutput) GoString() string

GoString returns the string representation.

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

func (*ListLibraryItemsOutput) SetLibraryItems 

func (s *ListLibraryItemsOutput) SetLibraryItems(v []*LibraryItemMember) *ListLibraryItemsOutput

SetLibraryItems sets the LibraryItems field's value.

func (*ListLibraryItemsOutput) SetNextToken 

func (s *ListLibraryItemsOutput) SetNextToken(v string) *ListLibraryItemsOutput

SetNextToken sets the NextToken field's value.

func (ListLibraryItemsOutput) String 

func (s ListLibraryItemsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 ListQAppsInput 

type ListQAppsInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The maximum number of Q Apps to return in the response.
	Limit *int64 `location:"querystring" locationName:"limit" min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListQAppsInput) GoString 

func (s ListQAppsInput) GoString() string

GoString returns the string representation.

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

func (*ListQAppsInput) SetInstanceId 

func (s *ListQAppsInput) SetInstanceId(v string) *ListQAppsInput

SetInstanceId sets the InstanceId field's value.

func (*ListQAppsInput) SetLimit 

func (s *ListQAppsInput) SetLimit(v int64) *ListQAppsInput

SetLimit sets the Limit field's value.

func (*ListQAppsInput) SetNextToken 

func (s *ListQAppsInput) SetNextToken(v string) *ListQAppsInput

SetNextToken sets the NextToken field's value.

func (ListQAppsInput) String 

func (s ListQAppsInput) String() string

String returns the string representation.

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

func (*ListQAppsInput) Validate 

func (s *ListQAppsInput) Validate() error

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

type ListQAppsOutput 

type ListQAppsOutput struct {

	// The list of Amazon Q Apps meeting the request criteria.
	//
	// Apps is a required field
	Apps []*UserAppItem `locationName:"apps" type:"list" required:"true"`

	// The token to use to request the next page of results.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListQAppsOutput) GoString 

func (s ListQAppsOutput) GoString() string

GoString returns the string representation.

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

func (*ListQAppsOutput) SetApps 

func (s *ListQAppsOutput) SetApps(v []*UserAppItem) *ListQAppsOutput

SetApps sets the Apps field's value.

func (*ListQAppsOutput) SetNextToken 

func (s *ListQAppsOutput) SetNextToken(v string) *ListQAppsOutput

SetNextToken sets the NextToken field's value.

func (ListQAppsOutput) String 

func (s ListQAppsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 whose tags should be listed.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" 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 list of tags that are assigned to 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 PredictAppDefinition 

type PredictAppDefinition struct {

	// The definition specifying the cards and flow of the generated Q App.
	//
	// AppDefinition is a required field
	AppDefinition *AppDefinitionInput_ `locationName:"appDefinition" type:"structure" required:"true"`

	// The description of the generated Q App definition.
	Description *string `locationName:"description" type:"string"`

	// The title of the generated Q App definition.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (PredictAppDefinition) GoString 

func (s PredictAppDefinition) GoString() string

GoString returns the string representation.

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

func (*PredictAppDefinition) SetAppDefinition 

func (s *PredictAppDefinition) SetAppDefinition(v *AppDefinitionInput_) *PredictAppDefinition

SetAppDefinition sets the AppDefinition field's value.

func (*PredictAppDefinition) SetDescription 

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

SetDescription sets the Description field's value.

func (*PredictAppDefinition) SetTitle 

func (s *PredictAppDefinition) SetTitle(v string) *PredictAppDefinition

SetTitle sets the Title field's value.

func (PredictAppDefinition) String 

func (s PredictAppDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 PredictQAppInput 

type PredictQAppInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The input to generate the Q App definition from, either a conversation or
	// problem statement.
	Options *PredictQAppInputOptions `locationName:"options" type:"structure"`
	// contains filtered or unexported fields
}

func (PredictQAppInput) GoString 

func (s PredictQAppInput) GoString() string

GoString returns the string representation.

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

func (*PredictQAppInput) SetInstanceId 

func (s *PredictQAppInput) SetInstanceId(v string) *PredictQAppInput

SetInstanceId sets the InstanceId field's value.

func (*PredictQAppInput) SetOptions 

func (s *PredictQAppInput) SetOptions(v *PredictQAppInputOptions) *PredictQAppInput

SetOptions sets the Options field's value.

func (PredictQAppInput) String 

func (s PredictQAppInput) String() string

String returns the string representation.

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

func (*PredictQAppInput) Validate 

func (s *PredictQAppInput) Validate() error

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

type PredictQAppInputOptions 

type PredictQAppInputOptions struct {

	// A conversation to use as input for generating the Q App definition.
	Conversation []*ConversationMessage `locationName:"conversation" min:"1" type:"list"`

	// A problem statement to use as input for generating the Q App definition.
	ProblemStatement *string `locationName:"problemStatement" type:"string"`
	// contains filtered or unexported fields
}

The input options for generating an Q App definition.

func (PredictQAppInputOptions) GoString 

func (s PredictQAppInputOptions) GoString() string

GoString returns the string representation.

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

func (*PredictQAppInputOptions) SetConversation 

func (s *PredictQAppInputOptions) SetConversation(v []*ConversationMessage) *PredictQAppInputOptions

SetConversation sets the Conversation field's value.

func (*PredictQAppInputOptions) SetProblemStatement 

func (s *PredictQAppInputOptions) SetProblemStatement(v string) *PredictQAppInputOptions

SetProblemStatement sets the ProblemStatement field's value.

func (PredictQAppInputOptions) String 

func (s PredictQAppInputOptions) String() string

String returns the string representation.

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

func (*PredictQAppInputOptions) Validate 

func (s *PredictQAppInputOptions) Validate() error

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

type PredictQAppOutput 

type PredictQAppOutput struct {

	// The generated Q App definition.
	//
	// App is a required field
	App *PredictAppDefinition `locationName:"app" type:"structure" required:"true"`

	// The problem statement extracted from the input conversation, if provided.
	//
	// ProblemStatement is a required field
	ProblemStatement *string `locationName:"problemStatement" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PredictQAppOutput) GoString 

func (s PredictQAppOutput) GoString() string

GoString returns the string representation.

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

func (*PredictQAppOutput) SetApp 

func (s *PredictQAppOutput) SetApp(v *PredictAppDefinition) *PredictQAppOutput

SetApp sets the App field's value.

func (*PredictQAppOutput) SetProblemStatement 

func (s *PredictQAppOutput) SetProblemStatement(v string) *PredictQAppOutput

SetProblemStatement sets the ProblemStatement field's value.

func (PredictQAppOutput) String 

func (s PredictQAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 QApps 

type QApps struct {
	*client.Client
}

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

QApps 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) *QApps

New creates a new instance of the QApps 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 QApps client from just a session.
svc := qapps.New(mySession)

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

func (*QApps) AssociateLibraryItemReview 

func (c *QApps) AssociateLibraryItemReview(input *AssociateLibraryItemReviewInput) (*AssociateLibraryItemReviewOutput, error)

AssociateLibraryItemReview API operation for QApps.

Associates a rating or review for a library item with the user submitting the request. This increments the rating count for the specified library item.

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 QApps's API operation AssociateLibraryItemReview for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/AssociateLibraryItemReview

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.AssociateLibraryItemReviewInput{
		InstanceId:    aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		LibraryItemId: aws.String("cb9ecf72-8563-450d-9db9-994f98297316"),
	}

	result, err := svc.AssociateLibraryItemReview(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) AssociateLibraryItemReviewRequest 

func (c *QApps) AssociateLibraryItemReviewRequest(input *AssociateLibraryItemReviewInput) (req *request.Request, output *AssociateLibraryItemReviewOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/AssociateLibraryItemReview

func (*QApps) AssociateLibraryItemReviewWithContext 

func (c *QApps) AssociateLibraryItemReviewWithContext(ctx aws.Context, input *AssociateLibraryItemReviewInput, opts ...request.Option) (*AssociateLibraryItemReviewOutput, error)

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

See AssociateLibraryItemReview 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 (*QApps) AssociateQAppWithUser 

func (c *QApps) AssociateQAppWithUser(input *AssociateQAppWithUserInput) (*AssociateQAppWithUserOutput, error)

AssociateQAppWithUser API operation for QApps.

This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a favorite for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.

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 QApps's API operation AssociateQAppWithUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/AssociateQAppWithUser

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.AssociateQAppWithUserInput{
		AppId:      aws.String("393e77fb-0a30-4f47-ad30-75d71aeaed8a"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.AssociateQAppWithUser(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) AssociateQAppWithUserRequest 

func (c *QApps) AssociateQAppWithUserRequest(input *AssociateQAppWithUserInput) (req *request.Request, output *AssociateQAppWithUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/AssociateQAppWithUser

func (*QApps) AssociateQAppWithUserWithContext 

func (c *QApps) AssociateQAppWithUserWithContext(ctx aws.Context, input *AssociateQAppWithUserInput, opts ...request.Option) (*AssociateQAppWithUserOutput, error)

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

See AssociateQAppWithUser 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 (*QApps) CreateLibraryItem 

func (c *QApps) CreateLibraryItem(input *CreateLibraryItemInput) (*CreateLibraryItemOutput, error)

CreateLibraryItem API operation for QApps.

Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.

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 QApps's API operation CreateLibraryItem for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreateLibraryItem

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.CreateLibraryItemInput{
		AppId:      aws.String("7a11f34b-42d4-4bc8-b668-ae4a788dae1e"),
		AppVersion: aws.Int64(6),
		Categories: []*string{
			aws.String("9c871ed4-1c41-4065-aefe-321cd4b61cf8"),
		},
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.CreateLibraryItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) CreateLibraryItemRequest 

func (c *QApps) CreateLibraryItemRequest(input *CreateLibraryItemInput) (req *request.Request, output *CreateLibraryItemOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreateLibraryItem

func (*QApps) CreateLibraryItemWithContext 

func (c *QApps) CreateLibraryItemWithContext(ctx aws.Context, input *CreateLibraryItemInput, opts ...request.Option) (*CreateLibraryItemOutput, error)

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

See CreateLibraryItem 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 (*QApps) CreateQApp 

func (c *QApps) CreateQApp(input *CreateQAppInput) (*CreateQAppOutput, error)

CreateQApp API operation for QApps.

Creates a new Amazon Q App based on the provided definition. The Q App definition specifies the cards and flow of the Q App. This operation also calculates the dependencies between the cards by inspecting the references in the prompts.

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 QApps's API operation CreateQApp for usage and error information.

Returned Error Types:

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreateQApp

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.CreateQAppInput{
		AppDefinition: &qapps.AppDefinitionInput_{
			Cards: []*qapps.CardInput_{
				{
					TextInput: &qapps.TextInputCardInput_{
						Id:    aws.String("4cf94d96-8819-45c2-98cc-58c56b35c72f"),
						Title: aws.String("Color Base"),
						Type:  aws.String("text-input"),
					},
				},
				{
					QQuery: &qapps.QQueryCardInput_{
						Id:     aws.String("18870b94-1e63-40e0-8c12-669c90ac5acc"),
						Prompt: aws.String("Recommend me a list of colors that go well with @4cf94d96-8819-45c2-98cc-58c56b35c72f"),
						Title:  aws.String("Recommended Palette"),
						Type:   aws.String("q-query"),
					},
				},
			},
			InitialPrompt: aws.String("Create an app that recommend a list of colors based on input."),
		},
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Title:      aws.String("Color Palette Generator"),
	}

	result, err := svc.CreateQApp(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeConflictException:
				fmt.Println(qapps.ErrCodeConflictException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeContentTooLargeException:
				fmt.Println(qapps.ErrCodeContentTooLargeException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) CreateQAppRequest 

func (c *QApps) CreateQAppRequest(input *CreateQAppInput) (req *request.Request, output *CreateQAppOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreateQApp

func (*QApps) CreateQAppWithContext 

func (c *QApps) CreateQAppWithContext(ctx aws.Context, input *CreateQAppInput, opts ...request.Option) (*CreateQAppOutput, error)

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

See CreateQApp 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 (*QApps) DeleteLibraryItem 

func (c *QApps) DeleteLibraryItem(input *DeleteLibraryItemInput) (*DeleteLibraryItemOutput, error)

DeleteLibraryItem API operation for QApps.

Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users.

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 QApps's API operation DeleteLibraryItem for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DeleteLibraryItem

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.DeleteLibraryItemInput{
		InstanceId:    aws.String("3642ba81-344c-42fd-a480-9119a5a5f26b"),
		LibraryItemId: aws.String("72088fd4-78b6-43da-bfb8-8621323c3cfb"),
	}

	result, err := svc.DeleteLibraryItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) DeleteLibraryItemRequest 

func (c *QApps) DeleteLibraryItemRequest(input *DeleteLibraryItemInput) (req *request.Request, output *DeleteLibraryItemOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DeleteLibraryItem

func (*QApps) DeleteLibraryItemWithContext 

func (c *QApps) DeleteLibraryItemWithContext(ctx aws.Context, input *DeleteLibraryItemInput, opts ...request.Option) (*DeleteLibraryItemOutput, error)

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

See DeleteLibraryItem 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 (*QApps) DeleteQApp 

func (c *QApps) DeleteQApp(input *DeleteQAppInput) (*DeleteQAppOutput, error)

DeleteQApp API operation for QApps.

Deletes an Amazon Q App owned by the user. If the Q App was previously published to the library, it is also removed from the library.

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 QApps's API operation DeleteQApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DeleteQApp

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.DeleteQAppInput{
		AppId:      aws.String("393e77fb-0a30-4f47-ad30-75d71aeaed8a"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.DeleteQApp(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) DeleteQAppRequest 

func (c *QApps) DeleteQAppRequest(input *DeleteQAppInput) (req *request.Request, output *DeleteQAppOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DeleteQApp

func (*QApps) DeleteQAppWithContext 

func (c *QApps) DeleteQAppWithContext(ctx aws.Context, input *DeleteQAppInput, opts ...request.Option) (*DeleteQAppOutput, error)

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

See DeleteQApp 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 (*QApps) DisassociateLibraryItemReview 

func (c *QApps) DisassociateLibraryItemReview(input *DisassociateLibraryItemReviewInput) (*DisassociateLibraryItemReviewOutput, error)

DisassociateLibraryItemReview API operation for QApps.

Removes a rating or review previously submitted by the user for a library item.

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 QApps's API operation DisassociateLibraryItemReview for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DisassociateLibraryItemReview

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.DisassociateLibraryItemReviewInput{
		InstanceId:    aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		LibraryItemId: aws.String("cb9ecf72-8563-450d-9db9-994f98297316"),
	}

	result, err := svc.DisassociateLibraryItemReview(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) DisassociateLibraryItemReviewRequest 

func (c *QApps) DisassociateLibraryItemReviewRequest(input *DisassociateLibraryItemReviewInput) (req *request.Request, output *DisassociateLibraryItemReviewOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DisassociateLibraryItemReview

func (*QApps) DisassociateLibraryItemReviewWithContext 

func (c *QApps) DisassociateLibraryItemReviewWithContext(ctx aws.Context, input *DisassociateLibraryItemReviewInput, opts ...request.Option) (*DisassociateLibraryItemReviewOutput, error)

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

See DisassociateLibraryItemReview 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 (*QApps) DisassociateQAppFromUser 

func (c *QApps) DisassociateQAppFromUser(input *DisassociateQAppFromUserInput) (*DisassociateQAppFromUserOutput, error)

DisassociateQAppFromUser API operation for QApps.

Disassociates a Q App from a user removing the user's access to run the Q App.

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 QApps's API operation DisassociateQAppFromUser for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DisassociateQAppFromUser

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.DisassociateQAppFromUserInput{
		AppId:      aws.String("393e77fb-0a30-4f47-ad30-75d71aeaed8a"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.DisassociateQAppFromUser(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) DisassociateQAppFromUserRequest 

func (c *QApps) DisassociateQAppFromUserRequest(input *DisassociateQAppFromUserInput) (req *request.Request, output *DisassociateQAppFromUserOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DisassociateQAppFromUser

func (*QApps) DisassociateQAppFromUserWithContext 

func (c *QApps) DisassociateQAppFromUserWithContext(ctx aws.Context, input *DisassociateQAppFromUserInput, opts ...request.Option) (*DisassociateQAppFromUserOutput, error)

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

See DisassociateQAppFromUser 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 (*QApps) GetLibraryItem 

func (c *QApps) GetLibraryItem(input *GetLibraryItemInput) (*GetLibraryItemOutput, error)

GetLibraryItem API operation for QApps.

Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.

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 QApps's API operation GetLibraryItem for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetLibraryItem

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.GetLibraryItemInput{
		InstanceId:    aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		LibraryItemId: aws.String("18cbebaa-196a-4aa5-a840-88d548e07f8f"),
	}

	result, err := svc.GetLibraryItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) GetLibraryItemRequest 

func (c *QApps) GetLibraryItemRequest(input *GetLibraryItemInput) (req *request.Request, output *GetLibraryItemOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetLibraryItem

func (*QApps) GetLibraryItemWithContext 

func (c *QApps) GetLibraryItemWithContext(ctx aws.Context, input *GetLibraryItemInput, opts ...request.Option) (*GetLibraryItemOutput, error)

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

See GetLibraryItem 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 (*QApps) GetQApp 

func (c *QApps) GetQApp(input *GetQAppInput) (*GetQAppOutput, error)

GetQApp API operation for QApps.

Retrieves the full details of an Q App, including its definition specifying the cards and 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 QApps's API operation GetQApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQApp

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.GetQAppInput{
		AppId:      aws.String("3d110749-efc3-427c-87e8-15e966e5c168"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.GetQApp(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) GetQAppRequest 

func (c *QApps) GetQAppRequest(input *GetQAppInput) (req *request.Request, output *GetQAppOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQApp

func (*QApps) GetQAppSession 

func (c *QApps) GetQAppSession(input *GetQAppSessionInput) (*GetQAppSessionOutput, error)

GetQAppSession API operation for QApps.

Retrieves the current state and results for an active session of an Amazon Q App.

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 QApps's API operation GetQAppSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppSession

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.GetQAppSessionInput{
		InstanceId: aws.String("288ae830-1df2-4871-b6c0-4314d74dadef"),
		SessionId:  aws.String("1fca878e-64c5-4dc4-b1d9-c93effed4e82"),
	}

	result, err := svc.GetQAppSession(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) GetQAppSessionRequest 

func (c *QApps) GetQAppSessionRequest(input *GetQAppSessionInput) (req *request.Request, output *GetQAppSessionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppSession

func (*QApps) GetQAppSessionWithContext 

func (c *QApps) GetQAppSessionWithContext(ctx aws.Context, input *GetQAppSessionInput, opts ...request.Option) (*GetQAppSessionOutput, error)

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

See GetQAppSession 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 (*QApps) GetQAppWithContext 

func (c *QApps) GetQAppWithContext(ctx aws.Context, input *GetQAppInput, opts ...request.Option) (*GetQAppOutput, error)

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

See GetQApp 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 (*QApps) ImportDocument 

func (c *QApps) ImportDocument(input *ImportDocumentInput) (*ImportDocumentOutput, error)

ImportDocument API operation for QApps.

Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.

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 QApps's API operation ImportDocument for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ImportDocument

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ImportDocumentInput{
		AppId:              aws.String("4263767c-d889-4cb2-a8f6-8b649bc66af0"),
		CardId:             aws.String("82f69028-22a9-4bea-8727-0eabf58e9fed"),
		FileContentsBase64: aws.String("data:text/plain;base64,SomeFileEncodedInBase64"),
		FileName:           aws.String("myFile.txt"),
		InstanceId:         aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Scope:              aws.String("SESSION"),
		SessionId:          aws.String("4f0e5b87-9d38-41cd-9eb4-ebce2f2917cc"),
	}

	result, err := svc.ImportDocument(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeContentTooLargeException:
				fmt.Println(qapps.ErrCodeContentTooLargeException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ImportDocumentInput{
		AppId:              aws.String("4263767c-d889-4cb2-a8f6-8b649bc66af0"),
		CardId:             aws.String("7a11f34b-42d4-4bc8-b668-ae4a788dae1e"),
		FileContentsBase64: aws.String("data:text/plain;base64,SomeFileEncodedInBase64"),
		FileName:           aws.String("anApplicationFile.txt"),
		InstanceId:         aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Scope:              aws.String("APPLICATION"),
	}

	result, err := svc.ImportDocument(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeContentTooLargeException:
				fmt.Println(qapps.ErrCodeContentTooLargeException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) ImportDocumentRequest 

func (c *QApps) ImportDocumentRequest(input *ImportDocumentInput) (req *request.Request, output *ImportDocumentOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ImportDocument

func (*QApps) ImportDocumentWithContext 

func (c *QApps) ImportDocumentWithContext(ctx aws.Context, input *ImportDocumentInput, opts ...request.Option) (*ImportDocumentOutput, error)

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

See ImportDocument 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 (*QApps) ListLibraryItems 

func (c *QApps) ListLibraryItems(input *ListLibraryItemsInput) (*ListLibraryItemsOutput, error)

ListLibraryItems API operation for QApps.

Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.

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 QApps's API operation ListLibraryItems for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListLibraryItems

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ListLibraryItemsInput{
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Limit:      aws.Int64(3),
	}

	result, err := svc.ListLibraryItems(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) ListLibraryItemsPages 

func (c *QApps) ListLibraryItemsPages(input *ListLibraryItemsInput, fn func(*ListLibraryItemsOutput, bool) bool) error

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

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

func (*QApps) ListLibraryItemsPagesWithContext 

func (c *QApps) ListLibraryItemsPagesWithContext(ctx aws.Context, input *ListLibraryItemsInput, fn func(*ListLibraryItemsOutput, bool) bool, opts ...request.Option) error

ListLibraryItemsPagesWithContext same as ListLibraryItemsPages 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 (*QApps) ListLibraryItemsRequest 

func (c *QApps) ListLibraryItemsRequest(input *ListLibraryItemsInput) (req *request.Request, output *ListLibraryItemsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListLibraryItems

func (*QApps) ListLibraryItemsWithContext 

func (c *QApps) ListLibraryItemsWithContext(ctx aws.Context, input *ListLibraryItemsInput, opts ...request.Option) (*ListLibraryItemsOutput, error)

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

See ListLibraryItems 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 (*QApps) ListQApps 

func (c *QApps) ListQApps(input *ListQAppsInput) (*ListQAppsOutput, error)

ListQApps API operation for QApps.

Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. The user identity is extracted from the credentials used to invoke this operation..

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 QApps's API operation ListQApps for usage and error information.

Returned Error Types:

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListQApps

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ListQAppsInput{
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Limit:      aws.Int64(3),
	}

	result, err := svc.ListQApps(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ListQAppsInput{
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Limit:      aws.Int64(3),
		NextToken:  aws.String("bXlzdGVyaW91c1BhZ2luYXRpb25Ub2tlbg=="),
	}

	result, err := svc.ListQApps(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) ListQAppsPages 

func (c *QApps) ListQAppsPages(input *ListQAppsInput, fn func(*ListQAppsOutput, bool) bool) error

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

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

func (*QApps) ListQAppsPagesWithContext 

func (c *QApps) ListQAppsPagesWithContext(ctx aws.Context, input *ListQAppsInput, fn func(*ListQAppsOutput, bool) bool, opts ...request.Option) error

ListQAppsPagesWithContext same as ListQAppsPages 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 (*QApps) ListQAppsRequest 

func (c *QApps) ListQAppsRequest(input *ListQAppsInput) (req *request.Request, output *ListQAppsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListQApps

func (*QApps) ListQAppsWithContext 

func (c *QApps) ListQAppsWithContext(ctx aws.Context, input *ListQAppsInput, opts ...request.Option) (*ListQAppsOutput, error)

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

See ListQApps 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 (*QApps) ListTagsForResource 

func (c *QApps) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for QApps.

Lists the tags associated with an Amazon Q Apps 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 QApps's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListTagsForResource

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.ListTagsForResourceInput{
		ResourceARN: aws.String("arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) ListTagsForResourceRequest 

func (c *QApps) 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/qapps-2023-11-27/ListTagsForResource

func (*QApps) ListTagsForResourceWithContext 

func (c *QApps) 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 (*QApps) PredictQApp 

func (c *QApps) PredictQApp(input *PredictQAppInput) (*PredictQAppOutput, error)

PredictQApp API operation for QApps.

Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. This API doesn't create Amazon Q Apps directly.

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 QApps's API operation PredictQApp for usage and error information.

Returned Error Types:

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/PredictQApp

func (*QApps) PredictQAppRequest 

func (c *QApps) PredictQAppRequest(input *PredictQAppInput) (req *request.Request, output *PredictQAppOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/PredictQApp

func (*QApps) PredictQAppWithContext 

func (c *QApps) PredictQAppWithContext(ctx aws.Context, input *PredictQAppInput, opts ...request.Option) (*PredictQAppOutput, error)

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

See PredictQApp 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 (*QApps) StartQAppSession 

func (c *QApps) StartQAppSession(input *StartQAppSessionInput) (*StartQAppSessionOutput, error)

StartQAppSession API operation for QApps.

Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.

Each Q App session will be condensed into a single conversation in the web experience.

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 QApps's API operation StartQAppSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/StartQAppSession

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.StartQAppSessionInput{
		AppId:      aws.String("65e7dce7-226a-47f9-b689-22850becef89"),
		AppVersion: aws.Int64(1),
		InitialValues: []*qapps.CardValue{
			{
				CardId: aws.String("6fb5b404-3b7b-48a4-8a8b-56406922a606"),
				Value:  aws.String("What is the circumference of Earth?"),
			},
		},
		InstanceId: aws.String("4cc5e4c2-d2a2-4188-a114-9ca125b4aedc"),
	}

	result, err := svc.StartQAppSession(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeServiceQuotaExceededException:
				fmt.Println(qapps.ErrCodeServiceQuotaExceededException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) StartQAppSessionRequest 

func (c *QApps) StartQAppSessionRequest(input *StartQAppSessionInput) (req *request.Request, output *StartQAppSessionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/StartQAppSession

func (*QApps) StartQAppSessionWithContext 

func (c *QApps) StartQAppSessionWithContext(ctx aws.Context, input *StartQAppSessionInput, opts ...request.Option) (*StartQAppSessionOutput, error)

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

See StartQAppSession 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 (*QApps) StopQAppSession 

func (c *QApps) StopQAppSession(input *StopQAppSessionInput) (*StopQAppSessionOutput, error)

StopQAppSession API operation for QApps.

Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. The results of the session will be persisted as part of the conversation.

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 QApps's API operation StopQAppSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/StopQAppSession

func (*QApps) StopQAppSessionRequest 

func (c *QApps) StopQAppSessionRequest(input *StopQAppSessionInput) (req *request.Request, output *StopQAppSessionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/StopQAppSession

func (*QApps) StopQAppSessionWithContext 

func (c *QApps) StopQAppSessionWithContext(ctx aws.Context, input *StopQAppSessionInput, opts ...request.Option) (*StopQAppSessionOutput, error)

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

See StopQAppSession 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 (*QApps) TagResource 

func (c *QApps) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for QApps.

Associates tags with an Amazon Q Apps 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 QApps's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

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

  • InternalServerException An internal service error occurred while processing the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/TagResource

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.TagResourceInput{
		ResourceARN: aws.String("arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0"),
		Tags: map[string]*string{
			"department": aws.String("HR"),
		},
	}

	result, err := svc.TagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeConflictException:
				fmt.Println(qapps.ErrCodeConflictException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) TagResourceRequest 

func (c *QApps) 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/qapps-2023-11-27/TagResource

func (*QApps) TagResourceWithContext 

func (c *QApps) 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 (*QApps) UntagResource 

func (c *QApps) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for QApps.

Disassociates tags from an Amazon Q Apps 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 QApps's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UntagResource

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.UntagResourceInput{
		ResourceARN: aws.String("arn:aws:qapps:us-west-2:123456789012:application/3642ba81-344c-42fd-a480-9119a5a5f26b/qapp/7212ff04-de7b-4831-bd80-45d6975ba1b0"),
		TagKeys: []*string{
			aws.String("department"),
		},
	}

	result, err := svc.UntagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) UntagResourceRequest 

func (c *QApps) 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/qapps-2023-11-27/UntagResource

func (*QApps) UntagResourceWithContext 

func (c *QApps) 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 (*QApps) UpdateLibraryItem 

func (c *QApps) UpdateLibraryItem(input *UpdateLibraryItemInput) (*UpdateLibraryItemOutput, error)

UpdateLibraryItem API operation for QApps.

Updates the metadata and status of a library item for an Amazon Q App.

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 QApps's API operation UpdateLibraryItem for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateLibraryItem

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.UpdateLibraryItemInput{
		InstanceId:    aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		LibraryItemId: aws.String("cb9ecf72-8563-450d-9db9-994f98297316"),
		Status:        aws.String("DISABLED"),
	}

	result, err := svc.UpdateLibraryItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) UpdateLibraryItemRequest 

func (c *QApps) UpdateLibraryItemRequest(input *UpdateLibraryItemInput) (req *request.Request, output *UpdateLibraryItemOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateLibraryItem

func (*QApps) UpdateLibraryItemWithContext 

func (c *QApps) UpdateLibraryItemWithContext(ctx aws.Context, input *UpdateLibraryItemInput, opts ...request.Option) (*UpdateLibraryItemOutput, error)

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

See UpdateLibraryItem 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 (*QApps) UpdateQApp 

func (c *QApps) UpdateQApp(input *UpdateQAppInput) (*UpdateQAppOutput, error)

UpdateQApp API operation for QApps.

Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.

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 QApps's API operation UpdateQApp for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQApp

Example (Shared00) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.UpdateQAppInput{
		AppId:      aws.String("7212ff04-de7b-4831-bd80-45d6975ba1b0"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
		Title:      aws.String("This is the new title"),
	}

	result, err := svc.UpdateQApp(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeContentTooLargeException:
				fmt.Println(qapps.ErrCodeContentTooLargeException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:
Example (Shared01) 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/qapps"
)

func main() {
	svc := qapps.New(session.New())
	input := &qapps.UpdateQAppInput{
		AppDefinition: &qapps.AppDefinitionInput_{
			Cards: []*qapps.CardInput_{
				{
					QQuery: &qapps.QQueryCardInput_{
						Id:     aws.String("18870b94-1e63-40e0-8c12-669c90ac5acc"),
						Prompt: aws.String("Recommend me an itinerary for a trip"),
						Title:  aws.String("Trip Ideas"),
						Type:   aws.String("q-query"),
					},
				},
			},
		},
		AppId:      aws.String("7212ff04-de7b-4831-bd80-45d6975ba1b0"),
		InstanceId: aws.String("0b95c9c4-89cc-4aa8-9aae-aa91cbec699f"),
	}

	result, err := svc.UpdateQApp(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case qapps.ErrCodeResourceNotFoundException:
				fmt.Println(qapps.ErrCodeResourceNotFoundException, aerr.Error())
			case qapps.ErrCodeAccessDeniedException:
				fmt.Println(qapps.ErrCodeAccessDeniedException, aerr.Error())
			case qapps.ErrCodeValidationException:
				fmt.Println(qapps.ErrCodeValidationException, aerr.Error())
			case qapps.ErrCodeInternalServerException:
				fmt.Println(qapps.ErrCodeInternalServerException, aerr.Error())
			case qapps.ErrCodeUnauthorizedException:
				fmt.Println(qapps.ErrCodeUnauthorizedException, aerr.Error())
			case qapps.ErrCodeContentTooLargeException:
				fmt.Println(qapps.ErrCodeContentTooLargeException, aerr.Error())
			case qapps.ErrCodeThrottlingException:
				fmt.Println(qapps.ErrCodeThrottlingException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*QApps) UpdateQAppRequest 

func (c *QApps) UpdateQAppRequest(input *UpdateQAppInput) (req *request.Request, output *UpdateQAppOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQApp

func (*QApps) UpdateQAppSession 

func (c *QApps) UpdateQAppSession(input *UpdateQAppSessionInput) (*UpdateQAppSessionOutput, error)

UpdateQAppSession API operation for QApps.

Updates the session for a given Q App sessionId. This is only valid when at least one card of the session is in the WAITING state. Data for each WAITING card can be provided as input. If inputs are not provided, the call will be accepted but session will not move forward. Inputs for cards that are not in the WAITING status will be ignored.

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 QApps's API operation UpdateQAppSession for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The requested resource could not be found.

  • AccessDeniedException The client is not authorized to perform the requested operation.

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

  • InternalServerException An internal service error occurred while processing the request.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppSession

func (*QApps) UpdateQAppSessionRequest 

func (c *QApps) UpdateQAppSessionRequest(input *UpdateQAppSessionInput) (req *request.Request, output *UpdateQAppSessionOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppSession

func (*QApps) UpdateQAppSessionWithContext 

func (c *QApps) UpdateQAppSessionWithContext(ctx aws.Context, input *UpdateQAppSessionInput, opts ...request.Option) (*UpdateQAppSessionOutput, error)

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

See UpdateQAppSession 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 (*QApps) UpdateQAppWithContext 

func (c *QApps) UpdateQAppWithContext(ctx aws.Context, input *UpdateQAppInput, opts ...request.Option) (*UpdateQAppOutput, error)

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

See UpdateQApp 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 QPluginCard 

type QPluginCard struct {

	// Any dependencies or requirements for the plugin card.
	//
	// Dependencies is a required field
	Dependencies []*string `locationName:"dependencies" type:"list" required:"true"`

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

	// The unique identifier of the plugin used by the card.
	//
	// PluginId is a required field
	PluginId *string `locationName:"pluginId" type:"string" required:"true"`

	// The type or category of the plugin used by the card.
	//
	// PluginType is a required field
	PluginType *string `locationName:"pluginType" type:"string" required:"true" enum:"PluginType"`

	// The prompt or instructions displayed for the plugin card.
	//
	// Prompt is a required field
	Prompt *string `locationName:"prompt" type:"string" required:"true"`

	// The title or label of the plugin card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (QPluginCard) GoString 

func (s QPluginCard) GoString() string

GoString returns the string representation.

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

func (*QPluginCard) SetDependencies 

func (s *QPluginCard) SetDependencies(v []*string) *QPluginCard

SetDependencies sets the Dependencies field's value.

func (*QPluginCard) SetId 

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

SetId sets the Id field's value.

func (*QPluginCard) SetPluginId 

func (s *QPluginCard) SetPluginId(v string) *QPluginCard

SetPluginId sets the PluginId field's value.

func (*QPluginCard) SetPluginType 

func (s *QPluginCard) SetPluginType(v string) *QPluginCard

SetPluginType sets the PluginType field's value.

func (*QPluginCard) SetPrompt 

func (s *QPluginCard) SetPrompt(v string) *QPluginCard

SetPrompt sets the Prompt field's value.

func (*QPluginCard) SetTitle 

func (s *QPluginCard) SetTitle(v string) *QPluginCard

SetTitle sets the Title field's value.

func (*QPluginCard) SetType 

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

SetType sets the Type field's value.

func (QPluginCard) String 

func (s QPluginCard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 QPluginCardInput_ 

type QPluginCardInput_ struct {

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

	// The unique identifier of the plugin used by the card.
	//
	// PluginId is a required field
	PluginId *string `locationName:"pluginId" min:"36" type:"string" required:"true"`

	// The prompt or instructions displayed for the plugin card.
	//
	// Prompt is a required field
	Prompt *string `locationName:"prompt" type:"string" required:"true"`

	// The title or label of the plugin card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (QPluginCardInput_) GoString 

func (s QPluginCardInput_) GoString() string

GoString returns the string representation.

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

func (*QPluginCardInput_) SetId 

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

SetId sets the Id field's value.

func (*QPluginCardInput_) SetPluginId 

func (s *QPluginCardInput_) SetPluginId(v string) *QPluginCardInput_

SetPluginId sets the PluginId field's value.

func (*QPluginCardInput_) SetPrompt 

func (s *QPluginCardInput_) SetPrompt(v string) *QPluginCardInput_

SetPrompt sets the Prompt field's value.

func (*QPluginCardInput_) SetTitle 

func (s *QPluginCardInput_) SetTitle(v string) *QPluginCardInput_

SetTitle sets the Title field's value.

func (*QPluginCardInput_) SetType 

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

SetType sets the Type field's value.

func (QPluginCardInput_) String 

func (s QPluginCardInput_) String() string

String returns the string representation.

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

func (*QPluginCardInput_) Validate 

func (s *QPluginCardInput_) Validate() error

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

type QQueryCard 

type QQueryCard struct {

	// The Amazon Q Business filters applied in this query card when resolving data
	// sources
	AttributeFilter *AttributeFilter `locationName:"attributeFilter" type:"structure"`

	// Any dependencies or requirements for the query card.
	//
	// Dependencies is a required field
	Dependencies []*string `locationName:"dependencies" type:"list" required:"true"`

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

	// The source or type of output generated by the query card.
	//
	// OutputSource is a required field
	OutputSource *string `locationName:"outputSource" type:"string" required:"true" enum:"CardOutputSource"`

	// The prompt or instructions displayed for the query card.
	//
	// Prompt is a required field
	Prompt *string `locationName:"prompt" type:"string" required:"true"`

	// The title or label of the query card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (QQueryCard) GoString 

func (s QQueryCard) GoString() string

GoString returns the string representation.

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

func (*QQueryCard) SetAttributeFilter 

func (s *QQueryCard) SetAttributeFilter(v *AttributeFilter) *QQueryCard

SetAttributeFilter sets the AttributeFilter field's value.

func (*QQueryCard) SetDependencies 

func (s *QQueryCard) SetDependencies(v []*string) *QQueryCard

SetDependencies sets the Dependencies field's value.

func (*QQueryCard) SetId 

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

SetId sets the Id field's value.

func (*QQueryCard) SetOutputSource 

func (s *QQueryCard) SetOutputSource(v string) *QQueryCard

SetOutputSource sets the OutputSource field's value.

func (*QQueryCard) SetPrompt 

func (s *QQueryCard) SetPrompt(v string) *QQueryCard

SetPrompt sets the Prompt field's value.

func (*QQueryCard) SetTitle 

func (s *QQueryCard) SetTitle(v string) *QQueryCard

SetTitle sets the Title field's value.

func (*QQueryCard) SetType 

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

SetType sets the Type field's value.

func (QQueryCard) String 

func (s QQueryCard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 QQueryCardInput_ 

type QQueryCardInput_ struct {

	// Turns on filtering of responses based on document attributes or metadata
	// fields.
	AttributeFilter *AttributeFilter `locationName:"attributeFilter" type:"structure"`

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

	// The source or type of output to generate for the query card.
	OutputSource *string `locationName:"outputSource" type:"string" enum:"CardOutputSource"`

	// The prompt or instructions displayed for the query card.
	//
	// Prompt is a required field
	Prompt *string `locationName:"prompt" type:"string" required:"true"`

	// The title or label of the query card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (QQueryCardInput_) GoString 

func (s QQueryCardInput_) GoString() string

GoString returns the string representation.

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

func (*QQueryCardInput_) SetAttributeFilter 

func (s *QQueryCardInput_) SetAttributeFilter(v *AttributeFilter) *QQueryCardInput_

SetAttributeFilter sets the AttributeFilter field's value.

func (*QQueryCardInput_) SetId 

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

SetId sets the Id field's value.

func (*QQueryCardInput_) SetOutputSource 

func (s *QQueryCardInput_) SetOutputSource(v string) *QQueryCardInput_

SetOutputSource sets the OutputSource field's value.

func (*QQueryCardInput_) SetPrompt 

func (s *QQueryCardInput_) SetPrompt(v string) *QQueryCardInput_

SetPrompt sets the Prompt field's value.

func (*QQueryCardInput_) SetTitle 

func (s *QQueryCardInput_) SetTitle(v string) *QQueryCardInput_

SetTitle sets the Title field's value.

func (*QQueryCardInput_) SetType 

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

SetType sets the Type field's value.

func (QQueryCardInput_) String 

func (s QQueryCardInput_) String() string

String returns the string representation.

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

func (*QQueryCardInput_) Validate 

func (s *QQueryCardInput_) 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"`

	// The unique identifier of the resource
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The requested resource could not be found.

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 ServiceQuotaExceededException 

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

	Message_ *string `locationName:"message" type:"string"`

	// The code of the quota that was exceeded
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// The unique identifier of the resource
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`

	// The code for the service where the quota was exceeded
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

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 StartQAppSessionInput 

type StartQAppSessionInput struct {

	// The unique identifier of the Q App to start a session for.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Q App to use for the session.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// Optional initial input values to provide for the Q App session.
	InitialValues []*CardValue `locationName:"initialValues" type:"list"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// Optional tags to associate with the new Q App session.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (StartQAppSessionInput) GoString 

func (s StartQAppSessionInput) GoString() string

GoString returns the string representation.

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

func (*StartQAppSessionInput) SetAppId 

func (s *StartQAppSessionInput) SetAppId(v string) *StartQAppSessionInput

SetAppId sets the AppId field's value.

func (*StartQAppSessionInput) SetAppVersion 

func (s *StartQAppSessionInput) SetAppVersion(v int64) *StartQAppSessionInput

SetAppVersion sets the AppVersion field's value.

func (*StartQAppSessionInput) SetInitialValues 

func (s *StartQAppSessionInput) SetInitialValues(v []*CardValue) *StartQAppSessionInput

SetInitialValues sets the InitialValues field's value.

func (*StartQAppSessionInput) SetInstanceId 

func (s *StartQAppSessionInput) SetInstanceId(v string) *StartQAppSessionInput

SetInstanceId sets the InstanceId field's value.

func (*StartQAppSessionInput) SetTags 

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

SetTags sets the Tags field's value.

func (StartQAppSessionInput) String 

func (s StartQAppSessionInput) String() string

String returns the string representation.

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

func (*StartQAppSessionInput) Validate 

func (s *StartQAppSessionInput) Validate() error

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

type StartQAppSessionOutput 

type StartQAppSessionOutput struct {

	// The Amazon Resource Name (ARN) of the new Q App session.
	//
	// SessionArn is a required field
	SessionArn *string `locationName:"sessionArn" type:"string" required:"true"`

	// The unique identifier of the new Q App session.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartQAppSessionOutput) GoString 

func (s StartQAppSessionOutput) GoString() string

GoString returns the string representation.

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

func (*StartQAppSessionOutput) SetSessionArn 

func (s *StartQAppSessionOutput) SetSessionArn(v string) *StartQAppSessionOutput

SetSessionArn sets the SessionArn field's value.

func (*StartQAppSessionOutput) SetSessionId 

func (s *StartQAppSessionOutput) SetSessionId(v string) *StartQAppSessionOutput

SetSessionId sets the SessionId field's value.

func (StartQAppSessionOutput) String 

func (s StartQAppSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 StopQAppSessionInput 

type StopQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the Q App session to stop.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopQAppSessionInput) GoString 

func (s StopQAppSessionInput) GoString() string

GoString returns the string representation.

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

func (*StopQAppSessionInput) SetInstanceId 

func (s *StopQAppSessionInput) SetInstanceId(v string) *StopQAppSessionInput

SetInstanceId sets the InstanceId field's value.

func (*StopQAppSessionInput) SetSessionId 

func (s *StopQAppSessionInput) SetSessionId(v string) *StopQAppSessionInput

SetSessionId sets the SessionId field's value.

func (StopQAppSessionInput) String 

func (s StopQAppSessionInput) String() string

String returns the string representation.

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

func (*StopQAppSessionInput) Validate 

func (s *StopQAppSessionInput) Validate() error

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

type StopQAppSessionOutput 

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

func (StopQAppSessionOutput) GoString 

func (s StopQAppSessionOutput) GoString() string

GoString returns the string representation.

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

func (StopQAppSessionOutput) String 

func (s StopQAppSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 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:"1" type:"string" required:"true"`

	// The tags to associate with 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 TextInputCard 

type TextInputCard struct {

	// The default value to pre-populate in the text input field.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

	// Any dependencies or requirements for the text input card.
	//
	// Dependencies is a required field
	Dependencies []*string `locationName:"dependencies" type:"list" required:"true"`

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

	// The placeholder text to display in the text input field.
	Placeholder *string `locationName:"placeholder" type:"string"`

	// The title or label of the text input card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (TextInputCard) GoString 

func (s TextInputCard) GoString() string

GoString returns the string representation.

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

func (*TextInputCard) SetDefaultValue 

func (s *TextInputCard) SetDefaultValue(v string) *TextInputCard

SetDefaultValue sets the DefaultValue field's value.

func (*TextInputCard) SetDependencies 

func (s *TextInputCard) SetDependencies(v []*string) *TextInputCard

SetDependencies sets the Dependencies field's value.

func (*TextInputCard) SetId 

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

SetId sets the Id field's value.

func (*TextInputCard) SetPlaceholder 

func (s *TextInputCard) SetPlaceholder(v string) *TextInputCard

SetPlaceholder sets the Placeholder field's value.

func (*TextInputCard) SetTitle 

func (s *TextInputCard) SetTitle(v string) *TextInputCard

SetTitle sets the Title field's value.

func (*TextInputCard) SetType 

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

SetType sets the Type field's value.

func (TextInputCard) String 

func (s TextInputCard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 TextInputCardInput_ 

type TextInputCardInput_ struct {

	// The default value to pre-populate in the text input field.
	DefaultValue *string `locationName:"defaultValue" type:"string"`

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

	// The placeholder text to display in the text input field.
	Placeholder *string `locationName:"placeholder" type:"string"`

	// The title or label of the text input card.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The type of the card.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"CardType"`
	// contains filtered or unexported fields
}

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

func (TextInputCardInput_) GoString 

func (s TextInputCardInput_) GoString() string

GoString returns the string representation.

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

func (*TextInputCardInput_) SetDefaultValue 

func (s *TextInputCardInput_) SetDefaultValue(v string) *TextInputCardInput_

SetDefaultValue sets the DefaultValue field's value.

func (*TextInputCardInput_) SetId 

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

SetId sets the Id field's value.

func (*TextInputCardInput_) SetPlaceholder 

func (s *TextInputCardInput_) SetPlaceholder(v string) *TextInputCardInput_

SetPlaceholder sets the Placeholder field's value.

func (*TextInputCardInput_) SetTitle 

func (s *TextInputCardInput_) SetTitle(v string) *TextInputCardInput_

SetTitle sets the Title field's value.

func (*TextInputCardInput_) SetType 

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

SetType sets the Type field's value.

func (TextInputCardInput_) String 

func (s TextInputCardInput_) String() string

String returns the string representation.

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

func (*TextInputCardInput_) Validate 

func (s *TextInputCardInput_) 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"`

	// The code of the quota that was exceeded
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// The number of seconds to wait before retrying the operation
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// The code for the service where the quota was exceeded
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// 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) 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 UnauthorizedException 

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

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

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

func (*UnauthorizedException) Code 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

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

func (*UnauthorizedException) Message 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode 

func (s *UnauthorizedException) StatusCode() int

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

func (UnauthorizedException) String 

func (s UnauthorizedException) String() string

String returns the string representation.

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to disassociate the tag from.
	//
	// ResourceARN is a required field
	ResourceARN *string `location:"uri" locationName:"resourceARN" min:"1" type:"string" required:"true"`

	// The keys of the tags to disassociate 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 UpdateLibraryItemInput 

type UpdateLibraryItemInput struct {

	// The new categories to associate with the library item.
	Categories []*string `locationName:"categories" type:"list"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the library item to update.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`

	// The new status to set for the library item, such as "Published" or "Hidden".
	Status *string `locationName:"status" type:"string" enum:"LibraryItemStatus"`
	// contains filtered or unexported fields
}

func (UpdateLibraryItemInput) GoString 

func (s UpdateLibraryItemInput) GoString() string

GoString returns the string representation.

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

func (*UpdateLibraryItemInput) SetCategories 

func (s *UpdateLibraryItemInput) SetCategories(v []*string) *UpdateLibraryItemInput

SetCategories sets the Categories field's value.

func (*UpdateLibraryItemInput) SetInstanceId 

func (s *UpdateLibraryItemInput) SetInstanceId(v string) *UpdateLibraryItemInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateLibraryItemInput) SetLibraryItemId 

func (s *UpdateLibraryItemInput) SetLibraryItemId(v string) *UpdateLibraryItemInput

SetLibraryItemId sets the LibraryItemId field's value.

func (*UpdateLibraryItemInput) SetStatus 

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

SetStatus sets the Status field's value.

func (UpdateLibraryItemInput) String 

func (s UpdateLibraryItemInput) String() string

String returns the string representation.

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

func (*UpdateLibraryItemInput) Validate 

func (s *UpdateLibraryItemInput) Validate() error

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

type UpdateLibraryItemOutput 

type UpdateLibraryItemOutput struct {

	// The unique identifier of the Q App associated with the library item.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The version of the Q App associated with the library item.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The categories associated with the updated library item.
	//
	// Categories is a required field
	Categories []*Category `locationName:"categories" type:"list" required:"true"`

	// The date and time the library item was originally created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who originally created the library item.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// Whether the current user has rated the library item.
	IsRatedByUser *bool `locationName:"isRatedByUser" type:"boolean"`

	// The unique identifier of the updated library item.
	//
	// LibraryItemId is a required field
	LibraryItemId *string `locationName:"libraryItemId" type:"string" required:"true"`

	// The number of ratings the library item has received.
	//
	// RatingCount is a required field
	RatingCount *int64 `locationName:"ratingCount" type:"integer" required:"true"`

	// The new status of the updated library item.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true"`

	// The date and time the library item was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The user who last updated the library item.
	UpdatedBy *string `locationName:"updatedBy" type:"string"`

	// The number of users who have the associated Q App.
	UserCount *int64 `locationName:"userCount" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateLibraryItemOutput) GoString 

func (s UpdateLibraryItemOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateLibraryItemOutput) SetAppId 

func (s *UpdateLibraryItemOutput) SetAppId(v string) *UpdateLibraryItemOutput

SetAppId sets the AppId field's value.

func (*UpdateLibraryItemOutput) SetAppVersion 

func (s *UpdateLibraryItemOutput) SetAppVersion(v int64) *UpdateLibraryItemOutput

SetAppVersion sets the AppVersion field's value.

func (*UpdateLibraryItemOutput) SetCategories 

func (s *UpdateLibraryItemOutput) SetCategories(v []*Category) *UpdateLibraryItemOutput

SetCategories sets the Categories field's value.

func (*UpdateLibraryItemOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateLibraryItemOutput) SetCreatedBy 

func (s *UpdateLibraryItemOutput) SetCreatedBy(v string) *UpdateLibraryItemOutput

SetCreatedBy sets the CreatedBy field's value.

func (*UpdateLibraryItemOutput) SetIsRatedByUser 

func (s *UpdateLibraryItemOutput) SetIsRatedByUser(v bool) *UpdateLibraryItemOutput

SetIsRatedByUser sets the IsRatedByUser field's value.

func (*UpdateLibraryItemOutput) SetLibraryItemId 

func (s *UpdateLibraryItemOutput) SetLibraryItemId(v string) *UpdateLibraryItemOutput

SetLibraryItemId sets the LibraryItemId field's value.

func (*UpdateLibraryItemOutput) SetRatingCount 

func (s *UpdateLibraryItemOutput) SetRatingCount(v int64) *UpdateLibraryItemOutput

SetRatingCount sets the RatingCount field's value.

func (*UpdateLibraryItemOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*UpdateLibraryItemOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*UpdateLibraryItemOutput) SetUpdatedBy 

func (s *UpdateLibraryItemOutput) SetUpdatedBy(v string) *UpdateLibraryItemOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (*UpdateLibraryItemOutput) SetUserCount 

func (s *UpdateLibraryItemOutput) SetUserCount(v int64) *UpdateLibraryItemOutput

SetUserCount sets the UserCount field's value.

func (UpdateLibraryItemOutput) String 

func (s UpdateLibraryItemOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 UpdateQAppInput 

type UpdateQAppInput struct {

	// The new definition specifying the cards and flow for the Q App.
	AppDefinition *AppDefinitionInput_ `locationName:"appDefinition" type:"structure"`

	// The unique identifier of the Q App to update.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The new description for the Q App.
	Description *string `locationName:"description" type:"string"`

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The new title for the Q App.
	Title *string `locationName:"title" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateQAppInput) GoString 

func (s UpdateQAppInput) GoString() string

GoString returns the string representation.

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

func (*UpdateQAppInput) SetAppDefinition 

func (s *UpdateQAppInput) SetAppDefinition(v *AppDefinitionInput_) *UpdateQAppInput

SetAppDefinition sets the AppDefinition field's value.

func (*UpdateQAppInput) SetAppId 

func (s *UpdateQAppInput) SetAppId(v string) *UpdateQAppInput

SetAppId sets the AppId field's value.

func (*UpdateQAppInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateQAppInput) SetInstanceId 

func (s *UpdateQAppInput) SetInstanceId(v string) *UpdateQAppInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateQAppInput) SetTitle 

func (s *UpdateQAppInput) SetTitle(v string) *UpdateQAppInput

SetTitle sets the Title field's value.

func (UpdateQAppInput) String 

func (s UpdateQAppInput) String() string

String returns the string representation.

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

func (*UpdateQAppInput) Validate 

func (s *UpdateQAppInput) Validate() error

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

type UpdateQAppOutput 

type UpdateQAppOutput struct {

	// The Amazon Resource Name (ARN) of the updated Q App.
	//
	// AppArn is a required field
	AppArn *string `locationName:"appArn" type:"string" required:"true"`

	// The unique identifier of the updated Q App.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// The new version of the updated Q App.
	//
	// AppVersion is a required field
	AppVersion *int64 `locationName:"appVersion" type:"integer" required:"true"`

	// The date and time the Q App was originally created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who originally created the Q App.
	//
	// CreatedBy is a required field
	CreatedBy *string `locationName:"createdBy" type:"string" required:"true"`

	// The new description of the updated Q App.
	Description *string `locationName:"description" type:"string"`

	// The initial prompt for the updated Q App.
	InitialPrompt *string `locationName:"initialPrompt" type:"string"`

	// The capabilities required for the updated Q App.
	RequiredCapabilities []*string `locationName:"requiredCapabilities" type:"list" enum:"AppRequiredCapability"`

	// The status of the updated Q App.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"AppStatus"`

	// The new title of the updated Q App.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`

	// The date and time the Q App was last updated.
	//
	// UpdatedAt is a required field
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The user who last updated the Q App.
	//
	// UpdatedBy is a required field
	UpdatedBy *string `locationName:"updatedBy" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateQAppOutput) GoString 

func (s UpdateQAppOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateQAppOutput) SetAppArn 

func (s *UpdateQAppOutput) SetAppArn(v string) *UpdateQAppOutput

SetAppArn sets the AppArn field's value.

func (*UpdateQAppOutput) SetAppId 

func (s *UpdateQAppOutput) SetAppId(v string) *UpdateQAppOutput

SetAppId sets the AppId field's value.

func (*UpdateQAppOutput) SetAppVersion 

func (s *UpdateQAppOutput) SetAppVersion(v int64) *UpdateQAppOutput

SetAppVersion sets the AppVersion field's value.

func (*UpdateQAppOutput) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UpdateQAppOutput) SetCreatedBy 

func (s *UpdateQAppOutput) SetCreatedBy(v string) *UpdateQAppOutput

SetCreatedBy sets the CreatedBy field's value.

func (*UpdateQAppOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*UpdateQAppOutput) SetInitialPrompt 

func (s *UpdateQAppOutput) SetInitialPrompt(v string) *UpdateQAppOutput

SetInitialPrompt sets the InitialPrompt field's value.

func (*UpdateQAppOutput) SetRequiredCapabilities 

func (s *UpdateQAppOutput) SetRequiredCapabilities(v []*string) *UpdateQAppOutput

SetRequiredCapabilities sets the RequiredCapabilities field's value.

func (*UpdateQAppOutput) SetStatus 

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

SetStatus sets the Status field's value.

func (*UpdateQAppOutput) SetTitle 

func (s *UpdateQAppOutput) SetTitle(v string) *UpdateQAppOutput

SetTitle sets the Title field's value.

func (*UpdateQAppOutput) SetUpdatedAt 

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

SetUpdatedAt sets the UpdatedAt field's value.

func (*UpdateQAppOutput) SetUpdatedBy 

func (s *UpdateQAppOutput) SetUpdatedBy(v string) *UpdateQAppOutput

SetUpdatedBy sets the UpdatedBy field's value.

func (UpdateQAppOutput) String 

func (s UpdateQAppOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 UpdateQAppSessionInput 

type UpdateQAppSessionInput struct {

	// The unique identifier of the Amazon Q Business application environment instance.
	//
	// InstanceId is a required field
	InstanceId *string `location:"header" locationName:"instance-id" type:"string" required:"true"`

	// The unique identifier of the Q App session to provide input for.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`

	// The input values to provide for the current state of the Q App session.
	Values []*CardValue `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateQAppSessionInput) GoString 

func (s UpdateQAppSessionInput) GoString() string

GoString returns the string representation.

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

func (*UpdateQAppSessionInput) SetInstanceId 

func (s *UpdateQAppSessionInput) SetInstanceId(v string) *UpdateQAppSessionInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateQAppSessionInput) SetSessionId 

func (s *UpdateQAppSessionInput) SetSessionId(v string) *UpdateQAppSessionInput

SetSessionId sets the SessionId field's value.

func (*UpdateQAppSessionInput) SetValues 

func (s *UpdateQAppSessionInput) SetValues(v []*CardValue) *UpdateQAppSessionInput

SetValues sets the Values field's value.

func (UpdateQAppSessionInput) String 

func (s UpdateQAppSessionInput) String() string

String returns the string representation.

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

func (*UpdateQAppSessionInput) Validate 

func (s *UpdateQAppSessionInput) Validate() error

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

type UpdateQAppSessionOutput 

type UpdateQAppSessionOutput struct {

	// The Amazon Resource Name (ARN) of the updated Q App session.
	//
	// SessionArn is a required field
	SessionArn *string `locationName:"sessionArn" type:"string" required:"true"`

	// The unique identifier of the updated Q App session.
	//
	// SessionId is a required field
	SessionId *string `locationName:"sessionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateQAppSessionOutput) GoString 

func (s UpdateQAppSessionOutput) GoString() string

GoString returns the string representation.

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

func (*UpdateQAppSessionOutput) SetSessionArn 

func (s *UpdateQAppSessionOutput) SetSessionArn(v string) *UpdateQAppSessionOutput

SetSessionArn sets the SessionArn field's value.

func (*UpdateQAppSessionOutput) SetSessionId 

func (s *UpdateQAppSessionOutput) SetSessionId(v string) *UpdateQAppSessionOutput

SetSessionId sets the SessionId field's value.

func (UpdateQAppSessionOutput) String 

func (s UpdateQAppSessionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in 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 UserAppItem 

type UserAppItem struct {

	// The Amazon Resource Name (ARN) of the Q App.
	//
	// AppArn is a required field
	AppArn *string `locationName:"appArn" type:"string" required:"true"`

	// The unique identifier of the Q App.
	//
	// AppId is a required field
	AppId *string `locationName:"appId" type:"string" required:"true"`

	// A flag indicating whether the user can edit the Q App.
	CanEdit *bool `locationName:"canEdit" type:"boolean"`

	// The date and time the user's association with the Q App was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The description of the Q App.
	Description *string `locationName:"description" type:"string"`

	// The status of the user's association with the Q App.
	Status *string `locationName:"status" type:"string"`

	// The title of the Q App.
	//
	// Title is a required field
	Title *string `locationName:"title" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (UserAppItem) GoString 

func (s UserAppItem) GoString() string

GoString returns the string representation.

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

func (*UserAppItem) SetAppArn 

func (s *UserAppItem) SetAppArn(v string) *UserAppItem

SetAppArn sets the AppArn field's value.

func (*UserAppItem) SetAppId 

func (s *UserAppItem) SetAppId(v string) *UserAppItem

SetAppId sets the AppId field's value.

func (*UserAppItem) SetCanEdit 

func (s *UserAppItem) SetCanEdit(v bool) *UserAppItem

SetCanEdit sets the CanEdit field's value.

func (*UserAppItem) SetCreatedAt 

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

SetCreatedAt sets the CreatedAt field's value.

func (*UserAppItem) SetDescription 

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

SetDescription sets the Description field's value.

func (*UserAppItem) SetStatus 

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

SetStatus sets the Status field's value.

func (*UserAppItem) SetTitle 

func (s *UserAppItem) SetTitle(v string) *UserAppItem

SetTitle sets the Title field's value.

func (UserAppItem) String 

func (s UserAppItem) String() string

String returns the string representation.

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

type ValidationException 

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

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

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

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

Source Files

View all Source files

Directories

Path Synopsis
Package qappsiface provides an interface to enable mocking the QApps service client for testing your code.
 Package qappsiface provides an interface to enable mocking the QApps 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.