Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qapps ]

get-q-app¶

Description¶

Retrieves the full details of an Q App, including its definition specifying the cards and flow.

Synopsis¶

  get-q-app
--instance-id <value>
--app-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--instance-id (string)

The unique identifier of the Amazon Q Business application environment instance.

--app-id (string)

The unique identifier of the Q App to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

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 -> (timestamp)

The date and time the Q App was created.

createdBy -> (string)

The user who created the Q App.

updatedAt -> (timestamp)

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 -> (structure)

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.

(tagged union structure)

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 can be set: textInput, qQuery, qPlugin, fileUpload.

textInput -> (structure)

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 -> (structure)

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 -> (structure)

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.

(structure)

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

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( ... recursive ... )

orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( ... recursive ... )

( ... recursive ... )equalsTo -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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.

orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

(structure)

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

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( ... recursive ... )

orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( ... recursive ... )

( ... recursive ... )equalsTo -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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.

notFilter -> (structure)

Performs a logical NOT operation on all supplied filters.

andAllFilters -> (list)

Performs a logical AND operation on all supplied filters.

( ... recursive ... )

orAllFilters -> (list)

Performs a logical OR operation on all supplied filters.

( ... recursive ... )

( ... recursive ... )equalsTo -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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.

equalsTo -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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 -> (tagged union structure)

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 -> (long)

A long integer value.

dateValue -> (timestamp)

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 -> (structure)

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.

fileUpload -> (structure)

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.

canEdit -> (boolean)

A flag indicating whether the Q App's definition can be edited by the user.

Table Of Contents

Feedback

User Guide

Note:

get-q-app¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note

Note