Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that QApps can respond with.

Structs

AppDefinition

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

AppDefinitionInput

The input for defining an Q App.

AttributeFilter

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

BatchCreateCategoryInputCategory

The category object to be created.

CardStatus

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

CardValue

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

Category

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

CategoryInput

A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.

ConversationMessage

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

DocumentAttribute

A document attribute or metadata field.

FileUploadCard

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

FileUploadCardInput

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.

FormInputCard

A card in an Amazon Q App that allows the user to submit a response.

FormInputCardInput

Represents a form input card for an Amazon Q App.

FormInputCardMetadata

The metadata of the form input card.

LibraryItemMember

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.

PermissionInput

The permission to grant or revoke for a Amazon Q App.

PermissionOutput

The permission granted to the Amazon Q App.

PredictAppDefinition

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

PrincipalOutput

The principal for which the permission applies.

QAppSessionData

The response collected for a Amazon Q App session. This container represents a single response to a Q App session.

QPluginCard

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

QPluginCardInput

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

QQueryCard

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

QQueryCardInput

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

SessionSharingConfiguration

The sharing configuration of an Amazon Q App data collection session.

Submission

A record created when a user submits a form card.

SubmissionMutation

Represents an action performed on a submission.

TextInputCard

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

TextInputCardInput

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

User

A user of an Amazon Q App.

UserAppItem

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

Enums

Action

When writing a match expression against Action, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AppRequiredCapability

When writing a match expression against AppRequiredCapability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

AppStatus

When writing a match expression against AppStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Card

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

CardInput

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

CardOutputSource

When writing a match expression against CardOutputSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

CardType

When writing a match expression against CardType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DocumentAttributeValue

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

DocumentScope

When writing a match expression against DocumentScope, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExecutionStatus

When writing a match expression against ExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InputCardComputeMode

When writing a match expression against InputCardComputeMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LibraryItemStatus

When writing a match expression against LibraryItemStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PluginType

When writing a match expression against PluginType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PredictQAppInputOptions

The input options for generating an Q App definition.

Sender

When writing a match expression against Sender, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SubmissionMutationKind

When writing a match expression against SubmissionMutationKind, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UserType

When writing a match expression against UserType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.