Class: AWS.QApps

var params = {
  appId: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE' /* required */
};
qapps.associateQAppWithUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The ID of the Amazon Q App to associate with the user.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  appVersion: 'NUMBER_VALUE', /* required */
  categories: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  instanceId: 'STRING_VALUE' /* required */
};
qapps.createLibraryItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The unique identifier of the Amazon Q App to publish to the library.

  • appVersion — (Integer)

    The version of the Amazon Q App to publish to the library.

  • categories — (Array<String>)

    The categories to associate with the library item for easier discovery.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • libraryItemId — (String)

      The unique identifier of the new library item.

    • status — (String)

      The status of the new library item, such as "Published".

    • createdAt — (Date)

      The date and time the library item was created.

    • createdBy — (String)

      The user who created the library item.

    • updatedAt — (Date)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appDefinition: { /* required */
    cards: [ /* required */
      {
        fileUpload: {
          id: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          allowOverride: true || false,
          fileId: 'STRING_VALUE',
          filename: 'STRING_VALUE'
        },
        qPlugin: {
          id: 'STRING_VALUE', /* required */
          pluginId: 'STRING_VALUE', /* required */
          prompt: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin /* required */
        },
        qQuery: {
          id: 'STRING_VALUE', /* required */
          prompt: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          attributeFilter: { /* AttributeFilter */
            andAllFilters: [
              /* recursive AttributeFilter */,
              /* more items */
            ],
            containsAll: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            containsAny: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            equalsTo: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            greaterThan: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            greaterThanOrEquals: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            lessThan: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            lessThanOrEquals: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            notFilter: /* recursive AttributeFilter */,
            orAllFilters: [
              /* recursive AttributeFilter */,
              /* more items */
            ]
          },
          outputSource: approved-sources | llm
        },
        textInput: {
          id: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          defaultValue: 'STRING_VALUE',
          placeholder: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    initialPrompt: 'STRING_VALUE'
  },
  instanceId: 'STRING_VALUE', /* required */
  title: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
qapps.createQApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • title — (String)

    The title of the new Q App.

  • description — (String)

    The description of the new Q App.

  • appDefinition — (map)

    The definition of the new Q App, specifying the cards and flow.

    • cards — required — (Array<map>)

      The cards that make up the Q App definition.

      • textInput — (map)

        A container for the properties of the text input card.

        • title — required — (String)

          The title or label of the text input card.

        • id — required — (String)

          The unique identifier of the text input card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • 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 — (map)

        A container for the properties of the query input card.

        • title — required — (String)

          The title or label of the query card.

        • id — required — (String)

          The unique identifier of the query card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • prompt — required — (String)

          The prompt or instructions displayed for the query card.

        • outputSource — (String)

          The source or type of output to generate for the query card.

          Possible values include:
          • "approved-sources"
          • "llm"
        • attributeFilter — (map)

          Turns on filtering of responses based on document attributes or metadata fields.

          • andAllFilters — (Array<map>)

            Performs a logical AND operation on all supplied filters.

          • orAllFilters — (Array<map>)

            Performs a logical OR operation on all supplied filters.

          • equalsTo — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

        A container for the properties of the plugin input card.

        • title — required — (String)

          The title or label of the plugin card.

        • id — required — (String)

          The unique identifier of the plugin card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • prompt — required — (String)

          The prompt or instructions displayed for the plugin card.

        • pluginId — required — (String)

          The unique identifier of the plugin used by the card.

      • fileUpload — (map)

        A container for the properties of the file upload input card.

        • title — required — (String)

          The title or label of the file upload card.

        • id — required — (String)

          The unique identifier of the file upload card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • 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.

    • initialPrompt — (String)

      The initial prompt displayed when the Q App is started.

  • tags — (map<String>)

    Optional tags to associate with the new Q App.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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".

      Possible values include:
      • "PUBLISHED"
      • "DRAFT"
      • "DELETED"
    • createdAt — (Date)

      The date and time the Q App was created.

    • createdBy — (String)

      The user who created the Q App.

    • updatedAt — (Date)

      The date and time the Q App was last updated.

    • updatedBy — (String)

      The user who last updated the Q App.

    • requiredCapabilities — (Array<String>)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  libraryItemId: 'STRING_VALUE' /* required */
};
qapps.deleteLibraryItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • libraryItemId — (String)

    The unique identifier of the library item to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE' /* required */
};
qapps.deleteQApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The unique identifier of the Q App to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  libraryItemId: 'STRING_VALUE' /* required */
};
qapps.disassociateLibraryItemReview(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • libraryItemId — (String)

    The unique identifier of the library item to remove the review from.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE' /* required */
};
qapps.disassociateQAppFromUser(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The unique identifier of the Q App to disassociate from the user.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  libraryItemId: 'STRING_VALUE', /* required */
  appId: 'STRING_VALUE'
};
qapps.getLibraryItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • libraryItemId — (String)

    The unique identifier of the library item to retrieve.

  • appId — (String)

    The unique identifier of the Amazon Q App associated with the library item.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The categories associated with the library item for discovery.

      • id — required — (String)

        The unique identifier of the category.

      • title — required — (String)

        The title or name of the category.

    • status — (String)

      The status of the library item, such as "Published".

    • createdAt — (Date)

      The date and time the library item was created.

    • createdBy — (String)

      The user who created the library item.

    • updatedAt — (Date)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE' /* required */
};
qapps.getQApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The unique identifier of the Q App to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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.

      Possible values include:
      • "PUBLISHED"
      • "DRAFT"
      • "DELETED"
    • createdAt — (Date)

      The date and time the Q App was created.

    • createdBy — (String)

      The user who created the Q App.

    • updatedAt — (Date)

      The date and time the Q App was last updated.

    • updatedBy — (String)

      The user who last updated the Q App.

    • requiredCapabilities — (Array<String>)

      The capabilities required to run the Q App, such as file upload or third-party integrations.

    • appDefinition — (map)

      The full definition of the Q App, specifying the cards and flow.

      • appDefinitionVersion — required — (String)

        The version of the app definition schema or specification.

      • cards — required — (Array<map>)

        The cards that make up the Q App, such as text input, file upload, or query cards.

        • textInput — (map)

          A container for the properties of the text input card.

          • id — required — (String)

            The unique identifier of the text input card.

          • title — required — (String)

            The title or label of the text input card.

          • dependencies — required — (Array<String>)

            Any dependencies or requirements for the text input card.

          • type — required — (String)

            The type of the card.

            Possible values include:
            • "text-input"
            • "q-query"
            • "file-upload"
            • "q-plugin"
          • 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 — (map)

          A container for the properties of the query card.

          • id — required — (String)

            The unique identifier of the query card.

          • title — required — (String)

            The title or label of the query card.

          • dependencies — required — (Array<String>)

            Any dependencies or requirements for the query card.

          • type — required — (String)

            The type of the card.

            Possible values include:
            • "text-input"
            • "q-query"
            • "file-upload"
            • "q-plugin"
          • prompt — required — (String)

            The prompt or instructions displayed for the query card.

          • outputSource — required — (String)

            The source or type of output generated by the query card.

            Possible values include:
            • "approved-sources"
            • "llm"
          • attributeFilter — (map)

            The Amazon Q Business filters applied in this query card when resolving data sources

            • andAllFilters — (Array<map>)

              Performs a logical AND operation on all supplied filters.

            • orAllFilters — (Array<map>)

              Performs a logical OR operation on all supplied filters.

            • equalsTo — (map)

              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 — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

              • name — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              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 — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

              • name — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              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 — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

              • name — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

              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 — required — (String)

                The identifier for the attribute.

              • value — required — (map)

                The value of the attribute.

                • stringValue — (String)

                  A string.

                • stringListValue — (Array<String>)

                  A list of strings.

                • longValue — (Integer)

                  A long integer value.

                • dateValue — (Date)

                  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 — (map)

          A container for the properties of the plugin card.

          • id — required — (String)

            The unique identifier of the plugin card.

          • title — required — (String)

            The title or label of the plugin card.

          • dependencies — required — (Array<String>)

            Any dependencies or requirements for the plugin card.

          • type — required — (String)

            The type of the card.

            Possible values include:
            • "text-input"
            • "q-query"
            • "file-upload"
            • "q-plugin"
          • prompt — required — (String)

            The prompt or instructions displayed for the plugin card.

          • pluginType — required — (String)

            The type or category of the plugin used by the card.

            Possible values include:
            • "SERVICE_NOW"
            • "SALESFORCE"
            • "JIRA"
            • "ZENDESK"
            • "CUSTOM"
          • pluginId — required — (String)

            The unique identifier of the plugin used by the card.

        • fileUpload — (map)

          A container for the properties of the file upload card.

          • id — required — (String)

            The unique identifier of the file upload card.

          • title — required — (String)

            The title of the file upload card.

          • dependencies — required — (Array<String>)

            Any dependencies or requirements for the file upload card.

          • type — required — (String)

            The type of the card.

            Possible values include:
            • "text-input"
            • "q-query"
            • "file-upload"
            • "q-plugin"
          • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE' /* required */
};
qapps.getQAppSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • sessionId — (String)

    The unique identifier of the Q App session to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sessionId — (String)

      The unique identifier of the Q App session.

    • sessionArn — (String)

      The Amazon Resource Name (ARN) of the Q App session.

    • status — (String)

      The current status of the Q App session.

      Possible values include:
      • "IN_PROGRESS"
      • "WAITING"
      • "COMPLETED"
    • cardStatus — (map<map>)

      The current status for each card in the Q App session.

      • currentState — required — (String)

        The current state of the card.

        Possible values include:
        • "IN_PROGRESS"
        • "WAITING"
        • "COMPLETED"
      • currentValue — required — (String)

        The current value or result associated with the card.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  cardId: 'STRING_VALUE', /* required */
  fileContentsBase64: 'STRING_VALUE', /* required */
  fileName: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE', /* required */
  scope: APPLICATION | SESSION, /* required */
  sessionId: 'STRING_VALUE'
};
qapps.importDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • cardId — (String)

    The unique identifier of the card the file is associated with, if applicable.

  • appId — (String)

    The unique identifier of the Q App the file is associated with.

  • fileContentsBase64 — (String)

    The base64-encoded contents of the file to upload.

  • fileName — (String)

    The name of the file being uploaded.

  • scope — (String)

    Whether the file is associated with an Q App definition or a specific Q App session.

    Possible values include:
    • "APPLICATION"
    • "SESSION"
  • sessionId — (String)

    The unique identifier of the Q App session the file is associated with, if applicable.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • fileId — (String)

      The unique identifier assigned to the uploaded file.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  categoryId: 'STRING_VALUE',
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qapps.listLibraryItems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • libraryItems — (Array<map>)

      The list of library items meeting the request criteria.

      • libraryItemId — required — (String)

        The unique identifier of the library item.

      • appId — required — (String)

        The unique identifier of the Q App associated with the library item.

      • appVersion — required — (Integer)

        The version of the Q App associated with the library item.

      • categories — required — (Array<map>)

        The categories associated with the library item.

        • id — required — (String)

          The unique identifier of the category.

        • title — required — (String)

          The title or name of the category.

      • status — required — (String)

        The status of the library item.

      • createdAt — required — (Date)

        The date and time the library item was created.

      • createdBy — required — (String)

        The user who created the library item.

      • updatedAt — (Date)

        The date and time the library item was last updated.

      • updatedBy — (String)

        The user who last updated the library item.

      • ratingCount — required — (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.

    • nextToken — (String)

      The token to use to request the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  limit: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qapps.listQApps(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • apps — (Array<map>)

      The list of Amazon Q Apps meeting the request criteria.

      • appId — required — (String)

        The unique identifier of the Q App.

      • appArn — required — (String)

        The Amazon Resource Name (ARN) of the Q App.

      • title — required — (String)

        The title of the Q App.

      • description — (String)

        The description of the Q App.

      • createdAt — required — (Date)

        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.

    • nextToken — (String)

      The token to use to request the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceARN: 'STRING_VALUE' /* required */
};
qapps.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceARN — (String)

    The Amazon Resource Name (ARN) of the resource whose tags should be listed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      The list of tags that are assigned to the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  options: {
    conversation: [
      {
        body: 'STRING_VALUE', /* required */
        type: USER | SYSTEM /* required */
      },
      /* more items */
    ],
    problemStatement: 'STRING_VALUE'
  }
};
qapps.predictQApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • options — (map)

    The input to generate the Q App definition from, either a conversation or problem statement.

    • conversation — (Array<map>)

      A conversation to use as input for generating the Q App definition.

      • body — required — (String)

        The text content of the conversation message.

      • type — required — (String)

        The type of the conversation message.

        Possible values include:
        • "USER"
        • "SYSTEM"
    • problemStatement — (String)

      A problem statement to use as input for generating the Q App definition.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • app — (map)

      The generated Q App definition.

      • title — required — (String)

        The title of the generated Q App definition.

      • description — (String)

        The description of the generated Q App definition.

      • appDefinition — required — (map)

        The definition specifying the cards and flow of the generated Q App.

        • cards — required — (Array<map>)

          The cards that make up the Q App definition.

          • textInput — (map)

            A container for the properties of the text input card.

            • title — required — (String)

              The title or label of the text input card.

            • id — required — (String)

              The unique identifier of the text input card.

            • type — required — (String)

              The type of the card.

              Possible values include:
              • "text-input"
              • "q-query"
              • "file-upload"
              • "q-plugin"
            • 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 — (map)

            A container for the properties of the query input card.

            • title — required — (String)

              The title or label of the query card.

            • id — required — (String)

              The unique identifier of the query card.

            • type — required — (String)

              The type of the card.

              Possible values include:
              • "text-input"
              • "q-query"
              • "file-upload"
              • "q-plugin"
            • prompt — required — (String)

              The prompt or instructions displayed for the query card.

            • outputSource — (String)

              The source or type of output to generate for the query card.

              Possible values include:
              • "approved-sources"
              • "llm"
            • attributeFilter — (map)

              Turns on filtering of responses based on document attributes or metadata fields.

              • andAllFilters — (Array<map>)

                Performs a logical AND operation on all supplied filters.

              • orAllFilters — (Array<map>)

                Performs a logical OR operation on all supplied filters.

              • equalsTo — (map)

                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 — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

                • name — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                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 — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

                • name — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                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 — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

                • name — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

                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 — required — (String)

                  The identifier for the attribute.

                • value — required — (map)

                  The value of the attribute.

                  • stringValue — (String)

                    A string.

                  • stringListValue — (Array<String>)

                    A list of strings.

                  • longValue — (Integer)

                    A long integer value.

                  • dateValue — (Date)

                    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 — (map)

            A container for the properties of the plugin input card.

            • title — required — (String)

              The title or label of the plugin card.

            • id — required — (String)

              The unique identifier of the plugin card.

            • type — required — (String)

              The type of the card.

              Possible values include:
              • "text-input"
              • "q-query"
              • "file-upload"
              • "q-plugin"
            • prompt — required — (String)

              The prompt or instructions displayed for the plugin card.

            • pluginId — required — (String)

              The unique identifier of the plugin used by the card.

          • fileUpload — (map)

            A container for the properties of the file upload input card.

            • title — required — (String)

              The title or label of the file upload card.

            • id — required — (String)

              The unique identifier of the file upload card.

            • type — required — (String)

              The type of the card.

              Possible values include:
              • "text-input"
              • "q-query"
              • "file-upload"
              • "q-plugin"
            • 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.

        • initialPrompt — (String)

          The initial prompt displayed when the Q App is started.

    • problemStatement — (String)

      The problem statement extracted from the input conversation, if provided.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  appVersion: 'NUMBER_VALUE', /* required */
  instanceId: 'STRING_VALUE', /* required */
  initialValues: [
    {
      cardId: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  tags: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  }
};
qapps.startQAppSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    The unique identifier of the Q App to start a session for.

  • appVersion — (Integer)

    The version of the Q App to use for the session.

  • initialValues — (Array<map>)

    Optional initial input values to provide for the Q App session.

    • cardId — required — (String)

      The unique identifier of the card.

    • value — required — (String)

      The value or result associated with the card.

  • tags — (map<String>)

    Optional tags to associate with the new Q App session.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sessionId — (String)

      The unique identifier of the new Q App session.

    • sessionArn — (String)

      The Amazon Resource Name (ARN) of the new Q App session.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE' /* required */
};
qapps.stopQAppSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • sessionId — (String)

    The unique identifier of the Q App session to stop.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qapps.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceARN — (String)

    The Amazon Resource Name (ARN) of the resource to tag.

  • tags — (map<String>)

    The tags to associate with the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceARN: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
