QApps ***** Client ====== class QApps.Client A low-level client representing QApps The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create 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 in the *Amazon Q Business User Guide*. For an overview of the Amazon Q App APIs, see Overview of Amazon Q Apps API operations. 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 in the *Amazon Q Business User Guide*. import boto3 client = boto3.client('qapps') These are the available methods: * associate_library_item_review * associate_q_app_with_user * batch_create_category * batch_delete_category * batch_update_category * can_paginate * close * create_library_item * create_presigned_url * create_q_app * delete_library_item * delete_q_app * describe_q_app_permissions * disassociate_library_item_review * disassociate_q_app_from_user * export_q_app_session_data * get_library_item * get_paginator * get_q_app * get_q_app_session * get_q_app_session_metadata * get_waiter * import_document * list_categories * list_library_items * list_q_app_session_data * list_q_apps * list_tags_for_resource * predict_q_app * start_q_app_session * stop_q_app_session * tag_resource * untag_resource * update_library_item * update_library_item_metadata * update_q_app * update_q_app_permissions * update_q_app_session * update_q_app_session_metadata Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListLibraryItems * ListQApps QApps / Paginator / ListQApps ListQApps ********* class QApps.Paginator.ListQApps paginator = client.get_paginator('list_q_apps') paginate(**kwargs) Creates an iterator that will paginate through responses from "QApps.Client.list_q_apps()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( instanceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'apps': [ { 'appId': 'string', 'appArn': 'string', 'title': 'string', 'description': 'string', 'createdAt': datetime(2015, 1, 1), 'canEdit': True|False, 'status': 'string', 'isVerified': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **apps** *(list) --* The list of Amazon Q Apps meeting the request criteria. * *(dict) --* An Amazon Q App associated with a user, either owned by the user or favorited. * **appId** *(string) --* The unique identifier of the Q App. * **appArn** *(string) --* The Amazon Resource Name (ARN) of the Q App. * **title** *(string) --* The title of the Q App. * **description** *(string) --* The description of the Q App. * **createdAt** *(datetime) --* The date and time the user's association with the Q App was created. * **canEdit** *(boolean) --* A flag indicating whether the user can edit the Q App. * **status** *(string) --* The status of the user's association with the Q App. * **isVerified** *(boolean) --* Indicates whether the Q App has been verified. * **NextToken** *(string) --* A token to resume pagination. QApps / Paginator / ListLibraryItems ListLibraryItems **************** class QApps.Paginator.ListLibraryItems paginator = client.get_paginator('list_library_items') paginate(**kwargs) Creates an iterator that will paginate through responses from "QApps.Client.list_library_items()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( instanceId='string', categoryId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **categoryId** (*string*) -- Optional category to filter the library items by. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'libraryItems': [ { 'libraryItemId': 'string', 'appId': 'string', 'appVersion': 123, 'categories': [ { 'id': 'string', 'title': 'string', 'color': 'string', 'appCount': 123 }, ], 'status': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'ratingCount': 123, 'isRatedByUser': True|False, 'userCount': 123, 'isVerified': True|False }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **libraryItems** *(list) --* The list of library items meeting the request criteria. * *(dict) --* 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. * **libraryItemId** *(string) --* The unique identifier of the library item. * **appId** *(string) --* The unique identifier of the Q App associated with the library item. * **appVersion** *(integer) --* The version of the Q App associated with the library item. * **categories** *(list) --* The categories associated with the library item. * *(dict) --* A category used to classify and filter library items for Amazon Q Apps. * **id** *(string) --* The unique identifier of the category. * **title** *(string) --* The title or name of the category. * **color** *(string) --* The color of the category * **appCount** *(integer) --* The number of published Amazon Q Apps associated with a category * **status** *(string) --* The status of the library item. * **createdAt** *(datetime) --* The date and time the library item was created. * **createdBy** *(string) --* The user who created the library item. * **updatedAt** *(datetime) --* The date and time the library item was last updated. * **updatedBy** *(string) --* The user who last updated the library item. * **ratingCount** *(integer) --* The number of ratings the library item has received. * **isRatedByUser** *(boolean) --* Whether the current user has rated the library item. * **userCount** *(integer) --* The number of users who have the associated Q App. * **isVerified** *(boolean) --* Indicates whether the library item has been verified. * **NextToken** *(string) --* A token to resume pagination. QApps / Client / disassociate_q_app_from_user disassociate_q_app_from_user **************************** QApps.Client.disassociate_q_app_from_user(**kwargs) Disassociates a Q App from a user removing the user's access to run the Q App. See also: AWS API Documentation **Request Syntax** response = client.disassociate_q_app_from_user( instanceId='string', appId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App to disassociate from the user. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / associate_q_app_with_user associate_q_app_with_user ************************* QApps.Client.associate_q_app_with_user(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.associate_q_app_with_user( instanceId='string', appId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The ID of the Amazon Q App to associate with the user. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / get_paginator get_paginator ************* QApps.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. QApps / Client / export_q_app_session_data export_q_app_session_data ************************* QApps.Client.export_q_app_session_data(**kwargs) Exports the collected data of a Q App data collection session. See also: AWS API Documentation **Request Syntax** response = client.export_q_app_session_data( instanceId='string', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App data collection session. Return type: dict Returns: **Response Syntax** { 'csvFileLink': 'string', 'expiresAt': datetime(2015, 1, 1), 'sessionArn': 'string' } **Response Structure** * *(dict) --* * **csvFileLink** *(string) --* The link where the exported Q App session data can be downloaded from. * **expiresAt** *(datetime) --* The date and time when the link for the exported Q App session data expires. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the Q App data collection session. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / can_paginate can_paginate ************ QApps.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. QApps / Client / update_q_app_permissions update_q_app_permissions ************************ QApps.Client.update_q_app_permissions(**kwargs) Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance. See also: AWS API Documentation **Request Syntax** response = client.update_q_app_permissions( instanceId='string', appId='string', grantPermissions=[ { 'action': 'read'|'write', 'principal': 'string' }, ], revokePermissions=[ { 'action': 'read'|'write', 'principal': 'string' }, ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q App for which permissions are being updated. * **grantPermissions** (*list*) -- The list of permissions to grant for the Amazon Q App. * *(dict) --* The permission to grant or revoke for a Amazon Q App. * **action** *(string) --* **[REQUIRED]** The action associated with the permission. * **principal** *(string) --* **[REQUIRED]** The principal user to which the permission applies. * **revokePermissions** (*list*) -- The list of permissions to revoke for the Amazon Q App. * *(dict) --* The permission to grant or revoke for a Amazon Q App. * **action** *(string) --* **[REQUIRED]** The action associated with the permission. * **principal** *(string) --* **[REQUIRED]** The principal user to which the permission applies. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string', 'appId': 'string', 'permissions': [ { 'action': 'read'|'write', 'principal': { 'userId': 'string', 'userType': 'owner'|'user', 'email': 'string' } }, ] } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q App for which permissions were updated. * **appId** *(string) --* The unique identifier of the Amazon Q App for which permissions were updated. * **permissions** *(list) --* The updated list of permissions for the Amazon Q App. * *(dict) --* The permission granted to the Amazon Q App. * **action** *(string) --* The action associated with the permission. * **principal** *(dict) --* The principal user to which the permission applies. * **userId** *(string) --* The unique identifier of the user. * **userType** *(string) --* The type of the user. * **email** *(string) --* The email address associated with the user. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / update_q_app update_q_app ************ QApps.Client.update_q_app(**kwargs) Updates an existing Amazon Q App, allowing modifications to its title, description, and definition. See also: AWS API Documentation **Request Syntax** response = client.update_q_app( instanceId='string', appId='string', title='string', description='string', appDefinition={ 'cards': [ { 'textInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'placeholder': 'string', 'defaultValue': 'string' }, 'qQuery': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'outputSource': 'approved-sources'|'llm', 'attributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } }, 'qPlugin': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'pluginId': 'string', 'actionIdentifier': 'string' }, 'fileUpload': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'filename': 'string', 'fileId': 'string', 'allowOverride': True|False }, 'formInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'metadata': { 'schema': {...}|[...]|123|123.4|'string'|True|None }, 'computeMode': 'append'|'replace' } }, ], 'initialPrompt': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App to update. * **title** (*string*) -- The new title for the Q App. * **description** (*string*) -- The new description for the Q App. * **appDefinition** (*dict*) -- The new definition specifying the cards and flow for the Q App. * **cards** *(list) --* **[REQUIRED]** The cards that make up the Q App definition. * *(dict) --* The properties defining an input card in an Amazon Q App. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "textInput", "qQuery", "qPlugin", "fileUpload", "formInput". * **textInput** *(dict) --* A container for the properties of the text input card. * **title** *(string) --* **[REQUIRED]** The title or label of the text input card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the text input card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **placeholder** *(string) --* The placeholder text to display in the text input field. * **defaultValue** *(string) --* The default value to pre-populate in the text input field. * **qQuery** *(dict) --* A container for the properties of the query input card. * **title** *(string) --* **[REQUIRED]** The title or label of the query card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the query card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **prompt** *(string) --* **[REQUIRED]** The prompt or instructions displayed for the query card. * **outputSource** *(string) --* The source or type of output to generate for the query card. * **attributeFilter** *(dict) --* Turns on filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an *equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a *greater than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a *greater than or equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a *less than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a *less than or equals* operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **qPlugin** *(dict) --* A container for the properties of the plugin input card. * **title** *(string) --* **[REQUIRED]** The title or label of the plugin card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the plugin card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **prompt** *(string) --* **[REQUIRED]** The prompt or instructions displayed for the plugin card. * **pluginId** *(string) --* **[REQUIRED]** The unique identifier of the plugin used by the card. * **actionIdentifier** *(string) --* The action identifier of the action to be performed by the plugin card. * **fileUpload** *(dict) --* A container for the properties of the file upload input card. * **title** *(string) --* **[REQUIRED]** The title or label of the file upload card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the file upload card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **filename** *(string) --* The default filename to use for the file upload card. * **fileId** *(string) --* The identifier of a pre-uploaded file associated with the card. * **allowOverride** *(boolean) --* A flag indicating if the user can override the default file for the upload card. * **formInput** *(dict) --* A container for the properties of the form input card. * **title** *(string) --* **[REQUIRED]** The title or label of the form input card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the form input card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **metadata** *(dict) --* **[REQUIRED]** The metadata that defines the form input card data. * **schema** (*document*) -- **[REQUIRED]** The JSON schema that defines the shape of the response data. * **computeMode** *(string) --* The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of "append" shall allow participants to submit the same form multiple times with different values. A compute mode of >>``< shall overwrite the current value for each participant. * **initialPrompt** *(string) --* The initial prompt displayed when the Q App is started. Return type: dict Returns: **Response Syntax** { 'appId': 'string', 'appArn': 'string', 'title': 'string', 'description': 'string', 'initialPrompt': 'string', 'appVersion': 123, 'status': 'PUBLISHED'|'DRAFT'|'DELETED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'requiredCapabilities': [ 'FileUpload'|'CreatorMode'|'RetrievalMode'|'PluginMode', ] } **Response Structure** * *(dict) --* * **appId** *(string) --* The unique identifier of the updated Q App. * **appArn** *(string) --* The Amazon Resource Name (ARN) of the updated Q App. * **title** *(string) --* The new title of the updated Q App. * **description** *(string) --* The new description of the updated Q App. * **initialPrompt** *(string) --* The initial prompt for the updated Q App. * **appVersion** *(integer) --* The new version of the updated Q App. * **status** *(string) --* The status of the updated Q App. * **createdAt** *(datetime) --* The date and time the Q App was originally created. * **createdBy** *(string) --* The user who originally created the Q App. * **updatedAt** *(datetime) --* The date and time the Q App was last updated. * **updatedBy** *(string) --* The user who last updated the Q App. * **requiredCapabilities** *(list) --* The capabilities required for the updated Q App. * *(string) --* **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ContentTooLargeException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / predict_q_app predict_q_app ************* QApps.Client.predict_q_app(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.predict_q_app( instanceId='string', options={ 'conversation': [ { 'body': 'string', 'type': 'USER'|'SYSTEM' }, ], 'problemStatement': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **options** (*dict*) -- The input to generate the Q App definition from, either a conversation or problem statement. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "conversation", "problemStatement". * **conversation** *(list) --* A conversation to use as input for generating the Q App definition. * *(dict) --* A message in a conversation, used as input for generating an Amazon Q App definition. * **body** *(string) --* **[REQUIRED]** The text content of the conversation message. * **type** *(string) --* **[REQUIRED]** The type of the conversation message. * **problemStatement** *(string) --* A problem statement to use as input for generating the Q App definition. Return type: dict Returns: **Response Syntax** { 'app': { 'title': 'string', 'description': 'string', 'appDefinition': { 'cards': [ { 'textInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'placeholder': 'string', 'defaultValue': 'string' }, 'qQuery': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'outputSource': 'approved-sources'|'llm', 'attributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } }, 'qPlugin': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'pluginId': 'string', 'actionIdentifier': 'string' }, 'fileUpload': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'filename': 'string', 'fileId': 'string', 'allowOverride': True|False }, 'formInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'metadata': { 'schema': {...}|[...]|123|123.4|'string'|True|None }, 'computeMode': 'append'|'replace' } }, ], 'initialPrompt': 'string' } }, 'problemStatement': 'string' } **Response Structure** * *(dict) --* * **app** *(dict) --* The generated Q App definition. * **title** *(string) --* The title of the generated Q App definition. * **description** *(string) --* The description of the generated Q App definition. * **appDefinition** *(dict) --* The definition specifying the cards and flow of the generated Q App. * **cards** *(list) --* The cards that make up the Q App definition. * *(dict) --* The properties defining an input card in an Amazon Q App. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textInput", "qQuery", "qPlugin", "fileUpload", "formInput". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textInput** *(dict) --* A container for the properties of the text input card. * **title** *(string) --* The title or label of the text input card. * **id** *(string) --* The unique identifier of the text input card. * **type** *(string) --* The type of the card. * **placeholder** *(string) --* The placeholder text to display in the text input field. * **defaultValue** *(string) --* The default value to pre-populate in the text input field. * **qQuery** *(dict) --* A container for the properties of the query input card. * **title** *(string) --* The title or label of the query card. * **id** *(string) --* The unique identifier of the query card. * **type** *(string) --* The type of the card. * **prompt** *(string) --* The prompt or instructions displayed for the query card. * **outputSource** *(string) --* The source or type of output to generate for the query card. * **attributeFilter** *(dict) --* Turns on filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an *equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a *greater than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a *greater than or equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a *less than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a *less than or equals* operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **qPlugin** *(dict) --* A container for the properties of the plugin input card. * **title** *(string) --* The title or label of the plugin card. * **id** *(string) --* The unique identifier of the plugin card. * **type** *(string) --* The type of the card. * **prompt** *(string) --* The prompt or instructions displayed for the plugin card. * **pluginId** *(string) --* The unique identifier of the plugin used by the card. * **actionIdentifier** *(string) --* The action identifier of the action to be performed by the plugin card. * **fileUpload** *(dict) --* A container for the properties of the file upload input card. * **title** *(string) --* The title or label of the file upload card. * **id** *(string) --* The unique identifier of the file upload card. * **type** *(string) --* The type of the card. * **filename** *(string) --* The default filename to use for the file upload card. * **fileId** *(string) --* The identifier of a pre-uploaded file associated with the card. * **allowOverride** *(boolean) --* A flag indicating if the user can override the default file for the upload card. * **formInput** *(dict) --* A container for the properties of the form input card. * **title** *(string) --* The title or label of the form input card. * **id** *(string) --* The unique identifier of the form input card. * **type** *(string) --* The type of the card. * **metadata** *(dict) --* The metadata that defines the form input card data. * **schema** (*document*) -- The JSON schema that defines the shape of the response data. * **computeMode** *(string) --* The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of "append" shall allow participants to submit the same form multiple times with different values. A compute mode of >>``< shall overwrite the current value for each participant. * **initialPrompt** *(string) --* The initial prompt displayed when the Q App is started. * **problemStatement** *(string) --* The problem statement extracted from the input conversation, if provided. **Exceptions** * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / get_q_app_session_metadata get_q_app_session_metadata ************************** QApps.Client.get_q_app_session_metadata(**kwargs) Retrieves the current configuration of a Q App session. See also: AWS API Documentation **Request Syntax** response = client.get_q_app_session_metadata( instanceId='string', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App session. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string', 'sessionName': 'string', 'sharingConfiguration': { 'enabled': True|False, 'acceptResponses': True|False, 'revealCards': True|False }, 'sessionOwner': True|False } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the Q App session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the Q App session. * **sessionName** *(string) --* The name of the Q App session. * **sharingConfiguration** *(dict) --* The sharing configuration of the Q App data collection session. * **enabled** *(boolean) --* Indicates whether an Q App session is shareable with other users. * **acceptResponses** *(boolean) --* Indicates whether an Q App session can accept responses from users. * **revealCards** *(boolean) --* Indicates whether collected responses for an Q App session are revealed for all users. * **sessionOwner** *(boolean) --* Indicates whether the current user is the owner of the Q App session. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / create_presigned_url create_presigned_url ******************** QApps.Client.create_presigned_url(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_presigned_url( instanceId='string', cardId='string', appId='string', fileContentsSha256='string', fileName='string', scope='APPLICATION'|'SESSION', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **cardId** (*string*) -- **[REQUIRED]** The unique identifier of the card the file is associated with. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App the file is associated with. * **fileContentsSha256** (*string*) -- **[REQUIRED]** The Base64-encoded SHA-256 digest of the contents of the file to be uploaded. * **fileName** (*string*) -- **[REQUIRED]** The name of the file to be uploaded. * **scope** (*string*) -- **[REQUIRED]** Whether the file is associated with a Q App definition or a specific Q App session. * **sessionId** (*string*) -- The unique identifier of the Q App session the file is associated with, if applicable. Return type: dict Returns: **Response Syntax** { 'fileId': 'string', 'presignedUrl': 'string', 'presignedUrlFields': { 'string': 'string' }, 'presignedUrlExpiration': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **fileId** *(string) --* The unique identifier assigned to the file to be uploaded. * **presignedUrl** *(string) --* The URL for a presigned S3 POST operation used to upload a file. * **presignedUrlFields** *(dict) --* The form fields to include in the presigned S3 POST operation used to upload a file. * *(string) --* * *(string) --* * **presignedUrlExpiration** *(datetime) --* The date and time that the presigned URL will expire in ISO 8601 format. **Exceptions** * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / update_library_item_metadata update_library_item_metadata **************************** QApps.Client.update_library_item_metadata(**kwargs) Updates the verification status of a library item for an Amazon Q App. See also: AWS API Documentation **Request Syntax** response = client.update_library_item_metadata( instanceId='string', libraryItemId='string', isVerified=True|False ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the updated library item. * **isVerified** (*boolean*) -- The verification status of the library item Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / delete_library_item delete_library_item ******************* QApps.Client.delete_library_item(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_library_item( instanceId='string', libraryItemId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the library item to delete. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / list_library_items list_library_items ****************** QApps.Client.list_library_items(**kwargs) Lists the library items for Amazon Q Apps that are published and available for users in your Amazon Web Services account. See also: AWS API Documentation **Request Syntax** response = client.list_library_items( instanceId='string', limit=123, nextToken='string', categoryId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **limit** (*integer*) -- The maximum number of library items to return in the response. * **nextToken** (*string*) -- The token to request the next page of results. * **categoryId** (*string*) -- Optional category to filter the library items by. Return type: dict Returns: **Response Syntax** { 'libraryItems': [ { 'libraryItemId': 'string', 'appId': 'string', 'appVersion': 123, 'categories': [ { 'id': 'string', 'title': 'string', 'color': 'string', 'appCount': 123 }, ], 'status': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'ratingCount': 123, 'isRatedByUser': True|False, 'userCount': 123, 'isVerified': True|False }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **libraryItems** *(list) --* The list of library items meeting the request criteria. * *(dict) --* 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. * **libraryItemId** *(string) --* The unique identifier of the library item. * **appId** *(string) --* The unique identifier of the Q App associated with the library item. * **appVersion** *(integer) --* The version of the Q App associated with the library item. * **categories** *(list) --* The categories associated with the library item. * *(dict) --* A category used to classify and filter library items for Amazon Q Apps. * **id** *(string) --* The unique identifier of the category. * **title** *(string) --* The title or name of the category. * **color** *(string) --* The color of the category * **appCount** *(integer) --* The number of published Amazon Q Apps associated with a category * **status** *(string) --* The status of the library item. * **createdAt** *(datetime) --* The date and time the library item was created. * **createdBy** *(string) --* The user who created the library item. * **updatedAt** *(datetime) --* The date and time the library item was last updated. * **updatedBy** *(string) --* The user who last updated the library item. * **ratingCount** *(integer) --* The number of ratings the library item has received. * **isRatedByUser** *(boolean) --* Whether the current user has rated the library item. * **userCount** *(integer) --* The number of users who have the associated Q App. * **isVerified** *(boolean) --* Indicates whether the library item has been verified. * **nextToken** *(string) --* The token to use to request the next page of results. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / batch_create_category batch_create_category ********************* QApps.Client.batch_create_category(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_create_category( instanceId='string', categories=[ { 'id': 'string', 'title': 'string', 'color': 'string' }, ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **categories** (*list*) -- **[REQUIRED]** The list of category objects to be created * *(dict) --* The category object to be created. * **id** *(string) --* The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier. * **title** *(string) --* **[REQUIRED]** The name of the category. * **color** *(string) --* The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / list_tags_for_resource list_tags_for_resource ********************** QApps.Client.list_tags_for_resource(**kwargs) Lists the tags associated with an Amazon Q Apps resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( resourceARN='string' ) Parameters: **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource whose tags should be listed. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* The list of tags that are assigned to the resource. * *(string) --* * *(string) --* **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / create_q_app create_q_app ************ QApps.Client.create_q_app(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.create_q_app( instanceId='string', title='string', description='string', appDefinition={ 'cards': [ { 'textInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'placeholder': 'string', 'defaultValue': 'string' }, 'qQuery': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'outputSource': 'approved-sources'|'llm', 'attributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } } }, 'qPlugin': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'pluginId': 'string', 'actionIdentifier': 'string' }, 'fileUpload': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'filename': 'string', 'fileId': 'string', 'allowOverride': True|False }, 'formInput': { 'title': 'string', 'id': 'string', 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'metadata': { 'schema': {...}|[...]|123|123.4|'string'|True|None }, 'computeMode': 'append'|'replace' } }, ], 'initialPrompt': 'string' }, tags={ 'string': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **title** (*string*) -- **[REQUIRED]** The title of the new Q App. * **description** (*string*) -- The description of the new Q App. * **appDefinition** (*dict*) -- **[REQUIRED]** The definition of the new Q App, specifying the cards and flow. * **cards** *(list) --* **[REQUIRED]** The cards that make up the Q App definition. * *(dict) --* The properties defining an input card in an Amazon Q App. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "textInput", "qQuery", "qPlugin", "fileUpload", "formInput". * **textInput** *(dict) --* A container for the properties of the text input card. * **title** *(string) --* **[REQUIRED]** The title or label of the text input card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the text input card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **placeholder** *(string) --* The placeholder text to display in the text input field. * **defaultValue** *(string) --* The default value to pre-populate in the text input field. * **qQuery** *(dict) --* A container for the properties of the query input card. * **title** *(string) --* **[REQUIRED]** The title or label of the query card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the query card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **prompt** *(string) --* **[REQUIRED]** The prompt or instructions displayed for the query card. * **outputSource** *(string) --* The source or type of output to generate for the query card. * **attributeFilter** *(dict) --* Turns on filtering of responses based on document attributes or metadata fields. * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an *equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a *greater than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a *greater than or equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a *less than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a *less than or equals* operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* **[REQUIRED]** The identifier for the attribute. * **value** *(dict) --* **[REQUIRED]** The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "stringValue", "stringListValue", "longValue", "dateValue". * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date- time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **qPlugin** *(dict) --* A container for the properties of the plugin input card. * **title** *(string) --* **[REQUIRED]** The title or label of the plugin card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the plugin card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **prompt** *(string) --* **[REQUIRED]** The prompt or instructions displayed for the plugin card. * **pluginId** *(string) --* **[REQUIRED]** The unique identifier of the plugin used by the card. * **actionIdentifier** *(string) --* The action identifier of the action to be performed by the plugin card. * **fileUpload** *(dict) --* A container for the properties of the file upload input card. * **title** *(string) --* **[REQUIRED]** The title or label of the file upload card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the file upload card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **filename** *(string) --* The default filename to use for the file upload card. * **fileId** *(string) --* The identifier of a pre-uploaded file associated with the card. * **allowOverride** *(boolean) --* A flag indicating if the user can override the default file for the upload card. * **formInput** *(dict) --* A container for the properties of the form input card. * **title** *(string) --* **[REQUIRED]** The title or label of the form input card. * **id** *(string) --* **[REQUIRED]** The unique identifier of the form input card. * **type** *(string) --* **[REQUIRED]** The type of the card. * **metadata** *(dict) --* **[REQUIRED]** The metadata that defines the form input card data. * **schema** (*document*) -- **[REQUIRED]** The JSON schema that defines the shape of the response data. * **computeMode** *(string) --* The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of "append" shall allow participants to submit the same form multiple times with different values. A compute mode of >>``< shall overwrite the current value for each participant. * **initialPrompt** *(string) --* The initial prompt displayed when the Q App is started. * **tags** (*dict*) -- Optional tags to associate with the new Q App. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'appId': 'string', 'appArn': 'string', 'title': 'string', 'description': 'string', 'initialPrompt': 'string', 'appVersion': 123, 'status': 'PUBLISHED'|'DRAFT'|'DELETED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'requiredCapabilities': [ 'FileUpload'|'CreatorMode'|'RetrievalMode'|'PluginMode', ] } **Response Structure** * *(dict) --* * **appId** *(string) --* The unique identifier of the new Q App. * **appArn** *(string) --* The Amazon Resource Name (ARN) of the new Q App. * **title** *(string) --* The title of the new Q App. * **description** *(string) --* The description of the new Q App. * **initialPrompt** *(string) --* The initial prompt displayed when the Q App is started. * **appVersion** *(integer) --* The version of the new Q App. * **status** *(string) --* The status of the new Q App, such as "Created". * **createdAt** *(datetime) --* The date and time the Q App was created. * **createdBy** *(string) --* The user who created the Q App. * **updatedAt** *(datetime) --* The date and time the Q App was last updated. * **updatedBy** *(string) --* The user who last updated the Q App. * **requiredCapabilities** *(list) --* The capabilities required to run the Q App, such as file upload or third-party integrations. * *(string) --* **Exceptions** * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ContentTooLargeException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / list_categories list_categories *************** QApps.Client.list_categories(**kwargs) Lists the categories of a Amazon Q Business application environment instance. For more information, see Custom labels for Amazon Q Apps. See also: AWS API Documentation **Request Syntax** response = client.list_categories( instanceId='string' ) Parameters: **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. Return type: dict Returns: **Response Syntax** { 'categories': [ { 'id': 'string', 'title': 'string', 'color': 'string', 'appCount': 123 }, ] } **Response Structure** * *(dict) --* * **categories** *(list) --* The categories of a Amazon Q Business application environment instance. * *(dict) --* A category used to classify and filter library items for Amazon Q Apps. * **id** *(string) --* The unique identifier of the category. * **title** *(string) --* The title or name of the category. * **color** *(string) --* The color of the category * **appCount** *(integer) --* The number of published Amazon Q Apps associated with a category **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / list_q_apps list_q_apps *********** QApps.Client.list_q_apps(**kwargs) 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.. See also: AWS API Documentation **Request Syntax** response = client.list_q_apps( instanceId='string', limit=123, nextToken='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **limit** (*integer*) -- The maximum number of Q Apps to return in the response. * **nextToken** (*string*) -- The token to request the next page of results. Return type: dict Returns: **Response Syntax** { 'apps': [ { 'appId': 'string', 'appArn': 'string', 'title': 'string', 'description': 'string', 'createdAt': datetime(2015, 1, 1), 'canEdit': True|False, 'status': 'string', 'isVerified': True|False }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **apps** *(list) --* The list of Amazon Q Apps meeting the request criteria. * *(dict) --* An Amazon Q App associated with a user, either owned by the user or favorited. * **appId** *(string) --* The unique identifier of the Q App. * **appArn** *(string) --* The Amazon Resource Name (ARN) of the Q App. * **title** *(string) --* The title of the Q App. * **description** *(string) --* The description of the Q App. * **createdAt** *(datetime) --* The date and time the user's association with the Q App was created. * **canEdit** *(boolean) --* A flag indicating whether the user can edit the Q App. * **status** *(string) --* The status of the user's association with the Q App. * **isVerified** *(boolean) --* Indicates whether the Q App has been verified. * **nextToken** *(string) --* The token to use to request the next page of results. **Exceptions** * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / untag_resource untag_resource ************** QApps.Client.untag_resource(**kwargs) Disassociates tags from an Amazon Q Apps resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( resourceARN='string', tagKeys=[ 'string', ] ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to disassociate the tag from. * **tagKeys** (*list*) -- **[REQUIRED]** The keys of the tags to disassociate from the resource. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / get_waiter get_waiter ********** QApps.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" QApps / Client / get_q_app get_q_app ********* QApps.Client.get_q_app(**kwargs) Retrieves the full details of an Q App, including its definition specifying the cards and flow. See also: AWS API Documentation **Request Syntax** response = client.get_q_app( instanceId='string', appId='string', appVersion=123 ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App to retrieve. * **appVersion** (*integer*) -- The version of the Q App. Return type: dict Returns: **Response Syntax** { 'appId': 'string', 'appArn': 'string', 'title': 'string', 'description': 'string', 'initialPrompt': 'string', 'appVersion': 123, 'status': 'PUBLISHED'|'DRAFT'|'DELETED', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'requiredCapabilities': [ 'FileUpload'|'CreatorMode'|'RetrievalMode'|'PluginMode', ], 'appDefinition': { 'appDefinitionVersion': 'string', 'cards': [ { 'textInput': { 'id': 'string', 'title': 'string', 'dependencies': [ 'string', ], 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'placeholder': 'string', 'defaultValue': 'string' }, 'qQuery': { 'id': 'string', 'title': 'string', 'dependencies': [ 'string', ], 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'outputSource': 'approved-sources'|'llm', 'attributeFilter': { 'andAllFilters': [ {'... recursive ...'}, ], 'orAllFilters': [ {'... recursive ...'}, ], 'notFilter': {'... recursive ...'}, 'equalsTo': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAll': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'containsAny': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'greaterThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThan': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } }, 'lessThanOrEquals': { 'name': 'string', 'value': { 'stringValue': 'string', 'stringListValue': [ 'string', ], 'longValue': 123, 'dateValue': datetime(2015, 1, 1) } } }, 'memoryReferences': [ 'string', ] }, 'qPlugin': { 'id': 'string', 'title': 'string', 'dependencies': [ 'string', ], 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'prompt': 'string', 'pluginType': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'ASANA'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'JIRA_CLOUD'|'MICROSOFT_EXCHANGE'|'MICROSOFT_TEAMS'|'PAGERDUTY_ADVANCE'|'SALESFORCE_CRM'|'SERVICENOW_NOW_PLATFORM'|'SMARTSHEET'|'ZENDESK_SUITE', 'pluginId': 'string', 'actionIdentifier': 'string' }, 'fileUpload': { 'id': 'string', 'title': 'string', 'dependencies': [ 'string', ], 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'filename': 'string', 'fileId': 'string', 'allowOverride': True|False }, 'formInput': { 'id': 'string', 'title': 'string', 'dependencies': [ 'string', ], 'type': 'text-input'|'q-query'|'file-upload'|'q-plugin'|'form-input', 'metadata': { 'schema': {...}|[...]|123|123.4|'string'|True|None }, 'computeMode': 'append'|'replace' } }, ], 'canEdit': True|False } } **Response Structure** * *(dict) --* * **appId** *(string) --* The unique identifier of the Q App. * **appArn** *(string) --* The Amazon Resource Name (ARN) of the Q App. * **title** *(string) --* The title of the Q App. * **description** *(string) --* The description of the Q App. * **initialPrompt** *(string) --* The initial prompt displayed when the Q App is started. * **appVersion** *(integer) --* The version of the Q App. * **status** *(string) --* The status of the Q App. * **createdAt** *(datetime) --* The date and time the Q App was created. * **createdBy** *(string) --* The user who created the Q App. * **updatedAt** *(datetime) --* The date and time the Q App was last updated. * **updatedBy** *(string) --* The user who last updated the Q App. * **requiredCapabilities** *(list) --* The capabilities required to run the Q App, such as file upload or third-party integrations. * *(string) --* * **appDefinition** *(dict) --* The full definition of the Q App, specifying the cards and flow. * **appDefinitionVersion** *(string) --* The version of the app definition schema or specification. * **cards** *(list) --* The cards that make up the Q App, such as text input, file upload, or query cards. * *(dict) --* A card representing a component or step in an Amazon Q App's flow. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "textInput", "qQuery", "qPlugin", "fileUpload", "formInput". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **textInput** *(dict) --* A container for the properties of the text input card. * **id** *(string) --* The unique identifier of the text input card. * **title** *(string) --* The title or label of the text input card. * **dependencies** *(list) --* Any dependencies or requirements for the text input card. * *(string) --* * **type** *(string) --* The type of the card. * **placeholder** *(string) --* The placeholder text to display in the text input field. * **defaultValue** *(string) --* The default value to pre-populate in the text input field. * **qQuery** *(dict) --* A container for the properties of the query card. * **id** *(string) --* The unique identifier of the query card. * **title** *(string) --* The title or label of the query card. * **dependencies** *(list) --* Any dependencies or requirements for the query card. * *(string) --* * **type** *(string) --* The type of the card. * **prompt** *(string) --* The prompt or instructions displayed for the query card. * **outputSource** *(string) --* The source or type of output generated by the query card. * **attributeFilter** *(dict) --* The Amazon Q Business filters applied in this query card when resolving data sources * **andAllFilters** *(list) --* Performs a logical "AND" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **orAllFilters** *(list) --* Performs a logical "OR" operation on all supplied filters. * *(dict) --* The filter criteria used on responses based on document attributes or metadata fields. * **notFilter** *(dict) --* Performs a logical "NOT" operation on all supplied filters. * **equalsTo** *(dict) --* Performs an *equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue", "longValue", "stringListValue" and "stringValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAll** *(dict) --* Returns "true" when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **containsAny** *(dict) --* Returns "true" when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types: "stringListValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThan** *(dict) --* Performs a *greater than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **greaterThanOrEquals** *(dict) --* Performs a *greater than or equals* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThan** *(dict) --* Performs a *less than* operation on two document attributes or metadata fields. Supported for the following document attribute value types: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **lessThanOrEquals** *(dict) --* Performs a *less than or equals* operation on two document attributes or metadata fields.Supported for the following document attribute value type: "dateValue" and "longValue". * **name** *(string) --* The identifier for the attribute. * **value** *(dict) --* The value of the attribute. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "stringValue", "stringListValue", "longValue", "dateValue". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **stringValue** *(string) --* A string. * **stringListValue** *(list) --* A list of strings. * *(string) --* * **longValue** *(integer) --* A long integer value. * **dateValue** *(datetime) --* A date expressed as an ISO 8601 string. It's important for the time zone to be included in the *ISO 8601 date-time* format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time. * **memoryReferences** *(list) --* Any dependencies for the query card, where the dependencies are references to the collected responses. * *(string) --* * **qPlugin** *(dict) --* A container for the properties of the plugin card. * **id** *(string) --* The unique identifier of the plugin card. * **title** *(string) --* The title or label of the plugin card. * **dependencies** *(list) --* Any dependencies or requirements for the plugin card. * *(string) --* * **type** *(string) --* The type of the card. * **prompt** *(string) --* The prompt or instructions displayed for the plugin card. * **pluginType** *(string) --* The type or category of the plugin used by the card. * **pluginId** *(string) --* The unique identifier of the plugin used by the card. * **actionIdentifier** *(string) --* The action identifier of the action to be performed by the plugin card. * **fileUpload** *(dict) --* A container for the properties of the file upload card. * **id** *(string) --* The unique identifier of the file upload card. * **title** *(string) --* The title of the file upload card. * **dependencies** *(list) --* Any dependencies or requirements for the file upload card. * *(string) --* * **type** *(string) --* The type of the card. * **filename** *(string) --* The name of the file being uploaded. * **fileId** *(string) --* The unique identifier of the file associated with the card. * **allowOverride** *(boolean) --* A flag indicating if the user can override the default file for the upload card. * **formInput** *(dict) --* A container for the properties of the form input card. * **id** *(string) --* The unique identifier of the form input card. * **title** *(string) --* The title of the form input card. * **dependencies** *(list) --* Any dependencies or requirements for the form input card. * *(string) --* * **type** *(string) --* The type of the card. * **metadata** *(dict) --* The metadata that defines the form input card data. * **schema** (*document*) -- The JSON schema that defines the shape of the response data. * **computeMode** *(string) --* The compute mode of the form input card. This property determines whether individual participants of a data collection session can submit multiple response or one response. A compute mode of "append" shall allow participants to submit the same form multiple times with different values. A compute mode of >>``< shall overwrite the current value for each participant. * **canEdit** *(boolean) --* A flag indicating whether the Q App's definition can be edited by the user. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / batch_update_category batch_update_category ********************* QApps.Client.batch_update_category(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_update_category( instanceId='string', categories=[ { 'id': 'string', 'title': 'string', 'color': 'string' }, ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **categories** (*list*) -- **[REQUIRED]** The list of categories to be updated with their new values. * *(dict) --* A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items. * **id** *(string) --* **[REQUIRED]** The unique identifier of the category. * **title** *(string) --* **[REQUIRED]** The name of the category. * **color** *(string) --* The color of the category, represented as a hexadecimal value of either 3 or 6 digits. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / update_q_app_session_metadata update_q_app_session_metadata ***************************** QApps.Client.update_q_app_session_metadata(**kwargs) Updates the configuration metadata of a session for a given Q App "sessionId". See also: AWS API Documentation **Request Syntax** response = client.update_q_app_session_metadata( instanceId='string', sessionId='string', sessionName='string', sharingConfiguration={ 'enabled': True|False, 'acceptResponses': True|False, 'revealCards': True|False } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App session to update configuration for. * **sessionName** (*string*) -- The new name for the Q App session. * **sharingConfiguration** (*dict*) -- **[REQUIRED]** The new sharing configuration for the Q App data collection session. * **enabled** *(boolean) --* **[REQUIRED]** Indicates whether an Q App session is shareable with other users. * **acceptResponses** *(boolean) --* Indicates whether an Q App session can accept responses from users. * **revealCards** *(boolean) --* Indicates whether collected responses for an Q App session are revealed for all users. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string', 'sessionName': 'string', 'sharingConfiguration': { 'enabled': True|False, 'acceptResponses': True|False, 'revealCards': True|False } } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the updated Q App session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the updated Q App session. * **sessionName** *(string) --* The new name of the updated Q App session. * **sharingConfiguration** *(dict) --* The new sharing configuration of the updated Q App data collection session. * **enabled** *(boolean) --* Indicates whether an Q App session is shareable with other users. * **acceptResponses** *(boolean) --* Indicates whether an Q App session can accept responses from users. * **revealCards** *(boolean) --* Indicates whether collected responses for an Q App session are revealed for all users. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / get_q_app_session get_q_app_session ***************** QApps.Client.get_q_app_session(**kwargs) Retrieves the current state and results for an active session of an Amazon Q App. See also: AWS API Documentation **Request Syntax** response = client.get_q_app_session( instanceId='string', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App session to retrieve. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string', 'sessionName': 'string', 'appVersion': 123, 'latestPublishedAppVersion': 123, 'status': 'IN_PROGRESS'|'WAITING'|'COMPLETED'|'ERROR', 'cardStatus': { 'string': { 'currentState': 'IN_PROGRESS'|'WAITING'|'COMPLETED'|'ERROR', 'currentValue': 'string', 'submissions': [ { 'value': {...}|[...]|123|123.4|'string'|True|None, 'submissionId': 'string', 'timestamp': datetime(2015, 1, 1) }, ] } }, 'userIsHost': True|False } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the Q App session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the Q App session. * **sessionName** *(string) --* The name of the Q App session. * **appVersion** *(integer) --* The version of the Q App used for the session. * **latestPublishedAppVersion** *(integer) --* The latest published version of the Q App used for the session. * **status** *(string) --* The current status of the Q App session. * **cardStatus** *(dict) --* The current status for each card in the Q App session. * *(string) --* * *(dict) --* The current status and value of a card in an active Amazon Q App session. * **currentState** *(string) --* The current state of the card. * **currentValue** *(string) --* The current value or result associated with the card. * **submissions** *(list) --* A list of previous submissions, if the card is a form card. * *(dict) --* A record created when a user submits a form card. * **value** (*document*) -- The data submitted by the user. * **submissionId** *(string) --* The unique identifier of the submission. * **timestamp** *(datetime) --* The date and time when the card is submitted. * **userIsHost** *(boolean) --* Indicates whether the current user is the owner of the Q App data collection session. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / get_library_item get_library_item **************** QApps.Client.get_library_item(**kwargs) Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics. See also: AWS API Documentation **Request Syntax** response = client.get_library_item( instanceId='string', libraryItemId='string', appId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the library item to retrieve. * **appId** (*string*) -- The unique identifier of the Amazon Q App associated with the library item. Return type: dict Returns: **Response Syntax** { 'libraryItemId': 'string', 'appId': 'string', 'appVersion': 123, 'categories': [ { 'id': 'string', 'title': 'string', 'color': 'string', 'appCount': 123 }, ], 'status': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'ratingCount': 123, 'isRatedByUser': True|False, 'userCount': 123, 'isVerified': True|False } **Response Structure** * *(dict) --* * **libraryItemId** *(string) --* The unique identifier of the library item. * **appId** *(string) --* The unique identifier of the Q App associated with the library item. * **appVersion** *(integer) --* The version of the Q App associated with the library item. * **categories** *(list) --* The categories associated with the library item for discovery. * *(dict) --* A category used to classify and filter library items for Amazon Q Apps. * **id** *(string) --* The unique identifier of the category. * **title** *(string) --* The title or name of the category. * **color** *(string) --* The color of the category * **appCount** *(integer) --* The number of published Amazon Q Apps associated with a category * **status** *(string) --* The status of the library item, such as "Published". * **createdAt** *(datetime) --* The date and time the library item was created. * **createdBy** *(string) --* The user who created the library item. * **updatedAt** *(datetime) --* The date and time the library item was last updated. * **updatedBy** *(string) --* The user who last updated the library item. * **ratingCount** *(integer) --* The number of ratings the library item has received from users. * **isRatedByUser** *(boolean) --* Whether the current user has rated the library item. * **userCount** *(integer) --* The number of users who have associated the Q App with their account. * **isVerified** *(boolean) --* Indicates whether the library item has been verified. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / start_q_app_session start_q_app_session ******************* QApps.Client.start_q_app_session(**kwargs) Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. Note: Each Q App session will be condensed into a single conversation in the web experience. See also: AWS API Documentation **Request Syntax** response = client.start_q_app_session( instanceId='string', appId='string', appVersion=123, initialValues=[ { 'cardId': 'string', 'value': 'string', 'submissionMutation': { 'submissionId': 'string', 'mutationType': 'edit'|'delete'|'add' } }, ], sessionId='string', tags={ 'string': 'string' } ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App to start a session for. * **appVersion** (*integer*) -- **[REQUIRED]** The version of the Q App to use for the session. * **initialValues** (*list*) -- Optional initial input values to provide for the Q App session. * *(dict) --* The value or result associated with a card in a Amazon Q App session. * **cardId** *(string) --* **[REQUIRED]** The unique identifier of the card. * **value** *(string) --* **[REQUIRED]** The value or result associated with the card. * **submissionMutation** *(dict) --* The structure that describes how the current form card value is mutated. Only applies for form cards when multiple responses are allowed. * **submissionId** *(string) --* **[REQUIRED]** The unique identifier of the submission. * **mutationType** *(string) --* **[REQUIRED]** The operation that is performed on a submission. * **sessionId** (*string*) -- The unique identifier of the a Q App session. * **tags** (*dict*) -- Optional tags to associate with the new Q App session. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string' } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the new or retrieved Q App session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the new Q App session. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / create_library_item create_library_item ******************* QApps.Client.create_library_item(**kwargs) Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. See also: AWS API Documentation **Request Syntax** response = client.create_library_item( instanceId='string', appId='string', appVersion=123, categories=[ 'string', ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q App to publish to the library. * **appVersion** (*integer*) -- **[REQUIRED]** The version of the Amazon Q App to publish to the library. * **categories** (*list*) -- **[REQUIRED]** The categories to associate with the library item for easier discovery. * *(string) --* Return type: dict Returns: **Response Syntax** { 'libraryItemId': 'string', 'status': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'ratingCount': 123, 'isVerified': True|False } **Response Structure** * *(dict) --* * **libraryItemId** *(string) --* The unique identifier of the new library item. * **status** *(string) --* The status of the new library item, such as "Published". * **createdAt** *(datetime) --* The date and time the library item was created. * **createdBy** *(string) --* The user who created the library item. * **updatedAt** *(datetime) --* The date and time the library item was last updated. * **updatedBy** *(string) --* The user who last updated the library item. * **ratingCount** *(integer) --* The number of ratings the library item has received from users. * **isVerified** *(boolean) --* Indicates whether the library item has been verified. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / disassociate_library_item_review disassociate_library_item_review ******************************** QApps.Client.disassociate_library_item_review(**kwargs) Removes a rating or review previously submitted by the user for a library item. See also: AWS API Documentation **Request Syntax** response = client.disassociate_library_item_review( instanceId='string', libraryItemId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the library item to remove the review from. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / import_document import_document *************** QApps.Client.import_document(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.import_document( instanceId='string', cardId='string', appId='string', fileContentsBase64='string', fileName='string', scope='APPLICATION'|'SESSION', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **cardId** (*string*) -- **[REQUIRED]** The unique identifier of the card the file is associated with. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App the file is associated with. * **fileContentsBase64** (*string*) -- **[REQUIRED]** The base64-encoded contents of the file to upload. * **fileName** (*string*) -- **[REQUIRED]** The name of the file being uploaded. * **scope** (*string*) -- **[REQUIRED]** Whether the file is associated with a Q App definition or a specific Q App session. * **sessionId** (*string*) -- The unique identifier of the Q App session the file is associated with, if applicable. Return type: dict Returns: **Response Syntax** { 'fileId': 'string' } **Response Structure** * *(dict) --* * **fileId** *(string) --* The unique identifier assigned to the uploaded file. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ContentTooLargeException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / associate_library_item_review associate_library_item_review ***************************** QApps.Client.associate_library_item_review(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.associate_library_item_review( instanceId='string', libraryItemId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier for the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the library item to associate the review with. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / list_q_app_session_data list_q_app_session_data *********************** QApps.Client.list_q_app_session_data(**kwargs) Lists the collected data of a Q App data collection session. See also: AWS API Documentation **Request Syntax** response = client.list_q_app_session_data( instanceId='string', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App data collection session. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string', 'sessionData': [ { 'cardId': 'string', 'value': {...}|[...]|123|123.4|'string'|True|None, 'user': { 'userId': 'string' }, 'submissionId': 'string', 'timestamp': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the Q App data collection session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the Q App data collection session. * **sessionData** *(list) --* The collected responses of a Q App session. * *(dict) --* The response collected for a Amazon Q App session. This container represents a single response to a Q App session. * **cardId** *(string) --* The card Id associated with the response submitted for a Q App session. * **value** (*document*) -- The response submitted for a Q App session. * **user** *(dict) --* The user who submitted the response for a Q App session. * **userId** *(string) --* The unique identifier of a user. * **submissionId** *(string) --* The unique identifier of the submission. * **timestamp** *(datetime) --* The date and time when the session data is submitted. * **nextToken** *(string) --* The pagination token that indicates the next set of results to retrieve. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / close close ***** QApps.Client.close() Closes underlying endpoint connections. QApps / Client / delete_q_app delete_q_app ************ QApps.Client.delete_q_app(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.delete_q_app( instanceId='string', appId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App to delete. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / batch_delete_category batch_delete_category ********************* QApps.Client.batch_delete_category(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.batch_delete_category( instanceId='string', categories=[ 'string', ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **categories** (*list*) -- **[REQUIRED]** The list of IDs of the categories to be deleted. * *(string) --* Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / update_library_item update_library_item ******************* QApps.Client.update_library_item(**kwargs) Updates the library item for an Amazon Q App. See also: AWS API Documentation **Request Syntax** response = client.update_library_item( instanceId='string', libraryItemId='string', status='PUBLISHED'|'DISABLED', categories=[ 'string', ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **libraryItemId** (*string*) -- **[REQUIRED]** The unique identifier of the library item to update. * **status** (*string*) -- The new status to set for the library item, such as "Published" or "Hidden". * **categories** (*list*) -- The new categories to associate with the library item. * *(string) --* Return type: dict Returns: **Response Syntax** { 'libraryItemId': 'string', 'appId': 'string', 'appVersion': 123, 'categories': [ { 'id': 'string', 'title': 'string', 'color': 'string', 'appCount': 123 }, ], 'status': 'string', 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string', 'ratingCount': 123, 'isRatedByUser': True|False, 'userCount': 123, 'isVerified': True|False } **Response Structure** * *(dict) --* * **libraryItemId** *(string) --* The unique identifier of the updated library item. * **appId** *(string) --* The unique identifier of the Q App associated with the library item. * **appVersion** *(integer) --* The version of the Q App associated with the library item. * **categories** *(list) --* The categories associated with the updated library item. * *(dict) --* A category used to classify and filter library items for Amazon Q Apps. * **id** *(string) --* The unique identifier of the category. * **title** *(string) --* The title or name of the category. * **color** *(string) --* The color of the category * **appCount** *(integer) --* The number of published Amazon Q Apps associated with a category * **status** *(string) --* The new status of the updated library item. * **createdAt** *(datetime) --* The date and time the library item was originally created. * **createdBy** *(string) --* The user who originally created the library item. * **updatedAt** *(datetime) --* The date and time the library item was last updated. * **updatedBy** *(string) --* The user who last updated the library item. * **ratingCount** *(integer) --* The number of ratings the library item has received. * **isRatedByUser** *(boolean) --* Whether the current user has rated the library item. * **userCount** *(integer) --* The number of users who have the associated Q App. * **isVerified** *(boolean) --* Indicates whether the library item has been verified. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / stop_q_app_session stop_q_app_session ****************** QApps.Client.stop_q_app_session(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.stop_q_app_session( instanceId='string', sessionId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App session to stop. Returns: None **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / update_q_app_session update_q_app_session ******************** QApps.Client.update_q_app_session(**kwargs) 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. See also: AWS API Documentation **Request Syntax** response = client.update_q_app_session( instanceId='string', sessionId='string', values=[ { 'cardId': 'string', 'value': 'string', 'submissionMutation': { 'submissionId': 'string', 'mutationType': 'edit'|'delete'|'add' } }, ] ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **sessionId** (*string*) -- **[REQUIRED]** The unique identifier of the Q App session to provide input for. * **values** (*list*) -- The input values to provide for the current state of the Q App session. * *(dict) --* The value or result associated with a card in a Amazon Q App session. * **cardId** *(string) --* **[REQUIRED]** The unique identifier of the card. * **value** *(string) --* **[REQUIRED]** The value or result associated with the card. * **submissionMutation** *(dict) --* The structure that describes how the current form card value is mutated. Only applies for form cards when multiple responses are allowed. * **submissionId** *(string) --* **[REQUIRED]** The unique identifier of the submission. * **mutationType** *(string) --* **[REQUIRED]** The operation that is performed on a submission. Return type: dict Returns: **Response Syntax** { 'sessionId': 'string', 'sessionArn': 'string' } **Response Structure** * *(dict) --* * **sessionId** *(string) --* The unique identifier of the updated Q App session. * **sessionArn** *(string) --* The Amazon Resource Name (ARN) of the updated Q App session. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ServiceQuotaExceededException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / tag_resource tag_resource ************ QApps.Client.tag_resource(**kwargs) Associates tags with an Amazon Q Apps resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( resourceARN='string', tags={ 'string': 'string' } ) Parameters: * **resourceARN** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource to tag. * **tags** (*dict*) -- **[REQUIRED]** The tags to associate with the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ConflictException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.ThrottlingException" QApps / Client / describe_q_app_permissions describe_q_app_permissions ************************** QApps.Client.describe_q_app_permissions(**kwargs) Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance. See also: AWS API Documentation **Request Syntax** response = client.describe_q_app_permissions( instanceId='string', appId='string' ) Parameters: * **instanceId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q Business application environment instance. * **appId** (*string*) -- **[REQUIRED]** The unique identifier of the Amazon Q App for which to retrieve permissions. Return type: dict Returns: **Response Syntax** { 'resourceArn': 'string', 'appId': 'string', 'permissions': [ { 'action': 'read'|'write', 'principal': { 'userId': 'string', 'userType': 'owner'|'user', 'email': 'string' } }, ] } **Response Structure** * *(dict) --* * **resourceArn** *(string) --* The Amazon Resource Name (ARN) of the Amazon Q App for which permissions are returned. * **appId** *(string) --* The unique identifier of the Amazon Q App for which permissions are returned. * **permissions** *(list) --* The list of permissions granted for the Amazon Q App. * *(dict) --* The permission granted to the Amazon Q App. * **action** *(string) --* The action associated with the permission. * **principal** *(dict) --* The principal user to which the permission applies. * **userId** *(string) --* The unique identifier of the user. * **userType** *(string) --* The type of the user. * **email** *(string) --* The email address associated with the user. **Exceptions** * "QApps.Client.exceptions.ResourceNotFoundException" * "QApps.Client.exceptions.AccessDeniedException" * "QApps.Client.exceptions.ValidationException" * "QApps.Client.exceptions.InternalServerException" * "QApps.Client.exceptions.UnauthorizedException" * "QApps.Client.exceptions.ThrottlingException"