# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.QApps do
@moduledoc """
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 a Q App that exclusively generates
marketing-related content to improve your marketing team's productivity or a Q
App for writing customer emails and creating promotional content using a certain
style of voice, tone, and branding. For more information on the capabilities,
see [Amazon Q Apps capabilities](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions)
in the *Amazon Q Business User Guide*.
For an overview of the Amazon Q App APIs, see [Overview of Amazon Q Apps API operations](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html).
For information about the IAM access control permissions you need to use the
Amazon Q Apps API, see [ IAM role for the Amazon Q Business web experience including Amazon Q
Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html)
in the *Amazon Q Business User Guide*.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
disassociate_library_item_review_input() :: %{
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type disassociate_library_item_review_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
q_plugin_card_input() :: %{
"actionIdentifier" => String.t() | atom(),
"id" => String.t() | atom(),
"pluginId" => String.t() | atom(),
"prompt" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type q_plugin_card_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_output() :: %{
"appArn" => String.t() | atom(),
"appId" => String.t() | atom(),
"appVersion" => integer(),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"description" => String.t() | atom(),
"initialPrompt" => String.t() | atom(),
"requiredCapabilities" => list(list(any())()),
"status" => list(any()),
"title" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()]
}
"""
@type update_q_app_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_q_app_session_input() :: %{
optional("initialValues") => list(card_value()),
optional("sessionId") => [String.t() | atom()],
optional("tags") => map(),
required("appId") => String.t() | atom(),
required("appVersion") => integer(),
required("instanceId") => String.t() | atom()
}
"""
@type start_q_app_session_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_q_apps_input() :: %{
optional("limit") => integer(),
optional("nextToken") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type list_q_apps_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_library_item_input() :: %{
optional("categories") => list(String.t() | atom()),
optional("status") => list(any()),
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type update_library_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_library_item_output() :: %{
"appId" => String.t() | atom(),
"appVersion" => integer(),
"categories" => list(category()),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"isRatedByUser" => [boolean()],
"isVerified" => [boolean()],
"libraryItemId" => String.t() | atom(),
"ratingCount" => [integer()],
"status" => [String.t() | atom()],
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()],
"userCount" => [integer()]
}
"""
@type update_library_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
file_upload_card() :: %{
"allowOverride" => [boolean()],
"dependencies" => list([String.t() | atom()]()),
"fileId" => [String.t() | atom()],
"filename" => [String.t() | atom()],
"id" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type file_upload_card() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_categories_output() :: %{
"categories" => list(category())
}
"""
@type list_categories_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => [String.t() | atom()],
"quotaCode" => [String.t() | atom()],
"retryAfterSeconds" => [integer()],
"serviceCode" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_q_app_permissions_output() :: %{
"appId" => [String.t() | atom()],
"permissions" => list(permission_output()),
"resourceArn" => [String.t() | atom()]
}
"""
@type describe_q_app_permissions_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_document_input() :: %{
optional("sessionId") => String.t() | atom(),
required("appId") => String.t() | atom(),
required("cardId") => String.t() | atom(),
required("fileContentsBase64") => [String.t() | atom()],
required("fileName") => String.t() | atom(),
required("instanceId") => String.t() | atom(),
required("scope") => list(any())
}
"""
@type import_document_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_q_app_session_input() :: %{
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type get_q_app_session_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
q_plugin_card() :: %{
"actionIdentifier" => String.t() | atom(),
"dependencies" => list([String.t() | atom()]()),
"id" => String.t() | atom(),
"pluginId" => [String.t() | atom()],
"pluginType" => list(any()),
"prompt" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type q_plugin_card() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user_app_item() :: %{
"appArn" => String.t() | atom(),
"appId" => String.t() | atom(),
"canEdit" => [boolean()],
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"isVerified" => [boolean()],
"status" => [String.t() | atom()],
"title" => String.t() | atom()
}
"""
@type user_app_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_session_metadata_output() :: %{
"sessionArn" => [String.t() | atom()],
"sessionId" => String.t() | atom(),
"sessionName" => String.t() | atom(),
"sharingConfiguration" => session_sharing_configuration()
}
"""
@type update_q_app_session_metadata_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
app_definition() :: %{
"appDefinitionVersion" => [String.t() | atom()],
"canEdit" => [boolean()],
"cards" => list(list())
}
"""
@type app_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_q_apps_output() :: %{
"apps" => list(user_app_item()),
"nextToken" => [String.t() | atom()]
}
"""
@type list_q_apps_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_q_app_session_data_output() :: %{
"nextToken" => [String.t() | atom()],
"sessionArn" => [String.t() | atom()],
"sessionData" => list(q_app_session_data()),
"sessionId" => String.t() | atom()
}
"""
@type list_q_app_session_data_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
describe_q_app_permissions_input() :: %{
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type describe_q_app_permissions_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
text_input_card_input() :: %{
"defaultValue" => String.t() | atom(),
"id" => String.t() | atom(),
"placeholder" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type text_input_card_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_presigned_url_input() :: %{
optional("sessionId") => String.t() | atom(),
required("appId") => String.t() | atom(),
required("cardId") => String.t() | atom(),
required("fileContentsSha256") => [String.t() | atom()],
required("fileName") => String.t() | atom(),
required("instanceId") => String.t() | atom(),
required("scope") => list(any())
}
"""
@type create_presigned_url_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_library_item_metadata_input() :: %{
optional("isVerified") => [boolean()],
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type update_library_item_metadata_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_q_app_session_data_input() :: %{
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type list_q_app_session_data_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
unauthorized_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type unauthorized_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_q_app_session_metadata_input() :: %{
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type get_q_app_session_metadata_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_create_category_input_category() :: %{
"color" => [String.t() | atom()],
"id" => String.t() | atom(),
"title" => [String.t() | atom()]
}
"""
@type batch_create_category_input_category() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
q_app_session_data() :: %{
"cardId" => String.t() | atom(),
"submissionId" => String.t() | atom(),
"timestamp" => non_neg_integer(),
"user" => user(),
"value" => [any()]
}
"""
@type q_app_session_data() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_q_app_session_data_output() :: %{
"csvFileLink" => [String.t() | atom()],
"expiresAt" => non_neg_integer(),
"sessionArn" => [String.t() | atom()]
}
"""
@type export_q_app_session_data_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
import_document_output() :: %{
"fileId" => [String.t() | atom()]
}
"""
@type import_document_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_q_app_session_output() :: %{
"sessionArn" => [String.t() | atom()],
"sessionId" => [String.t() | atom()]
}
"""
@type start_q_app_session_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => [String.t() | atom()],
"retryAfterSeconds" => [integer()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
category_input() :: %{
"color" => [String.t() | atom()],
"id" => String.t() | atom(),
"title" => [String.t() | atom()]
}
"""
@type category_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_q_app_with_user_input() :: %{
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type associate_q_app_with_user_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
predict_app_definition() :: %{
"appDefinition" => app_definition_input(),
"description" => String.t() | atom(),
"title" => String.t() | atom()
}
"""
@type predict_app_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_q_app_input() :: %{
optional("description") => String.t() | atom(),
optional("tags") => map(),
required("appDefinition") => app_definition_input(),
required("instanceId") => String.t() | atom(),
required("title") => String.t() | atom()
}
"""
@type create_q_app_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_permissions_output() :: %{
"appId" => [String.t() | atom()],
"permissions" => list(permission_output()),
"resourceArn" => [String.t() | atom()]
}
"""
@type update_q_app_permissions_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_q_app_input() :: %{
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type delete_q_app_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
user() :: %{
"userId" => String.t() | atom()
}
"""
@type user() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => map()
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_card_input() :: %{
"computeMode" => list(any()),
"id" => String.t() | atom(),
"metadata" => form_input_card_metadata(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type form_input_card_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
q_query_card_input() :: %{
"attributeFilter" => attribute_filter(),
"id" => String.t() | atom(),
"outputSource" => list(any()),
"prompt" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type q_query_card_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_library_item_output() :: %{
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"isVerified" => [boolean()],
"libraryItemId" => String.t() | atom(),
"ratingCount" => [integer()],
"status" => [String.t() | atom()],
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()]
}
"""
@type create_library_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
card_status() :: %{
"currentState" => list(any()),
"currentValue" => [String.t() | atom()],
"submissions" => list(submission())
}
"""
@type card_status() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
stop_q_app_session_input() :: %{
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type stop_q_app_session_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_q_app_session_output() :: %{
"appVersion" => integer(),
"cardStatus" => map(),
"latestPublishedAppVersion" => integer(),
"sessionArn" => [String.t() | atom()],
"sessionId" => [String.t() | atom()],
"sessionName" => String.t() | atom(),
"status" => list(any()),
"userIsHost" => [boolean()]
}
"""
@type get_q_app_session_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_delete_category_input() :: %{
required("categories") => list(String.t() | atom()),
required("instanceId") => String.t() | atom()
}
"""
@type batch_delete_category_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_library_items_input() :: %{
optional("categoryId") => String.t() | atom(),
optional("limit") => integer(),
optional("nextToken") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type list_library_items_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_session_output() :: %{
"sessionArn" => [String.t() | atom()],
"sessionId" => [String.t() | atom()]
}
"""
@type update_q_app_session_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
library_item_member() :: %{
"appId" => String.t() | atom(),
"appVersion" => integer(),
"categories" => list(category()),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"isRatedByUser" => [boolean()],
"isVerified" => [boolean()],
"libraryItemId" => String.t() | atom(),
"ratingCount" => [integer()],
"status" => [String.t() | atom()],
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()],
"userCount" => [integer()]
}
"""
@type library_item_member() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_library_item_input() :: %{
required("appId") => String.t() | atom(),
required("appVersion") => integer(),
required("categories") => list(String.t() | atom()),
required("instanceId") => String.t() | atom()
}
"""
@type create_library_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
card_value() :: %{
"cardId" => String.t() | atom(),
"submissionMutation" => submission_mutation(),
"value" => [String.t() | atom()]
}
"""
@type card_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
associate_library_item_review_input() :: %{
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type associate_library_item_review_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_q_app_session_metadata_output() :: %{
"sessionArn" => [String.t() | atom()],
"sessionId" => String.t() | atom(),
"sessionName" => String.t() | atom(),
"sessionOwner" => [boolean()],
"sharingConfiguration" => session_sharing_configuration()
}
"""
@type get_q_app_session_metadata_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_permissions_input() :: %{
optional("grantPermissions") => list(permission_input()),
optional("revokePermissions") => list(permission_input()),
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type update_q_app_permissions_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_categories_input() :: %{
required("instanceId") => String.t() | atom()
}
"""
@type list_categories_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
attribute_filter() :: %{
"andAllFilters" => list(attribute_filter()),
"containsAll" => document_attribute(),
"containsAny" => document_attribute(),
"equalsTo" => document_attribute(),
"greaterThan" => document_attribute(),
"greaterThanOrEquals" => document_attribute(),
"lessThan" => document_attribute(),
"lessThanOrEquals" => document_attribute(),
"notFilter" => attribute_filter(),
"orAllFilters" => list(attribute_filter())
}
"""
@type attribute_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_library_items_output() :: %{
"libraryItems" => list(library_item_member()),
"nextToken" => [String.t() | atom()]
}
"""
@type list_library_items_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_q_app_input() :: %{
optional("appVersion") => integer(),
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type get_q_app_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
principal_output() :: %{
"email" => [String.t() | atom()],
"userId" => [String.t() | atom()],
"userType" => list(any())
}
"""
@type principal_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
session_sharing_configuration() :: %{
"acceptResponses" => boolean(),
"enabled" => boolean(),
"revealCards" => boolean()
}
"""
@type session_sharing_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_library_item_input() :: %{
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type delete_library_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_session_metadata_input() :: %{
optional("sessionName") => String.t() | atom(),
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom(),
required("sharingConfiguration") => session_sharing_configuration()
}
"""
@type update_q_app_session_metadata_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
submission() :: %{
"submissionId" => String.t() | atom(),
"timestamp" => non_neg_integer(),
"value" => [any()]
}
"""
@type submission() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
disassociate_q_app_from_user_input() :: %{
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type disassociate_q_app_from_user_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_presigned_url_output() :: %{
"fileId" => [String.t() | atom()],
"presignedUrl" => [String.t() | atom()],
"presignedUrlExpiration" => non_neg_integer(),
"presignedUrlFields" => map()
}
"""
@type create_presigned_url_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
q_query_card() :: %{
"attributeFilter" => attribute_filter(),
"dependencies" => list([String.t() | atom()]()),
"id" => String.t() | atom(),
"memoryReferences" => list([String.t() | atom()]()),
"outputSource" => list(any()),
"prompt" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type q_query_card() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => map()
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_q_app_session_data_input() :: %{
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type export_q_app_session_data_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
file_upload_card_input() :: %{
"allowOverride" => [boolean()],
"fileId" => String.t() | atom(),
"filename" => String.t() | atom(),
"id" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type file_upload_card_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_card_metadata() :: %{
"schema" => any()
}
"""
@type form_input_card_metadata() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
text_input_card() :: %{
"defaultValue" => String.t() | atom(),
"dependencies" => list([String.t() | atom()]()),
"id" => String.t() | atom(),
"placeholder" => String.t() | atom(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type text_input_card() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_library_item_output() :: %{
"appId" => String.t() | atom(),
"appVersion" => integer(),
"categories" => list(category()),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"isRatedByUser" => [boolean()],
"isVerified" => [boolean()],
"libraryItemId" => String.t() | atom(),
"ratingCount" => [integer()],
"status" => [String.t() | atom()],
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()],
"userCount" => [integer()]
}
"""
@type get_library_item_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
predict_q_app_input() :: %{
optional("options") => list(),
required("instanceId") => String.t() | atom()
}
"""
@type predict_q_app_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
document_attribute() :: %{
"name" => String.t() | atom(),
"value" => list()
}
"""
@type document_attribute() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
conversation_message() :: %{
"body" => [String.t() | atom()],
"type" => list(any())
}
"""
@type conversation_message() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
submission_mutation() :: %{
"mutationType" => list(any()),
"submissionId" => String.t() | atom()
}
"""
@type submission_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_update_category_input() :: %{
required("categories") => list(category_input()),
required("instanceId") => String.t() | atom()
}
"""
@type batch_update_category_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_session_input() :: %{
optional("values") => list(card_value()),
required("instanceId") => String.t() | atom(),
required("sessionId") => String.t() | atom()
}
"""
@type update_q_app_session_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
app_definition_input() :: %{
"cards" => list(list()),
"initialPrompt" => String.t() | atom()
}
"""
@type app_definition_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
category() :: %{
"appCount" => [integer()],
"color" => [String.t() | atom()],
"id" => String.t() | atom(),
"title" => [String.t() | atom()]
}
"""
@type category() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_q_app_input() :: %{
optional("appDefinition") => app_definition_input(),
optional("description") => String.t() | atom(),
optional("title") => String.t() | atom(),
required("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom()
}
"""
@type update_q_app_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_library_item_input() :: %{
optional("appId") => String.t() | atom(),
required("instanceId") => String.t() | atom(),
required("libraryItemId") => String.t() | atom()
}
"""
@type get_library_item_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
predict_q_app_output() :: %{
"app" => predict_app_definition(),
"problemStatement" => [String.t() | atom()]
}
"""
@type predict_q_app_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_q_app_output() :: %{
"appArn" => String.t() | atom(),
"appId" => String.t() | atom(),
"appVersion" => integer(),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"description" => String.t() | atom(),
"initialPrompt" => String.t() | atom(),
"requiredCapabilities" => list(list(any())()),
"status" => list(any()),
"title" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()]
}
"""
@type create_q_app_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
permission_output() :: %{
"action" => list(any()),
"principal" => principal_output()
}
"""
@type permission_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
permission_input() :: %{
"action" => list(any()),
"principal" => [String.t() | atom()]
}
"""
@type permission_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_create_category_input() :: %{
required("categories") => list(batch_create_category_input_category()),
required("instanceId") => String.t() | atom()
}
"""
@type batch_create_category_input() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
get_q_app_output() :: %{
"appArn" => String.t() | atom(),
"appDefinition" => app_definition(),
"appId" => String.t() | atom(),
"appVersion" => integer(),
"createdAt" => non_neg_integer(),
"createdBy" => [String.t() | atom()],
"description" => String.t() | atom(),
"initialPrompt" => String.t() | atom(),
"requiredCapabilities" => list(list(any())()),
"status" => list(any()),
"title" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"updatedBy" => [String.t() | atom()]
}
"""
@type get_q_app_output() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
content_too_large_exception() :: %{
"message" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type content_too_large_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => [String.t() | atom()],
"quotaCode" => [String.t() | atom()],
"resourceId" => [String.t() | atom()],
"resourceType" => [String.t() | atom()],
"serviceCode" => [String.t() | atom()]
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
form_input_card() :: %{
"computeMode" => list(any()),
"dependencies" => list([String.t() | atom()]()),
"id" => String.t() | atom(),
"metadata" => form_input_card_metadata(),
"title" => String.t() | atom(),
"type" => list(any())
}
"""
@type form_input_card() :: %{(String.t() | atom()) => any()}
@type associate_library_item_review_errors() ::
service_quota_exceeded_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type associate_q_app_with_user_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type batch_create_category_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type batch_delete_category_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type batch_update_category_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type create_library_item_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type create_presigned_url_errors() ::
internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type create_q_app_errors() ::
service_quota_exceeded_exception()
| content_too_large_exception()
| conflict_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type delete_library_item_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type delete_q_app_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type describe_q_app_permissions_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type disassociate_library_item_review_errors() ::
service_quota_exceeded_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type disassociate_q_app_from_user_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type export_q_app_session_data_errors() ::
service_quota_exceeded_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type get_library_item_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type get_q_app_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type get_q_app_session_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type get_q_app_session_metadata_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type import_document_errors() ::
service_quota_exceeded_exception()
| content_too_large_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type list_categories_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type list_library_items_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type list_q_app_session_data_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type list_q_apps_errors() ::
internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type list_tags_for_resource_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| access_denied_exception()
| throttling_exception()
@type predict_q_app_errors() ::
internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type start_q_app_session_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type stop_q_app_session_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type tag_resource_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| access_denied_exception()
| throttling_exception()
@type untag_resource_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| access_denied_exception()
| throttling_exception()
@type update_library_item_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type update_library_item_metadata_errors() ::
conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type update_q_app_errors() ::
content_too_large_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type update_q_app_permissions_errors() ::
resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type update_q_app_session_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
@type update_q_app_session_metadata_errors() ::
service_quota_exceeded_exception()
| resource_not_found_exception()
| internal_server_exception()
| validation_exception()
| unauthorized_exception()
| access_denied_exception()
| throttling_exception()
def metadata do
%{
api_version: "2023-11-27",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "data.qapps",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "QApps",
signature_version: "v4",
signing_name: "qapps",
target_prefix: nil
}
end
@doc """
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.
"""
@spec associate_library_item_review(map(), associate_library_item_review_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_library_item_review_errors()}
def associate_library_item_review(%Client{} = client, input, options \\ []) do
url_path = "/catalog.associateItemRating"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec associate_q_app_with_user(map(), associate_q_app_with_user_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, associate_q_app_with_user_errors()}
def associate_q_app_with_user(%Client{} = client, input, options \\ []) do
url_path = "/apps.install"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates Categories for the Amazon Q Business application environment instance.
Web experience users use Categories to tag and filter library items. For more
information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html).
"""
@spec batch_create_category(map(), batch_create_category_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_create_category_errors()}
def batch_create_category(%Client{} = client, input, options \\ []) do
url_path = "/catalog.createCategories"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes Categories for the Amazon Q Business application environment instance.
Web experience users use Categories to tag and filter library items. For more
information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html).
"""
@spec batch_delete_category(map(), batch_delete_category_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_delete_category_errors()}
def batch_delete_category(%Client{} = client, input, options \\ []) do
url_path = "/catalog.deleteCategories"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates Categories for the Amazon Q Business application environment instance.
Web experience users use Categories to tag and filter library items. For more
information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html).
"""
@spec batch_update_category(map(), batch_update_category_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_update_category_errors()}
def batch_update_category(%Client{} = client, input, options \\ []) do
url_path = "/catalog.updateCategories"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new library item for an Amazon Q App, allowing it to be discovered and
used by other allowed users.
"""
@spec create_library_item(map(), create_library_item_input(), list()) ::
{:ok, create_library_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_library_item_errors()}
def create_library_item(%Client{} = client, input, options \\ []) do
url_path = "/catalog.createItem"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a presigned URL for an S3 POST operation to upload a file.
You can use this URL to set a default file for a `FileUploadCard` in a Q App
definition or to provide a file for a single Q App run. The `scope` parameter
determines how the file will be used, either at the app definition level or the
app session level.
The IAM permissions are derived from the `qapps:ImportDocument` action. For more
information on the IAM policy for Amazon Q Apps, see [IAM permissions for using Amazon Q
Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-q-apps-iam-permissions.html).
"""
@spec create_presigned_url(map(), create_presigned_url_input(), list()) ::
{:ok, create_presigned_url_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_presigned_url_errors()}
def create_presigned_url(%Client{} = client, input, options \\ []) do
url_path = "/apps.createPresignedUrl"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_q_app(map(), create_q_app_input(), list()) ::
{:ok, create_q_app_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_q_app_errors()}
def create_q_app(%Client{} = client, input, options \\ []) do
url_path = "/apps.create"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_library_item(map(), delete_library_item_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_library_item_errors()}
def delete_library_item(%Client{} = client, input, options \\ []) do
url_path = "/catalog.deleteItem"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec delete_q_app(map(), delete_q_app_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_q_app_errors()}
def delete_q_app(%Client{} = client, input, options \\ []) do
url_path = "/apps.delete"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Describes read permissions for a Amazon Q App in Amazon Q Business application
environment instance.
"""
@spec describe_q_app_permissions(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, describe_q_app_permissions_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, describe_q_app_permissions_errors()}
def describe_q_app_permissions(%Client{} = client, app_id, instance_id, options \\ []) do
url_path = "/apps.describeQAppPermissions"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(app_id) do
[{"appId", app_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Removes a rating or review previously submitted by the user for a library item.
"""
@spec disassociate_library_item_review(map(), disassociate_library_item_review_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_library_item_review_errors()}
def disassociate_library_item_review(%Client{} = client, input, options \\ []) do
url_path = "/catalog.disassociateItemRating"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates a Q App from a user removing the user's access to run the Q App.
"""
@spec disassociate_q_app_from_user(map(), disassociate_q_app_from_user_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, disassociate_q_app_from_user_errors()}
def disassociate_q_app_from_user(%Client{} = client, input, options \\ []) do
url_path = "/apps.uninstall"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Exports the collected data of a Q App data collection session.
"""
@spec export_q_app_session_data(map(), export_q_app_session_data_input(), list()) ::
{:ok, export_q_app_session_data_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_q_app_session_data_errors()}
def export_q_app_session_data(%Client{} = client, input, options \\ []) do
url_path = "/runtime.exportQAppSessionData"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves details about a library item for an Amazon Q App, including its
metadata, categories, ratings, and usage statistics.
"""
@spec get_library_item(
map(),
String.t() | atom() | nil,
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_library_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_library_item_errors()}
def get_library_item(
%Client{} = client,
app_id \\ nil,
library_item_id,
instance_id,
options \\ []
) do
url_path = "/catalog.getItem"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(library_item_id) do
[{"libraryItemId", library_item_id} | query_params]
else
query_params
end
query_params =
if !is_nil(app_id) do
[{"appId", app_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the full details of an Q App, including its definition specifying the
cards and flow.
"""
@spec get_q_app(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, get_q_app_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_q_app_errors()}
def get_q_app(%Client{} = client, app_id, app_version \\ nil, instance_id, options \\ []) do
url_path = "/apps.get"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(app_version) do
[{"appVersion", app_version} | query_params]
else
query_params
end
query_params =
if !is_nil(app_id) do
[{"appId", app_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the current state and results for an active session of an Amazon Q
App.
"""
@spec get_q_app_session(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_q_app_session_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_q_app_session_errors()}
def get_q_app_session(%Client{} = client, session_id, instance_id, options \\ []) do
url_path = "/runtime.getQAppSession"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(session_id) do
[{"sessionId", session_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the current configuration of a Q App session.
"""
@spec get_q_app_session_metadata(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, get_q_app_session_metadata_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_q_app_session_metadata_errors()}
def get_q_app_session_metadata(%Client{} = client, session_id, instance_id, options \\ []) do
url_path = "/runtime.getQAppSessionMetadata"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(session_id) do
[{"sessionId", session_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec import_document(map(), import_document_input(), list()) ::
{:ok, import_document_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, import_document_errors()}
def import_document(%Client{} = client, input, options \\ []) do
url_path = "/apps.importDocument"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists the categories of a Amazon Q Business application environment instance.
For more information, see [Custom labels for Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html).
"""
@spec list_categories(map(), String.t() | atom(), list()) ::
{:ok, list_categories_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_categories_errors()}
def list_categories(%Client{} = client, instance_id, options \\ []) do
url_path = "/catalog.listCategories"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the library items for Amazon Q Apps that are published and available for
users in your Amazon Web Services account.
"""
@spec list_library_items(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_library_items_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_library_items_errors()}
def list_library_items(
%Client{} = client,
category_id \\ nil,
limit \\ nil,
next_token \\ nil,
instance_id,
options \\ []
) do
url_path = "/catalog.list"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(limit) do
[{"limit", limit} | query_params]
else
query_params
end
query_params =
if !is_nil(category_id) do
[{"categoryId", category_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the collected data of a Q App data collection session.
"""
@spec list_q_app_session_data(map(), String.t() | atom(), String.t() | atom(), list()) ::
{:ok, list_q_app_session_data_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_q_app_session_data_errors()}
def list_q_app_session_data(%Client{} = client, session_id, instance_id, options \\ []) do
url_path = "/runtime.listQAppSessionData"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(session_id) do
[{"sessionId", session_id} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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..
"""
@spec list_q_apps(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom(),
list()
) ::
{:ok, list_q_apps_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_q_apps_errors()}
def list_q_apps(%Client{} = client, limit \\ nil, next_token \\ nil, instance_id, options \\ []) do
url_path = "/apps.list"
headers = []
headers =
if !is_nil(instance_id) do
[{"instance-id", instance_id} | headers]
else
headers
end
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(limit) do
[{"limit", limit} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the tags associated with an Amazon Q Apps resource.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec predict_q_app(map(), predict_q_app_input(), list()) ::
{:ok, predict_q_app_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, predict_q_app_errors()}
def predict_q_app(%Client{} = client, input, options \\ []) do
url_path = "/apps.predictQApp"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec start_q_app_session(map(), start_q_app_session_input(), list()) ::
{:ok, start_q_app_session_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_q_app_session_errors()}
def start_q_app_session(%Client{} = client, input, options \\ []) do
url_path = "/runtime.startQAppSession"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec stop_q_app_session(map(), stop_q_app_session_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_q_app_session_errors()}
def stop_q_app_session(%Client{} = client, input, options \\ []) do
url_path = "/runtime.deleteMiniAppRun"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associates tags with an Amazon Q Apps resource.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Disassociates tags from an Amazon Q Apps resource.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the library item for an Amazon Q App.
"""
@spec update_library_item(map(), update_library_item_input(), list()) ::
{:ok, update_library_item_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_library_item_errors()}
def update_library_item(%Client{} = client, input, options \\ []) do
url_path = "/catalog.updateItem"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the verification status of a library item for an Amazon Q App.
"""
@spec update_library_item_metadata(map(), update_library_item_metadata_input(), list()) ::
{:ok, nil, any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_library_item_metadata_errors()}
def update_library_item_metadata(%Client{} = client, input, options \\ []) do
url_path = "/catalog.updateItemMetadata"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing Amazon Q App, allowing modifications to its title,
description, and definition.
"""
@spec update_q_app(map(), update_q_app_input(), list()) ::
{:ok, update_q_app_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_q_app_errors()}
def update_q_app(%Client{} = client, input, options \\ []) do
url_path = "/apps.update"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates read permissions for a Amazon Q App in Amazon Q Business application
environment instance.
"""
@spec update_q_app_permissions(map(), update_q_app_permissions_input(), list()) ::
{:ok, update_q_app_permissions_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_q_app_permissions_errors()}
def update_q_app_permissions(%Client{} = client, input, options \\ []) do
url_path = "/apps.updateQAppPermissions"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec update_q_app_session(map(), update_q_app_session_input(), list()) ::
{:ok, update_q_app_session_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_q_app_session_errors()}
def update_q_app_session(%Client{} = client, input, options \\ []) do
url_path = "/runtime.updateQAppSession"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the configuration metadata of a session for a given Q App `sessionId`.
"""
@spec update_q_app_session_metadata(map(), update_q_app_session_metadata_input(), list()) ::
{:ok, update_q_app_session_metadata_output(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_q_app_session_metadata_errors()}
def update_q_app_session_metadata(%Client{} = client, input, options \\ []) do
url_path = "/runtime.updateQAppSessionMetadata"
{headers, input} =
[
{"instanceId", "instance-id"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end