qapps.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceARN — (String)

    The Amazon Resource Name (ARN) of the resource to disassociate the tag from.

  • tagKeys — (Array<String>)

    The keys of the tags to disassociate from the resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  libraryItemId: 'STRING_VALUE', /* required */
  categories: [
    'STRING_VALUE',
    /* more items */
  ],
  status: PUBLISHED | DISABLED
};
qapps.updateLibraryItem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • libraryItemId — (String)

    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".

    Possible values include:
    • "PUBLISHED"
    • "DISABLED"
  • categories — (Array<String>)

    The new categories to associate with the library item.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The categories associated with the updated library item.

      • id — required — (String)

        The unique identifier of the category.

      • title — required — (String)

        The title or name of the category.

    • status — (String)

      The new status of the updated library item.

    • createdAt — (Date)

      The date and time the library item was originally created.

    • createdBy — (String)

      The user who originally created the library item.

    • updatedAt — (Date)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  appId: 'STRING_VALUE', /* required */
  instanceId: 'STRING_VALUE', /* required */
  appDefinition: {
    cards: [ /* required */
      {
        fileUpload: {
          id: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          allowOverride: true || false,
          fileId: 'STRING_VALUE',
          filename: 'STRING_VALUE'
        },
        qPlugin: {
          id: 'STRING_VALUE', /* required */
          pluginId: 'STRING_VALUE', /* required */
          prompt: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin /* required */
        },
        qQuery: {
          id: 'STRING_VALUE', /* required */
          prompt: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          attributeFilter: { /* AttributeFilter */
            andAllFilters: [
              /* recursive AttributeFilter */,
              /* more items */
            ],
            containsAll: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            containsAny: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            equalsTo: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            greaterThan: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            greaterThanOrEquals: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            lessThan: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            lessThanOrEquals: {
              name: 'STRING_VALUE', /* required */
              value: { /* required */
                dateValue: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
                longValue: 'NUMBER_VALUE',
                stringListValue: [
                  'STRING_VALUE',
                  /* more items */
                ],
                stringValue: 'STRING_VALUE'
              }
            },
            notFilter: /* recursive AttributeFilter */,
            orAllFilters: [
              /* recursive AttributeFilter */,
              /* more items */
            ]
          },
          outputSource: approved-sources | llm
        },
        textInput: {
          id: 'STRING_VALUE', /* required */
          title: 'STRING_VALUE', /* required */
          type: text-input | q-query | file-upload | q-plugin, /* required */
          defaultValue: 'STRING_VALUE',
          placeholder: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    initialPrompt: 'STRING_VALUE'
  },
  description: 'STRING_VALUE',
  title: 'STRING_VALUE'
};
qapps.updateQApp(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • appId — (String)

    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 — (map)

    The new definition specifying the cards and flow for the Q App.

    • cards — required — (Array<map>)

      The cards that make up the Q App definition.

      • textInput — (map)

        A container for the properties of the text input card.

        • title — required — (String)

          The title or label of the text input card.

        • id — required — (String)

          The unique identifier of the text input card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • 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 — (map)

        A container for the properties of the query input card.

        • title — required — (String)

          The title or label of the query card.

        • id — required — (String)

          The unique identifier of the query card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • prompt — required — (String)

          The prompt or instructions displayed for the query card.

        • outputSource — (String)

          The source or type of output to generate for the query card.

          Possible values include:
          • "approved-sources"
          • "llm"
        • attributeFilter — (map)

          Turns on filtering of responses based on document attributes or metadata fields.

          • andAllFilters — (Array<map>)

            Performs a logical AND operation on all supplied filters.

          • orAllFilters — (Array<map>)

            Performs a logical OR operation on all supplied filters.

          • equalsTo — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types: stringListValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types: dateValue and longValue.

            • name — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

            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 — required — (String)

              The identifier for the attribute.

            • value — required — (map)

              The value of the attribute.

              • stringValue — (String)

                A string.

              • stringListValue — (Array<String>)

                A list of strings.

              • longValue — (Integer)

                A long integer value.

              • dateValue — (Date)

                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 — (map)

        A container for the properties of the plugin input card.

        • title — required — (String)

          The title or label of the plugin card.

        • id — required — (String)

          The unique identifier of the plugin card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • prompt — required — (String)

          The prompt or instructions displayed for the plugin card.

        • pluginId — required — (String)

          The unique identifier of the plugin used by the card.

      • fileUpload — (map)

        A container for the properties of the file upload input card.

        • title — required — (String)

          The title or label of the file upload card.

        • id — required — (String)

          The unique identifier of the file upload card.

        • type — required — (String)

          The type of the card.

          Possible values include:
          • "text-input"
          • "q-query"
          • "file-upload"
          • "q-plugin"
        • 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.

    • initialPrompt — (String)

      The initial prompt displayed when the Q App is started.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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.

      Possible values include:
      • "PUBLISHED"
      • "DRAFT"
      • "DELETED"
    • createdAt — (Date)

      The date and time the Q App was originally created.

    • createdBy — (String)

      The user who originally created the Q App.

    • updatedAt — (Date)

      The date and time the Q App was last updated.

    • updatedBy — (String)

      The user who last updated the Q App.

    • requiredCapabilities — (Array<String>)

      The capabilities required for the updated Q App.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  instanceId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  values: [
    {
      cardId: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
qapps.updateQAppSession(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • instanceId — (String)

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

  • sessionId — (String)

    The unique identifier of the Q App session to provide input for.

  • values — (Array<map>)

    The input values to provide for the current state of the Q App session.

    • cardId — required — (String)

      The unique identifier of the card.

    • value — required — (String)

      The value or result associated with the card.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • sessionId — (String)

      The unique identifier of the updated Q App session.

    • sessionArn — (String)

      The Amazon Resource Name (ARN) of the updated Q App session.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.