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
ANDoperation on all supplied filters.(dict) –
The filter criteria used on responses based on document attributes or metadata fields.
orAllFilters (list) –
Performs a logical
ORoperation on all supplied filters.(dict) –
The filter criteria used on responses based on document attributes or metadata fields.
notFilter (dict) –
Performs a logical
NOToperation 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,stringListValueandstringValue.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
truewhen 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
truewhen 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:
dateValueandlongValue.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:
dateValueandlongValue.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:
dateValueandlongValue.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:
dateValueandlongValue.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
appendshall allow participants to submit the same form multiple times with different values. A compute mode of ``replace``code> 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.ResourceNotFoundExceptionQApps.Client.exceptions.AccessDeniedExceptionQApps.Client.exceptions.ValidationExceptionQApps.Client.exceptions.InternalServerExceptionQApps.Client.exceptions.UnauthorizedExceptionQApps.Client.exceptions.ContentTooLargeExceptionQApps.Client.exceptions.ThrottlingException