QAppsClient#
Auto-generated documentation for QApps type annotations stubs module mypy-boto3-qapps.
QAppsClient#
Type annotations and code completion for boto3.client("qapps").
boto3 documentation
# QAppsClient usage example
from boto3.session import Session
from mypy_boto3_qapps.client import QAppsClient
def get_qapps_client() -> QAppsClient:
return Session().client("qapps")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("qapps").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("qapps")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ContentTooLargeException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.UnauthorizedException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_qapps.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("qapps").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("qapps").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...associate_library_item_review#
Associates a rating or review for a library item with the user submitting the request.
Type annotations and code completion for boto3.client("qapps").associate_library_item_review method.
boto3 documentation
# associate_library_item_review method definition
def associate_library_item_review(
self,
*,
instanceId: str,
libraryItemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_library_item_review method usage example with argument unpacking
kwargs: AssociateLibraryItemReviewInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.associate_library_item_review(**kwargs)associate_q_app_with_user#
This operation creates a link between the user's identity calling the operation and a specific Q App.
Type annotations and code completion for boto3.client("qapps").associate_q_app_with_user method.
boto3 documentation
# associate_q_app_with_user method definition
def associate_q_app_with_user(
self,
*,
instanceId: str,
appId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# associate_q_app_with_user method usage example with argument unpacking
kwargs: AssociateQAppWithUserInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.associate_q_app_with_user(**kwargs)batch_create_category#
Creates Categories for the Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").batch_create_category method.
boto3 documentation
# batch_create_category method definition
def batch_create_category(
self,
*,
instanceId: str,
categories: Sequence[BatchCreateCategoryInputCategoryTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# batch_create_category method usage example with argument unpacking
kwargs: BatchCreateCategoryInputRequestTypeDef = { # (1)
"instanceId": ...,
"categories": ...,
}
parent.batch_create_category(**kwargs)batch_delete_category#
Deletes Categories for the Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").batch_delete_category method.
boto3 documentation
# batch_delete_category method definition
def batch_delete_category(
self,
*,
instanceId: str,
categories: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# batch_delete_category method usage example with argument unpacking
kwargs: BatchDeleteCategoryInputRequestTypeDef = { # (1)
"instanceId": ...,
"categories": ...,
}
parent.batch_delete_category(**kwargs)batch_update_category#
Updates Categories for the Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").batch_update_category method.
boto3 documentation
# batch_update_category method definition
def batch_update_category(
self,
*,
instanceId: str,
categories: Sequence[CategoryInputTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# batch_update_category method usage example with argument unpacking
kwargs: BatchUpdateCategoryInputRequestTypeDef = { # (1)
"instanceId": ...,
"categories": ...,
}
parent.batch_update_category(**kwargs)create_library_item#
Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users.
Type annotations and code completion for boto3.client("qapps").create_library_item method.
boto3 documentation
# create_library_item method definition
def create_library_item(
self,
*,
instanceId: str,
appId: str,
appVersion: int,
categories: Sequence[str],
) -> CreateLibraryItemOutputTypeDef: # (1)
...# create_library_item method usage example with argument unpacking
kwargs: CreateLibraryItemInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
"appVersion": ...,
"categories": ...,
}
parent.create_library_item(**kwargs)create_presigned_url#
Creates a presigned URL for an S3 POST operation to upload a file.
Type annotations and code completion for boto3.client("qapps").create_presigned_url method.
boto3 documentation
# create_presigned_url method definition
def create_presigned_url(
self,
*,
instanceId: str,
cardId: str,
appId: str,
fileContentsSha256: str,
fileName: str,
scope: DocumentScopeType, # (1)
sessionId: str = ...,
) -> CreatePresignedUrlOutputTypeDef: # (2)
...# create_presigned_url method usage example with argument unpacking
kwargs: CreatePresignedUrlInputRequestTypeDef = { # (1)
"instanceId": ...,
"cardId": ...,
"appId": ...,
"fileContentsSha256": ...,
"fileName": ...,
"scope": ...,
}
parent.create_presigned_url(**kwargs)create_q_app#
Creates a new Amazon Q App based on the provided definition.
Type annotations and code completion for boto3.client("qapps").create_q_app method.
boto3 documentation
# create_q_app method definition
def create_q_app(
self,
*,
instanceId: str,
title: str,
appDefinition: AppDefinitionInputTypeDef, # (1)
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateQAppOutputTypeDef: # (2)
...# create_q_app method usage example with argument unpacking
kwargs: CreateQAppInputRequestTypeDef = { # (1)
"instanceId": ...,
"title": ...,
"appDefinition": ...,
}
parent.create_q_app(**kwargs)delete_library_item#
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.
Type annotations and code completion for boto3.client("qapps").delete_library_item method.
boto3 documentation
# delete_library_item method definition
def delete_library_item(
self,
*,
instanceId: str,
libraryItemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_library_item method usage example with argument unpacking
kwargs: DeleteLibraryItemInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.delete_library_item(**kwargs)delete_q_app#
Deletes an Amazon Q App owned by the user.
Type annotations and code completion for boto3.client("qapps").delete_q_app method.
boto3 documentation
# delete_q_app method definition
def delete_q_app(
self,
*,
instanceId: str,
appId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_q_app method usage example with argument unpacking
kwargs: DeleteQAppInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.delete_q_app(**kwargs)describe_q_app_permissions#
Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").describe_q_app_permissions method.
boto3 documentation
# describe_q_app_permissions method definition
def describe_q_app_permissions(
self,
*,
instanceId: str,
appId: str,
) -> DescribeQAppPermissionsOutputTypeDef: # (1)
...# describe_q_app_permissions method usage example with argument unpacking
kwargs: DescribeQAppPermissionsInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.describe_q_app_permissions(**kwargs)disassociate_library_item_review#
Removes a rating or review previously submitted by the user for a library item.
Type annotations and code completion for boto3.client("qapps").disassociate_library_item_review method.
boto3 documentation
# disassociate_library_item_review method definition
def disassociate_library_item_review(
self,
*,
instanceId: str,
libraryItemId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_library_item_review method usage example with argument unpacking
kwargs: DisassociateLibraryItemReviewInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.disassociate_library_item_review(**kwargs)disassociate_q_app_from_user#
Disassociates a Q App from a user removing the user's access to run the Q App.
Type annotations and code completion for boto3.client("qapps").disassociate_q_app_from_user method.
boto3 documentation
# disassociate_q_app_from_user method definition
def disassociate_q_app_from_user(
self,
*,
instanceId: str,
appId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disassociate_q_app_from_user method usage example with argument unpacking
kwargs: DisassociateQAppFromUserInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.disassociate_q_app_from_user(**kwargs)export_q_app_session_data#
Exports the collected data of a Q App data collection session.
Type annotations and code completion for boto3.client("qapps").export_q_app_session_data method.
boto3 documentation
# export_q_app_session_data method definition
def export_q_app_session_data(
self,
*,
instanceId: str,
sessionId: str,
) -> ExportQAppSessionDataOutputTypeDef: # (1)
...# export_q_app_session_data method usage example with argument unpacking
kwargs: ExportQAppSessionDataInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.export_q_app_session_data(**kwargs)get_library_item#
Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics.
Type annotations and code completion for boto3.client("qapps").get_library_item method.
boto3 documentation
# get_library_item method definition
def get_library_item(
self,
*,
instanceId: str,
libraryItemId: str,
appId: str = ...,
) -> GetLibraryItemOutputTypeDef: # (1)
...# get_library_item method usage example with argument unpacking
kwargs: GetLibraryItemInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.get_library_item(**kwargs)get_q_app#
Retrieves the full details of an Q App, including its definition specifying the cards and flow.
Type annotations and code completion for boto3.client("qapps").get_q_app method.
boto3 documentation
# get_q_app method definition
def get_q_app(
self,
*,
instanceId: str,
appId: str,
appVersion: int = ...,
) -> GetQAppOutputTypeDef: # (1)
...# get_q_app method usage example with argument unpacking
kwargs: GetQAppInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.get_q_app(**kwargs)get_q_app_session#
Retrieves the current state and results for an active session of an Amazon Q App.
Type annotations and code completion for boto3.client("qapps").get_q_app_session method.
boto3 documentation
# get_q_app_session method definition
def get_q_app_session(
self,
*,
instanceId: str,
sessionId: str,
) -> GetQAppSessionOutputTypeDef: # (1)
...# get_q_app_session method usage example with argument unpacking
kwargs: GetQAppSessionInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.get_q_app_session(**kwargs)get_q_app_session_metadata#
Retrieves the current configuration of a Q App session.
Type annotations and code completion for boto3.client("qapps").get_q_app_session_metadata method.
boto3 documentation
# get_q_app_session_metadata method definition
def get_q_app_session_metadata(
self,
*,
instanceId: str,
sessionId: str,
) -> GetQAppSessionMetadataOutputTypeDef: # (1)
...# get_q_app_session_metadata method usage example with argument unpacking
kwargs: GetQAppSessionMetadataInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.get_q_app_session_metadata(**kwargs)import_document#
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.
Type annotations and code completion for boto3.client("qapps").import_document method.
boto3 documentation
# import_document method definition
def import_document(
self,
*,
instanceId: str,
cardId: str,
appId: str,
fileContentsBase64: str,
fileName: str,
scope: DocumentScopeType, # (1)
sessionId: str = ...,
) -> ImportDocumentOutputTypeDef: # (2)
...# import_document method usage example with argument unpacking
kwargs: ImportDocumentInputRequestTypeDef = { # (1)
"instanceId": ...,
"cardId": ...,
"appId": ...,
"fileContentsBase64": ...,
"fileName": ...,
"scope": ...,
}
parent.import_document(**kwargs)list_categories#
Lists the categories of a Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").list_categories method.
boto3 documentation
# list_categories method definition
def list_categories(
self,
*,
instanceId: str,
) -> ListCategoriesOutputTypeDef: # (1)
...# list_categories method usage example with argument unpacking
kwargs: ListCategoriesInputRequestTypeDef = { # (1)
"instanceId": ...,
}
parent.list_categories(**kwargs)list_library_items#
Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account.
Type annotations and code completion for boto3.client("qapps").list_library_items method.
boto3 documentation
# list_library_items method definition
def list_library_items(
self,
*,
instanceId: str,
limit: int = ...,
nextToken: str = ...,
categoryId: str = ...,
) -> ListLibraryItemsOutputTypeDef: # (1)
...# list_library_items method usage example with argument unpacking
kwargs: ListLibraryItemsInputRequestTypeDef = { # (1)
"instanceId": ...,
}
parent.list_library_items(**kwargs)list_q_app_session_data#
Lists the collected data of a Q App data collection session.
Type annotations and code completion for boto3.client("qapps").list_q_app_session_data method.
boto3 documentation
# list_q_app_session_data method definition
def list_q_app_session_data(
self,
*,
instanceId: str,
sessionId: str,
) -> ListQAppSessionDataOutputTypeDef: # (1)
...# list_q_app_session_data method usage example with argument unpacking
kwargs: ListQAppSessionDataInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.list_q_app_session_data(**kwargs)list_q_apps#
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.
Type annotations and code completion for boto3.client("qapps").list_q_apps method.
boto3 documentation
# list_q_apps method definition
def list_q_apps(
self,
*,
instanceId: str,
limit: int = ...,
nextToken: str = ...,
) -> ListQAppsOutputTypeDef: # (1)
...# list_q_apps method usage example with argument unpacking
kwargs: ListQAppsInputRequestTypeDef = { # (1)
"instanceId": ...,
}
parent.list_q_apps(**kwargs)list_tags_for_resource#
Lists the tags associated with an Amazon Q Apps resource.
Type annotations and code completion for boto3.client("qapps").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)predict_q_app#
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.
Type annotations and code completion for boto3.client("qapps").predict_q_app method.
boto3 documentation
# predict_q_app method definition
def predict_q_app(
self,
*,
instanceId: str,
options: PredictQAppInputOptionsTypeDef = ..., # (1)
) -> PredictQAppOutputTypeDef: # (2)
...# predict_q_app method usage example with argument unpacking
kwargs: PredictQAppInputRequestTypeDef = { # (1)
"instanceId": ...,
}
parent.predict_q_app(**kwargs)start_q_app_session#
Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run.
Type annotations and code completion for boto3.client("qapps").start_q_app_session method.
boto3 documentation
# start_q_app_session method definition
def start_q_app_session(
self,
*,
instanceId: str,
appId: str,
appVersion: int,
initialValues: Sequence[CardValueTypeDef] = ..., # (1)
sessionId: str = ...,
tags: Mapping[str, str] = ...,
) -> StartQAppSessionOutputTypeDef: # (2)
...# start_q_app_session method usage example with argument unpacking
kwargs: StartQAppSessionInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
"appVersion": ...,
}
parent.start_q_app_session(**kwargs)stop_q_app_session#
Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses.
Type annotations and code completion for boto3.client("qapps").stop_q_app_session method.
boto3 documentation
# stop_q_app_session method definition
def stop_q_app_session(
self,
*,
instanceId: str,
sessionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# stop_q_app_session method usage example with argument unpacking
kwargs: StopQAppSessionInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.stop_q_app_session(**kwargs)tag_resource#
Associates tags with an Amazon Q Apps resource.
Type annotations and code completion for boto3.client("qapps").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceARN: str,
tags: Mapping[str, str],
) -> dict[str, Any]:
...# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Disassociates tags from an Amazon Q Apps resource.
Type annotations and code completion for boto3.client("qapps").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceARN: str,
tagKeys: Sequence[str],
) -> dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceARN": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)update_library_item#
Updates the library item for an Amazon Q App.
Type annotations and code completion for boto3.client("qapps").update_library_item method.
boto3 documentation
# update_library_item method definition
def update_library_item(
self,
*,
instanceId: str,
libraryItemId: str,
status: LibraryItemStatusType = ..., # (1)
categories: Sequence[str] = ...,
) -> UpdateLibraryItemOutputTypeDef: # (2)
...# update_library_item method usage example with argument unpacking
kwargs: UpdateLibraryItemInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.update_library_item(**kwargs)update_library_item_metadata#
Updates the verification status of a library item for an Amazon Q App.
Type annotations and code completion for boto3.client("qapps").update_library_item_metadata method.
boto3 documentation
# update_library_item_metadata method definition
def update_library_item_metadata(
self,
*,
instanceId: str,
libraryItemId: str,
isVerified: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# update_library_item_metadata method usage example with argument unpacking
kwargs: UpdateLibraryItemMetadataInputRequestTypeDef = { # (1)
"instanceId": ...,
"libraryItemId": ...,
}
parent.update_library_item_metadata(**kwargs)update_q_app#
Updates an existing Amazon Q App, allowing modifications to its title, description, and definition.
Type annotations and code completion for boto3.client("qapps").update_q_app method.
boto3 documentation
# update_q_app method definition
def update_q_app(
self,
*,
instanceId: str,
appId: str,
title: str = ...,
description: str = ...,
appDefinition: AppDefinitionInputTypeDef = ..., # (1)
) -> UpdateQAppOutputTypeDef: # (2)
...# update_q_app method usage example with argument unpacking
kwargs: UpdateQAppInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.update_q_app(**kwargs)update_q_app_permissions#
Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance.
Type annotations and code completion for boto3.client("qapps").update_q_app_permissions method.
boto3 documentation
# update_q_app_permissions method definition
def update_q_app_permissions(
self,
*,
instanceId: str,
appId: str,
grantPermissions: Sequence[PermissionInputTypeDef] = ..., # (1)
revokePermissions: Sequence[PermissionInputTypeDef] = ..., # (1)
) -> UpdateQAppPermissionsOutputTypeDef: # (3)
...# update_q_app_permissions method usage example with argument unpacking
kwargs: UpdateQAppPermissionsInputRequestTypeDef = { # (1)
"instanceId": ...,
"appId": ...,
}
parent.update_q_app_permissions(**kwargs)update_q_app_session#
Updates the session for a given Q App sessionId.
Type annotations and code completion for boto3.client("qapps").update_q_app_session method.
boto3 documentation
# update_q_app_session method definition
def update_q_app_session(
self,
*,
instanceId: str,
sessionId: str,
values: Sequence[CardValueTypeDef] = ..., # (1)
) -> UpdateQAppSessionOutputTypeDef: # (2)
...# update_q_app_session method usage example with argument unpacking
kwargs: UpdateQAppSessionInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
}
parent.update_q_app_session(**kwargs)update_q_app_session_metadata#
Updates the configuration metadata of a session for a given Q App
sessionId.
Type annotations and code completion for boto3.client("qapps").update_q_app_session_metadata method.
boto3 documentation
# update_q_app_session_metadata method definition
def update_q_app_session_metadata(
self,
*,
instanceId: str,
sessionId: str,
sharingConfiguration: SessionSharingConfigurationTypeDef, # (1)
sessionName: str = ...,
) -> UpdateQAppSessionMetadataOutputTypeDef: # (2)
...# update_q_app_session_metadata method usage example with argument unpacking
kwargs: UpdateQAppSessionMetadataInputRequestTypeDef = { # (1)
"instanceId": ...,
"sessionId": ...,
"sharingConfiguration": ...,
}
parent.update_q_app_session_metadata(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("qapps").get_paginator method with overloads.
client.get_paginator("list_library_items")-> ListLibraryItemsPaginatorclient.get_paginator("list_q_apps")-> ListQAppsPaginator