Class: AWS.QBusiness

var params = {
  applicationId: 'STRING_VALUE', /* required */
  documents: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      accessConfiguration: {
        accessControls: [ /* required */
          {
            principals: [ /* required */
              {
                group: {
                  access: ALLOW | DENY, /* required */
                  membershipType: INDEX | DATASOURCE,
                  name: 'STRING_VALUE'
                },
                user: {
                  access: ALLOW | DENY, /* required */
                  id: 'STRING_VALUE',
                  membershipType: INDEX | DATASOURCE
                }
              },
              /* more items */
            ],
            memberRelation: AND | OR
          },
          /* more items */
        ],
        memberRelation: AND | OR
      },
      attributes: [
        {
          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'
          }
        },
        /* more items */
      ],
      content: {
        blob: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
        s3: {
          bucket: 'STRING_VALUE', /* required */
          key: 'STRING_VALUE' /* required */
        }
      },
      contentType: PDF | HTML | MS_WORD | PLAIN_TEXT | PPT | RTF | XML | XSLT | MS_EXCEL | CSV | JSON | MD,
      documentEnrichmentConfiguration: {
        inlineConfigurations: [
          {
            condition: {
              key: 'STRING_VALUE', /* required */
              operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
              value: {
                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'
              }
            },
            documentContentOperator: DELETE,
            target: {
              key: 'STRING_VALUE', /* required */
              attributeValueOperator: DELETE,
              value: {
                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'
              }
            }
          },
          /* more items */
        ],
        postExtractionHookConfiguration: {
          invocationCondition: {
            key: 'STRING_VALUE', /* required */
            operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
            value: {
              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'
            }
          },
          lambdaArn: 'STRING_VALUE',
          roleArn: 'STRING_VALUE',
          s3BucketName: 'STRING_VALUE'
        },
        preExtractionHookConfiguration: {
          invocationCondition: {
            key: 'STRING_VALUE', /* required */
            operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
            value: {
              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'
            }
          },
          lambdaArn: 'STRING_VALUE',
          roleArn: 'STRING_VALUE',
          s3BucketName: 'STRING_VALUE'
        }
      },
      title: 'STRING_VALUE'
    },
    /* more items */
  ],
  indexId: 'STRING_VALUE', /* required */
  dataSourceSyncId: 'STRING_VALUE',
  roleArn: 'STRING_VALUE'
};
qbusiness.batchPutDocument(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application.

  • dataSourceSyncId — (String)

    The identifier of the data source sync during which the documents were added.

  • documents — (Array<map>)

    One or more documents to add to the index.

    • accessConfiguration — (map)

      Configuration information for access permission to a document.

      • accessControls — required — (Array<map>)

        A list of AccessControlList objects.

        • memberRelation — (String)

          Describes the member relation within a principal list.

          Possible values include:
          • "AND"
          • "OR"
        • principals — required — (Array<map>)

          Contains a list of principals, where a principal can be either a USER or a GROUP. Each principal can be have the following type of document access: ALLOW or DENY.

          • group — (map)

            The group associated with the principal.

            • access — required — (String)

              Provides information about whether to allow or deny access to the principal.

              Possible values include:
              • "ALLOW"
              • "DENY"
            • membershipType — (String)

              The type of group.

              Possible values include:
              • "INDEX"
              • "DATASOURCE"
            • name — (String)

              The name of the group.

          • user — (map)

            The user associated with the principal.

            • access — required — (String)

              Provides information about whether to allow or deny access to the principal.

              Possible values include:
              • "ALLOW"
              • "DENY"
            • id — (String)

              The identifier of the user.

            • membershipType — (String)

              The type of group.

              Possible values include:
              • "INDEX"
              • "DATASOURCE"
      • memberRelation — (String)

        Describes the member relation within the AccessControlList object.

        Possible values include:
        • "AND"
        • "OR"
    • attributes — (Array<map>)

      Custom attributes to apply to the document for refining Amazon Q Business web experience responses.

      • name — required — (String)

        The identifier for the attribute.

      • value — required — (map)

        The value of the attribute.

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

    • content — (map)

      The contents of the document.

      • blob — (Buffer, Typed Array, Blob, String)

        The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

      • s3 — (map)

        The path to the document in an Amazon S3 bucket.

        • bucket — required — (String)

          The name of the S3 bucket that contains the file.

        • key — required — (String)

          The name of the file.

    • contentType — (String)

      The file type of the document in the Blob field.

      If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you add the HTML start and closing tags (<HTML>content</HTML>) around the content.

      Possible values include:
      • "PDF"
      • "HTML"
      • "MS_WORD"
      • "PLAIN_TEXT"
      • "PPT"
      • "RTF"
      • "XML"
      • "XSLT"
      • "MS_EXCEL"
      • "CSV"
      • "JSON"
      • "MD"
    • documentEnrichmentConfiguration — (map)

      The configuration information for altering document metadata and content during the document ingestion process.

      • inlineConfigurations — (Array<map>)

        Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

        • condition — (map)

          The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

          For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

          Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • documentContentOperator — (String)

          TRUE to delete content if the condition used for the target attribute is met.

          Possible values include:
          • "DELETE"
        • target — (map)

          The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

          For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

          Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

          You can also use this with DocumentAttributeCondition .

          • attributeValueOperator — (String)

            TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

            Possible values include:
            • "DELETE"
          • key — required — (String)

            The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

      • postExtractionHookConfiguration — (map)

        Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

        You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

        If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

        You can only invoke one Lambda function. However, this function can invoke other functions it requires.

        For more information, see Custom document enrichment.

        • invocationCondition — (map)

          The condition used for when a Lambda function should be invoked.

          For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • lambdaArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

        • roleArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

        • s3BucketName — (String)

          Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

      • preExtractionHookConfiguration — (map)

        Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

        You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

        If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

        You can only invoke one Lambda function. However, this function can invoke other functions it requires.

        For more information, see Custom document enrichment.

        • invocationCondition — (map)

          The condition used for when a Lambda function should be invoked.

          For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • lambdaArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

        • roleArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

        • s3BucketName — (String)

          Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

    • id — required — (String)

      The identifier of the document.

    • title — (String)

      The title of the document.

  • indexId — (String)

    The identifier of the Amazon Q Business index to add the documents to.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

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:

    • failedDocuments — (Array<map>)

      A list of documents that were not added to the Amazon Q Business index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.

      • dataSourceId — (String)

        The identifier of the Amazon Q Business data source connector that contains the failed document.

      • error — (map)

        An explanation for why the document couldn't be removed from the index.

        • errorCode — (String)

          The code associated with the data source sync error.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
          • "ResourceInactive"
          • "ResourceNotFound"
        • errorMessage — (String)

          The message explaining the data source sync error.

      • id — (String)

        The identifier of the document that couldn't be removed from the Amazon Q Business index.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  actionExecution: {
    payload: { /* required */
      '<ActionPayloadFieldKey>': {
        value: { /* required */
        }
      },
      /* '<ActionPayloadFieldKey>': ... */
    },
    payloadFieldNameSeparator: 'STRING_VALUE', /* required */
    pluginId: 'STRING_VALUE' /* required */
  },
  attachments: [
    {
      data: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
      name: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  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 */
    ]
  },
  chatMode: RETRIEVAL_MODE | CREATOR_MODE | PLUGIN_MODE,
  chatModeConfiguration: {
    pluginConfiguration: {
      pluginId: 'STRING_VALUE' /* required */
    }
  },
  clientToken: 'STRING_VALUE',
  conversationId: 'STRING_VALUE',
  parentMessageId: 'STRING_VALUE',
  userGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  userId: 'STRING_VALUE',
  userMessage: 'STRING_VALUE'
};
qbusiness.chatSync(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: {}) —
  • actionExecution — (map)

    A request from an end user to perform an Amazon Q Business plugin action.

    • payload — required — (map<map>)

      A mapping of field names to the field values in input that an end user provides to Amazon Q Business requests to perform their plugin action.

      • value — required — (map)

        The content of a user input field in an plugin action execution payload.

    • payloadFieldNameSeparator — required — (String)

      A string used to retain information about the hierarchical contexts within an action execution event payload.

    • pluginId — required — (String)

      The identifier of the plugin the action is attached to.

  • applicationId — (String)

    The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.

  • attachments — (Array<map>)

    A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.

    • data — required — (Buffer, Typed Array, Blob, String)

      The data contained within the uploaded file.

    • name — required — (String)

      The name of the file.

  • attributeFilter — (map)

    Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.

    • andAllFilters — (Array<map>)

      Performs a logical AND operation on all supplied filters.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • 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: dateValue, longValue, stringListValue and stringValue.

        • name — required — (String)

          The identifier for the attribute.

        • value — required — (map)

          The value of the attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • greaterThanOrEquals — (map)

        Performs a greater or equals 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.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

    • 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: dateValue, longValue, stringListValue and stringValue.

      • name — required — (String)

        The identifier for the attribute.

      • value — required — (map)

        The value of the attribute.

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

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

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

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

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

    • greaterThanOrEquals — (map)

      Performs a greater or equals 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.

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

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

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

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

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

        • longValue — (Integer)

          A long integer value.

        • stringListValue — (Array<String>)

          A list of strings.

        • stringValue — (String)

          A string.

    • notFilter — (map)

      Performs a logical NOT operation on all supplied filters.

      • andAllFilters — (Array<map>)

        Performs a logical AND operation on all supplied filters.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • 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: dateValue, longValue, stringListValue and stringValue.

        • name — required — (String)

          The identifier for the attribute.

        • value — required — (map)

          The value of the attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • greaterThanOrEquals — (map)

        Performs a greater or equals 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.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • orAllFilters — (Array<map>)

        Performs a logical OR operation on all supplied filters.

    • orAllFilters — (Array<map>)

      Performs a logical OR operation on all supplied filters.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • 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: dateValue, longValue, stringListValue and stringValue.

        • name — required — (String)

          The identifier for the attribute.

        • value — required — (map)

          The value of the attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • greaterThanOrEquals — (map)

        Performs a greater or equals 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.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

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

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

  • chatMode — (String)

    The chat modes available in an Amazon Q Business web experience.

    • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

    • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

    • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

    For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

    Possible values include:
    • "RETRIEVAL_MODE"
    • "CREATOR_MODE"
    • "PLUGIN_MODE"
  • chatModeConfiguration — (map)

    The chat mode configuration for an Amazon Q Business application.

    • pluginConfiguration — (map)

      Configuration information required to invoke chat in PLUGIN_MODE.

      • pluginId — required — (String)

        The identifier of the plugin you want to use.

  • clientToken — (String)

    A token that you provide to identify a chat request.

    If a token is not provided, the SDK will use a version 4 UUID.
  • conversationId — (String)

    The identifier of the Amazon Q Business conversation.

  • parentMessageId — (String)

    The identifier of the previous end user text input message in a conversation.

  • userGroups — (Array<String>)

    The groups that a user associated with the chat input belongs to.

  • userId — (String)

    The identifier of the user attached to the chat input.

  • userMessage — (String)

    A end user message in a conversation.

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:

    • actionReview — (map)

      A request from Amazon Q Business to the end user for information Amazon Q Business needs to successfully complete a requested plugin action.

      • payload — (map<map>)

        Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

        • allowedValues — (Array<map>)

          Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

          • displayValue — (map)

            The name of the field.

          • value — (map)

            The field value.

        • displayName — (String)

          The name of the field.

        • displayOrder — (Integer)

          The display order of fields in a payload.

        • required — (Boolean)

          Information about whether the field is required.

        • type — (String)

          The type of field.

          Possible values include:
          • "STRING"
          • "NUMBER"
          • "ARRAY"
          • "BOOLEAN"
        • value — (map)

          The field value.

      • payloadFieldNameSeparator — (String)

        A string used to retain information about the hierarchical contexts within an action review payload.

      • pluginId — (String)

        The identifier of the plugin associated with the action review.

      • pluginType — (String)

        The type of plugin.

        Possible values include:
        • "SERVICE_NOW"
        • "SALESFORCE"
        • "JIRA"
        • "ZENDESK"
    • conversationId — (String)

      The identifier of the Amazon Q Business conversation.

    • failedAttachments — (Array<map>)

      A list of files which failed to upload during chat.

      • error — (map)

        An error associated with a file uploaded during chat.

        • errorCode — (String)

          The code associated with the data source sync error.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
          • "ResourceInactive"
          • "ResourceNotFound"
        • errorMessage — (String)

          The message explaining the data source sync error.

      • name — (String)

        The name of a file uploaded during chat.

      • status — (String)

        The status of a file uploaded during chat.

        Possible values include:
        • "FAILED"
        • "SUCCEEDED"
    • sourceAttributions — (Array<map>)

      The source documents used to generate the conversation response.

      • citationNumber — (Integer)

        The number attached to a citation in an Amazon Q Business generated response.

      • snippet — (String)

        The content extract from the document on which the generated response is based.

      • textMessageSegments — (Array<map>)

        A text extract from a source document that is used for source attribution.

        • beginOffset — (Integer)

          The zero-based location in the response string where the source attribution starts.

        • endOffset — (Integer)

          The zero-based location in the response string where the source attribution ends.

      • title — (String)

        The title of the document which is the source for the Amazon Q Business generated response.

      • updatedAt — (Date)

        The Unix timestamp when the Amazon Q Business application was last updated.

      • url — (String)

        The URL of the document which is the source for the Amazon Q Business generated response.

    • systemMessage — (String)

      An AI-generated message in a conversation.

    • systemMessageId — (String)

      The identifier of an Amazon Q Business AI generated message within the conversation.

    • userMessageId — (String)

      The identifier of an Amazon Q Business end user text input message within the conversation.

Returns:

• (AWS.Request) —

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

var params = {
  displayName: 'STRING_VALUE', /* required */
  roleArn: 'STRING_VALUE', /* required */
  attachmentsConfiguration: {
    attachmentsControlMode: ENABLED | DISABLED /* required */
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  encryptionConfiguration: {
    kmsKeyId: 'STRING_VALUE'
  },
  identityCenterInstanceArn: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
qbusiness.createApplication(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: {}) —
  • attachmentsConfiguration — (map)

    An option to allow end users to upload files directly during chat.

    • attachmentsControlMode — required — (String)

      Status information about whether file upload functionality is activated or deactivated for your end user.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • clientToken — (String)

    A token that you provide to identify the request to create your Amazon Q Business application.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    A description for the Amazon Q Business application.

  • displayName — (String)

    A name for the Amazon Q Business application.

  • encryptionConfiguration — (map)

    The identifier of the KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

    • kmsKeyId — (String)

      The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

  • identityCenterInstanceArn — (String)

    The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize your Amazon Q Business application. You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

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:

    • applicationArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Q Business application.

    • applicationId — (String)

      The identifier of the Amazon Q Business application.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  configuration: { /* required */
  },
  displayName: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  documentEnrichmentConfiguration: {
    inlineConfigurations: [
      {
        condition: {
          key: 'STRING_VALUE', /* required */
          operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
          value: {
            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'
          }
        },
        documentContentOperator: DELETE,
        target: {
          key: 'STRING_VALUE', /* required */
          attributeValueOperator: DELETE,
          value: {
            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'
          }
        }
      },
      /* more items */
    ],
    postExtractionHookConfiguration: {
      invocationCondition: {
        key: 'STRING_VALUE', /* required */
        operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
        value: {
          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'
        }
      },
      lambdaArn: 'STRING_VALUE',
      roleArn: 'STRING_VALUE',
      s3BucketName: 'STRING_VALUE'
    },
    preExtractionHookConfiguration: {
      invocationCondition: {
        key: 'STRING_VALUE', /* required */
        operator: GREATER_THAN | GREATER_THAN_OR_EQUALS | LESS_THAN | LESS_THAN_OR_EQUALS | EQUALS | NOT_EQUALS | CONTAINS | NOT_CONTAINS | EXISTS | NOT_EXISTS | BEGINS_WITH, /* required */
        value: {
          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'
        }
      },
      lambdaArn: 'STRING_VALUE',
      roleArn: 'STRING_VALUE',
      s3BucketName: 'STRING_VALUE'
    }
  },
  roleArn: 'STRING_VALUE',
  syncSchedule: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  vpcConfiguration: {
    securityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
qbusiness.createDataSource(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application the data source will be attached to.

  • clientToken — (String)

    A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

    If a token is not provided, the SDK will use a version 4 UUID.
  • configuration — (map)

    Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

  • description — (String)

    A description for the data source connector.

  • displayName — (String)

    A name for the data source connector.

  • documentEnrichmentConfiguration — (map)

    Provides the configuration information for altering document metadata and content during the document ingestion process.

    For more information, see Custom document enrichment.

    • inlineConfigurations — (Array<map>)

      Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

      • condition — (map)

        The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

        For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

        Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

        • key — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

        • operator — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

          Possible values include:
          • "GREATER_THAN"
          • "GREATER_THAN_OR_EQUALS"
          • "LESS_THAN"
          • "LESS_THAN_OR_EQUALS"
          • "EQUALS"
          • "NOT_EQUALS"
          • "CONTAINS"
          • "NOT_CONTAINS"
          • "EXISTS"
          • "NOT_EXISTS"
          • "BEGINS_WITH"
        • value — (map)

          The value of a document attribute. You can only provide one value for a document attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • documentContentOperator — (String)

        TRUE to delete content if the condition used for the target attribute is met.

        Possible values include:
        • "DELETE"
      • target — (map)

        The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

        For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

        Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

        You can also use this with DocumentAttributeCondition .

        • attributeValueOperator — (String)

          TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

          Possible values include:
          • "DELETE"
        • key — required — (String)

          The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

        • value — (map)

          The value of a document attribute. You can only provide one value for a document attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

    • postExtractionHookConfiguration — (map)

      Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

      You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

      If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

      You can only invoke one Lambda function. However, this function can invoke other functions it requires.

      For more information, see Custom document enrichment.

      • invocationCondition — (map)

        The condition used for when a Lambda function should be invoked.

        For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

        • key — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

        • operator — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

          Possible values include:
          • "GREATER_THAN"
          • "GREATER_THAN_OR_EQUALS"
          • "LESS_THAN"
          • "LESS_THAN_OR_EQUALS"
          • "EQUALS"
          • "NOT_EQUALS"
          • "CONTAINS"
          • "NOT_CONTAINS"
          • "EXISTS"
          • "NOT_EXISTS"
          • "BEGINS_WITH"
        • value — (map)

          The value of a document attribute. You can only provide one value for a document attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • lambdaArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

      • roleArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

      • s3BucketName — (String)

        Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

    • preExtractionHookConfiguration — (map)

      Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

      You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

      If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

      You can only invoke one Lambda function. However, this function can invoke other functions it requires.

      For more information, see Custom document enrichment.

      • invocationCondition — (map)

        The condition used for when a Lambda function should be invoked.

        For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

        • key — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

        • operator — required — (String)

          The identifier of the document attribute used for the condition.

          For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

          Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

          Possible values include:
          • "GREATER_THAN"
          • "GREATER_THAN_OR_EQUALS"
          • "LESS_THAN"
          • "LESS_THAN_OR_EQUALS"
          • "EQUALS"
          • "NOT_EQUALS"
          • "CONTAINS"
          • "NOT_CONTAINS"
          • "EXISTS"
          • "NOT_EXISTS"
          • "BEGINS_WITH"
        • value — (map)

          The value of a document attribute. You can only provide one value for a document attribute.

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

          • longValue — (Integer)

            A long integer value.

          • stringListValue — (Array<String>)

            A list of strings.

          • stringValue — (String)

            A string.

      • lambdaArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

      • roleArn — (String)

        The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

      • s3BucketName — (String)

        Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

  • indexId — (String)

    The identifier of the index that you want to use with the data source connector.

  • roleArn — (String)

    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

  • syncSchedule — (String)

    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.

    Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

  • vpcConfiguration — (map)

    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.

    • securityGroupIds — required — (Array<String>)

      A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

    • subnetIds — required — (Array<String>)

      A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

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:

    • dataSourceArn — (String)

      The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

    • dataSourceId — (String)

      The identifier of the data source connector.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  displayName: 'STRING_VALUE', /* required */
  capacityConfiguration: {
    units: 'NUMBER_VALUE'
  },
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
qbusiness.createIndex(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application using the index.

  • capacityConfiguration — (map)

    The capacity units you want to provision for your index. You can add and remove capacity to fit your usage needs.

    • units — (Integer)

      The number of storage units configured for an Amazon Q Business index.

  • clientToken — (String)

    A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

    If a token is not provided, the SDK will use a version 4 UUID.
  • description — (String)

    A description for the Amazon Q Business index.

  • displayName — (String)

    A name for the Amazon Q Business index.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

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:

    • indexArn — (String)

      The Amazon Resource Name (ARN) of an Amazon Q Business index.

    • indexId — (String)

      The identifier for the Amazon Q Business index.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  authConfiguration: { /* required */
    basicAuthConfiguration: {
      roleArn: 'STRING_VALUE', /* required */
      secretArn: 'STRING_VALUE' /* required */
    },
    oAuth2ClientCredentialConfiguration: {
      roleArn: 'STRING_VALUE', /* required */
      secretArn: 'STRING_VALUE' /* required */
    }
  },
  displayName: 'STRING_VALUE', /* required */
  serverUrl: 'STRING_VALUE', /* required */
  type: SERVICE_NOW | SALESFORCE | JIRA | ZENDESK, /* required */
  clientToken: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
qbusiness.createPlugin(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: {}) —
  • applicationId — (String)

    The identifier of the application that will contain the plugin.

  • authConfiguration — (map)

    Authentication configuration information for an Amazon Q Business plugin.

    • basicAuthConfiguration — (map)

      Information about the basic authentication credentials used to configure a plugin.

      • roleArn — required — (String)

        The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

      • secretArn — required — (String)

        The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

    • oAuth2ClientCredentialConfiguration — (map)

      Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

      • roleArn — required — (String)

        The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

      • secretArn — required — (String)

        The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

  • clientToken — (String)

    A token that you provide to identify the request to create your Amazon Q Business plugin.

    If a token is not provided, the SDK will use a version 4 UUID.
  • displayName — (String)

    A the name for your plugin.

  • serverUrl — (String)

    The source URL used for plugin configuration.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

  • type — (String)

    The type of plugin you want to create.

    Possible values include:
    • "SERVICE_NOW"
    • "SALESFORCE"
    • "JIRA"
    • "ZENDESK"

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:

    • pluginArn — (String)

      The Amazon Resource Name (ARN) of a plugin.

    • pluginId — (String)

      The identifier of the plugin created.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  configuration: { /* required */
    kendraIndexConfiguration: {
      indexId: 'STRING_VALUE' /* required */
    },
    nativeIndexConfiguration: {
      indexId: 'STRING_VALUE', /* required */
      boostingOverride: {
        '<DocumentAttributeKey>': {
          dateConfiguration: {
            boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */
            boostingDurationInSeconds: 'NUMBER_VALUE'
          },
          numberConfiguration: {
            boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */
            boostingType: PRIORITIZE_LARGER_VALUES | PRIORITIZE_SMALLER_VALUES
          },
          stringConfiguration: {
            boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH, /* required */
            attributeValueBoosting: {
              '<String>': LOW | MEDIUM | HIGH | VERY_HIGH,
              /* '<String>': ... */
            }
          },
          stringListConfiguration: {
            boostingLevel: NONE | LOW | MEDIUM | HIGH | VERY_HIGH /* required */
          }
        },
        /* '<DocumentAttributeKey>': ... */
      }
    }
  },
  displayName: 'STRING_VALUE', /* required */
  type: NATIVE_INDEX | KENDRA_INDEX, /* required */
  clientToken: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
qbusiness.createRetriever(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: {}) —
  • applicationId — (String)

    The identifier of your Amazon Q Business application.

  • clientToken — (String)

    A token that you provide to identify the request to create your Amazon Q Business application retriever.

    If a token is not provided, the SDK will use a version 4 UUID.
  • configuration — (map)

    Provides information on how the retriever used for your Amazon Q Business application is configured.

    • kendraIndexConfiguration — (map)

      Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

      • indexId — required — (String)

        The identifier of the Amazon Kendra index.

    • nativeIndexConfiguration — (map)

      Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

      • boostingOverride — (map<map>)

        Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

        • dateConfiguration — (map)

          Provides information on boosting DATE type document attributes.

          • boostingDurationInSeconds — (Integer)

            Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

          • boostingLevel — required — (String)

            Specifies how much a document attribute is boosted.

            Possible values include:
            • "NONE"
            • "LOW"
            • "MEDIUM"
            • "HIGH"
            • "VERY_HIGH"
        • numberConfiguration — (map)

          Provides information on boosting NUMBER type document attributes.

          • boostingLevel — required — (String)

            Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

            Possible values include:
            • "NONE"
            • "LOW"
            • "MEDIUM"
            • "HIGH"
            • "VERY_HIGH"
          • boostingType — (String)

            Specifies how much a document attribute is boosted.

            Possible values include:
            • "PRIORITIZE_LARGER_VALUES"
            • "PRIORITIZE_SMALLER_VALUES"
        • stringConfiguration — (map)

          Provides information on boosting STRING type document attributes.

          • attributeValueBoosting — (map<String>)

            Specifies specific values of a STRING type document attribute being boosted.

          • boostingLevel — required — (String)

            Specifies how much a document attribute is boosted.

            Possible values include:
            • "NONE"
            • "LOW"
            • "MEDIUM"
            • "HIGH"
            • "VERY_HIGH"
        • stringListConfiguration — (map)

          Provides information on boosting STRING_LIST type document attributes.

          • boostingLevel — required — (String)

            Specifies how much a document attribute is boosted.

            Possible values include:
            • "NONE"
            • "LOW"
            • "MEDIUM"
            • "HIGH"
            • "VERY_HIGH"
      • indexId — required — (String)

        The identifier for the Amazon Q Business index.

  • displayName — (String)

    The name of your retriever.

  • roleArn — (String)

    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

  • type — (String)

    The type of retriever you are using.

    Possible values include:
    • "NATIVE_INDEX"
    • "KENDRA_INDEX"

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:

    • retrieverArn — (String)

      The Amazon Resource Name (ARN) of an IAM role associated with a retriever.

    • retrieverId — (String)

      The identifier of the retriever you are using.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  userAliases: [
    {
      userId: 'STRING_VALUE', /* required */
      dataSourceId: 'STRING_VALUE',
      indexId: 'STRING_VALUE'
    },
    /* more items */
  ]
};
qbusiness.createUser(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: {}) —
  • applicationId — (String)

    The identifier of the application for which the user mapping will be created.

  • clientToken — (String)

    A token that you provide to identify the request to create your Amazon Q Business user mapping.

    If a token is not provided, the SDK will use a version 4 UUID.
  • userAliases — (Array<map>)

    The list of user aliases in the mapping.

    • dataSourceId — (String)

      The identifier of the data source that the user aliases are associated with.

    • indexId — (String)

      The identifier of the index that the user aliases are associated with.

    • userId — required — (String)

      The identifier of the user id associated with the user aliases.

  • userId — (String)

    The user emails attached to a user mapping.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  roleArn: 'STRING_VALUE',
  samplePromptsControlMode: ENABLED | DISABLED,
  subtitle: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  title: 'STRING_VALUE',
  welcomeMessage: 'STRING_VALUE'
};
qbusiness.createWebExperience(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business web experience.

  • clientToken — (String)

    A token you provide to identify a request to create an Amazon Q Business web experience.

    If a token is not provided, the SDK will use a version 4 UUID.
  • roleArn — (String)

    The Amazon Resource Name (ARN) of the service role attached to your web experience.

  • samplePromptsControlMode — (String)

    Determines whether sample prompts are enabled in the web experience for an end user.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • subtitle — (String)

    A subtitle to personalize your Amazon Q Business web experience.

  • tags — (Array<map>)

    A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    • key — required — (String)

      The key for the tag. Keys are not case sensitive and must be unique for the Amazon Q Business application or data source.

    • value — required — (String)

      The value associated with the tag. The value may be an empty string but it can't be null.

  • title — (String)

    The title for your Amazon Q Business web experience.

  • welcomeMessage — (String)

    The customized welcome message for end users of an Amazon Q Business web experience.

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:

    • webExperienceArn — (String)

      The Amazon Resource Name (ARN) of an Amazon Q Business web experience.

    • webExperienceId — (String)

      The identifier of the Amazon Q Business web experience.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
qbusiness.deleteApplication(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application.

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 = {
  applicationId: 'STRING_VALUE' /* required */
};
qbusiness.deleteChatControlsConfiguration(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: {}) —
  • applicationId — (String)

    The identifier of the application the chat controls have been configured for.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  conversationId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE'
};
qbusiness.deleteConversation(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application associated with the conversation.

  • conversationId — (String)

    The identifier of the Amazon Q Business web experience conversation being deleted.

  • userId — (String)

    The identifier of the user who is deleting the conversation.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  dataSourceId: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE' /* required */
};
qbusiness.deleteDataSource(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application used with the data source connector.

  • dataSourceId — (String)

    The identifier of the data source connector that you want to delete.

  • indexId — (String)

    The identifier of the index used with the data source connector.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  groupName: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE', /* required */
  dataSourceId: 'STRING_VALUE'
};
qbusiness.deleteGroup(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: {}) —
  • applicationId — (String)

    The identifier of the application in which the group mapping belongs.

  • dataSourceId — (String)

    The identifier of the data source linked to the group

    A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

  • groupName — (String)

    The name of the group you want to delete.

  • indexId — (String)

    The identifier of the index you want to delete the group 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 = {
  applicationId: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE' /* required */
};
qbusiness.deleteIndex(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application the Amazon Q Business index is linked to.

  • indexId — (String)

    The identifier of the Amazon Q Business index.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  pluginId: 'STRING_VALUE' /* required */
};
qbusiness.deletePlugin(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: {}) —
  • applicationId — (String)

    The identifier the application attached to the Amazon Q Business plugin.

  • pluginId — (String)

    The identifier of the plugin being deleted.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  retrieverId: 'STRING_VALUE' /* required */
};
qbusiness.deleteRetriever(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application using the retriever.

  • retrieverId — (String)

    The identifier of the retriever being deleted.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE' /* required */
};
qbusiness.deleteUser(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: {}) —
  • applicationId — (String)

    The identifier of the application from which the user is being deleted.

  • userId — (String)

    The user email being deleted.

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 = {
  applicationId: 'STRING_VALUE', /* required */
  webExperienceId: 'STRING_VALUE' /* required */
};
qbusiness.deleteWebExperience(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application linked to the Amazon Q Business web experience.

  • webExperienceId — (String)

    The identifier of the Amazon Q Business web experience being deleted.

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 = {
  applicationId: 'STRING_VALUE' /* required */
};
qbusiness.getApplication(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application.

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:

    • applicationArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Q Business application.

    • applicationId — (String)

      The identifier of the Amazon Q Business application.

    • attachmentsConfiguration — (map)

      Settings for whether end users can upload files directly during chat.

      • attachmentsControlMode — (String)

        Information about whether file upload during chat functionality is activated for your application.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • createdAt — (Date)

      The Unix timestamp when the Amazon Q Business application was last updated.

    • description — (String)

      A description for the Amazon Q Business application.

    • displayName — (String)

      The name of the Amazon Q Business application.

    • encryptionConfiguration — (map)

      The identifier of the Amazon Web Services KMS key that is used to encrypt your data. Amazon Q Business doesn't support asymmetric keys.

      • kmsKeyId — (String)

        The identifier of the KMS key. Amazon Q Business doesn't support asymmetric keys.

    • error — (map)

      If the Status field is set to ERROR, the ErrorMessage field contains a description of the error that caused the synchronization to fail.

      • errorCode — (String)

        The code associated with the data source sync error.

        Possible values include:
        • "InternalError"
        • "InvalidRequest"
        • "ResourceInactive"
        • "ResourceNotFound"
      • errorMessage — (String)

        The message explaining the data source sync error.

    • identityCenterApplicationArn — (String)

      The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the IAM with permissions to access your CloudWatch logs and metrics.

    • status — (String)

      The status of the Amazon Q Business application.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
      • "UPDATING"
    • updatedAt — (Date)

      The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qbusiness.getChatControlsConfiguration(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: {}) —
  • applicationId — (String)

    The identifier of the application for which the chat controls are configured.

  • maxResults — (Integer)

    The maximum number of configured chat controls to return.

  • nextToken — (String)

    If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

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:

    • blockedPhrases — (map)

      The phrases blocked from chat by your chat control configuration.

      • blockedPhrases — (Array<String>)

        A list of phrases blocked from a Amazon Q Business web experience chat.

      • systemMessageOverride — (String)

        The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

    • creatorModeConfiguration — (map)

      The configuration details for CREATOR_MODE.

      • creatorModeControl — required — (String)

        Information about whether creator mode is enabled or disabled for an Amazon Q Business application.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • nextToken — (String)

      If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

    • responseScope — (String)

      The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

      Possible values include:
      • "ENTERPRISE_CONTENT_ONLY"
      • "EXTENDED_KNOWLEDGE_ENABLED"
    • topicConfigurations — (Array<map>)

      The topic specific controls configured for a Amazon Q Business application.

      • description — (String)

        A description for your topic control configuration. Use this to outline how the large language model (LLM) should use this topic control configuration.

      • exampleChatMessages — (Array<String>)

        A list of example phrases that you expect the end user to use in relation to the topic.

      • name — required — (String)

        A name for your topic control configuration.

      • rules — required — (Array<map>)

        Rules defined for a topic configuration.

        • excludedUsersAndGroups — (map)

          Users and groups to be excluded from a rule.

          • userGroups — (Array<String>)

            The user groups associated with a topic control rule.

          • userIds — (Array<String>)

            The user ids associated with a topic control rule.

        • includedUsersAndGroups — (map)

          Users and groups to be included in a rule.

          • userGroups — (Array<String>)

            The user groups associated with a topic control rule.

          • userIds — (Array<String>)

            The user ids associated with a topic control rule.

        • ruleConfiguration — (map)

          The configuration information for a rule.

          • contentBlockerRule — (map)

            A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

            • systemMessageOverride — (String)

              The configured custom message displayed to an end user informing them that they've used a blocked phrase during chat.

          • contentRetrievalRule — (map)

            Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

            • eligibleDataSources — (Array<map>)

              Specifies data sources in a Amazon Q Business application to use for content generation.

              • dataSourceId — (String)

                The identifier of the data source.

              • indexId — (String)

                The identifier of the index the data source is attached to.

        • ruleType — required — (String)

          The type of rule.

          Possible values include:
          • "CONTENT_BLOCKER_RULE"
          • "CONTENT_RETRIEVAL_RULE"

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  dataSourceId: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE' /* required */
};
qbusiness.getDataSource(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application.

  • dataSourceId — (String)

    The identifier of the data source connector.

  • indexId — (String)

    The identfier of the index used with the data source connector.

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:

    • applicationId — (String)

      The identifier of the Amazon Q Business application.

    • configuration — (map)

      The details of how the data source connector is configured.

    • createdAt — (Date)

      The Unix timestamp when the data source connector was created.

    • dataSourceArn — (String)

      The Amazon Resource Name (ARN) of the data source.

    • dataSourceId — (String)

      The identifier of the data source connector.

    • description — (String)

      The description for the data source connector.

    • displayName — (String)

      The name for the data source connector.

    • documentEnrichmentConfiguration — (map)

      Provides the configuration information for altering document metadata and content during the document ingestion process.

      For more information, see Custom document enrichment.

      • inlineConfigurations — (Array<map>)

        Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.

        • condition — (map)

          The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

          For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

          Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • documentContentOperator — (String)

          TRUE to delete content if the condition used for the target attribute is met.

          Possible values include:
          • "DELETE"
        • target — (map)

          The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

          For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

          Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

          You can also use this with DocumentAttributeCondition .

          • attributeValueOperator — (String)

            TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.

            Possible values include:
            • "DELETE"
          • key — required — (String)

            The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

      • postExtractionHookConfiguration — (map)

        Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

        You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

        If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

        You can only invoke one Lambda function. However, this function can invoke other functions it requires.

        For more information, see Custom document enrichment.

        • invocationCondition — (map)

          The condition used for when a Lambda function should be invoked.

          For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • lambdaArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

        • roleArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

        • s3BucketName — (String)

          Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

      • preExtractionHookConfiguration — (map)

        Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.

        You can configure your Lambda function using PreExtractionHookConfiguration if you want to apply advanced alterations on the original or raw documents.

        If you want to apply advanced alterations on the Amazon Q Business structured documents, you must configure your Lambda function using PostExtractionHookConfiguration.

        You can only invoke one Lambda function. However, this function can invoke other functions it requires.

        For more information, see Custom document enrichment.

        • invocationCondition — (map)

          The condition used for when a Lambda function should be invoked.

          For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.

          • key — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Q Business currently doesn't support _document_body as an attribute key used for the condition.

          • operator — required — (String)

            The identifier of the document attribute used for the condition.

            For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

            Amazon Kendra currently does not support _document_body as an attribute key used for the condition.

            Possible values include:
            • "GREATER_THAN"
            • "GREATER_THAN_OR_EQUALS"
            • "LESS_THAN"
            • "LESS_THAN_OR_EQUALS"
            • "EQUALS"
            • "NOT_EQUALS"
            • "CONTAINS"
            • "NOT_CONTAINS"
            • "EXISTS"
            • "NOT_EXISTS"
            • "BEGINS_WITH"
          • value — (map)

            The value of a document attribute. You can only provide one value for a document attribute.

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

            • longValue — (Integer)

              A long integer value.

            • stringListValue — (Array<String>)

              A list of strings.

            • stringValue — (String)

              A string.

        • lambdaArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion. For more information, see IAM roles for Custom Document Enrichment (CDE).

        • roleArn — (String)

          The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

        • s3BucketName — (String)

          Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

    • error — (map)

      When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

      • errorCode — (String)

        The code associated with the data source sync error.

        Possible values include:
        • "InternalError"
        • "InvalidRequest"
        • "ResourceInactive"
        • "ResourceNotFound"
      • errorMessage — (String)

        The message explaining the data source sync error.

    • indexId — (String)

      The identifier of the index linked to the data source connector.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

    • status — (String)

      The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

      Possible values include:
      • "PENDING_CREATION"
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
      • "UPDATING"
    • syncSchedule — (String)

      The schedule for Amazon Q Business to update the index.

    • type — (String)

      The type of the data source connector. For example, S3.

    • updatedAt — (Date)

      The Unix timestamp when the data source connector was last updated.

    • vpcConfiguration — (map)

      Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

      • securityGroupIds — required — (Array<String>)

        A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.

      • subnetIds — required — (Array<String>)

        A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  groupName: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE', /* required */
  dataSourceId: 'STRING_VALUE'
};
qbusiness.getGroup(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: {}) —
  • applicationId — (String)

    The identifier of the application id the group is attached to.

  • dataSourceId — (String)

    The identifier of the data source the group is attached to.

  • groupName — (String)

    The name of the group.

  • indexId — (String)

    The identifier of the index the group is attached to.

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:

    • status — (map)

      The current status of the group.

      • errorDetail — (map)

        The details of an error associated a group status.

        • errorCode — (String)

          The code associated with the data source sync error.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
          • "ResourceInactive"
          • "ResourceNotFound"
        • errorMessage — (String)

          The message explaining the data source sync error.

      • lastUpdatedAt — (Date)

        The Unix timestamp when the Amazon Q Business application was last updated.

      • status — (String)

        The status of a group.

        Possible values include:
        • "FAILED"
        • "SUCCEEDED"
        • "PROCESSING"
        • "DELETING"
        • "DELETED"
    • statusHistory — (Array<map>)

      The status history of the group.

      • errorDetail — (map)

        The details of an error associated a group status.

        • errorCode — (String)

          The code associated with the data source sync error.

          Possible values include:
          • "InternalError"
          • "InvalidRequest"
          • "ResourceInactive"
          • "ResourceNotFound"
        • errorMessage — (String)

          The message explaining the data source sync error.

      • lastUpdatedAt — (Date)

        The Unix timestamp when the Amazon Q Business application was last updated.

      • status — (String)

        The status of a group.

        Possible values include:
        • "FAILED"
        • "SUCCEEDED"
        • "PROCESSING"
        • "DELETING"
        • "DELETED"

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  indexId: 'STRING_VALUE' /* required */
};
qbusiness.getIndex(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application connected to the index.

  • indexId — (String)

    The identifier of the Amazon Q Business index you want information on.

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:

    • applicationId — (String)

      The identifier of the Amazon Q Business application associated with the index.

    • capacityConfiguration — (map)

      The storage capacity units chosen for your Amazon Q Business index.

      • units — (Integer)

        The number of storage units configured for an Amazon Q Business index.

    • createdAt — (Date)

      The Unix timestamp when the Amazon Q Business index was created.

    • description — (String)

      The description for the Amazon Q Business index.

    • displayName — (String)

      The name of the Amazon Q Business index.

    • documentAttributeConfigurations — (Array<map>)

      Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.

      • name — (String)

        The name of the document attribute.

      • search — (String)

        Information about whether the document attribute can be used by an end user to search for information on their web experience.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • type — (String)

        The type of document attribute.

        Possible values include:
        • "STRING"
        • "STRING_LIST"
        • "NUMBER"
        • "DATE"
    • error — (map)

      When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

      • errorCode — (String)

        The code associated with the data source sync error.

        Possible values include:
        • "InternalError"
        • "InvalidRequest"
        • "ResourceInactive"
        • "ResourceNotFound"
      • errorMessage — (String)

        The message explaining the data source sync error.

    • indexArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Q Business index.

    • indexId — (String)

      The identifier of the Amazon Q Business index.

    • indexStatistics — (map)

      Provides information about the number of documents indexed.

      • textDocumentStatistics — (map)

        The number of documents indexed.

        • indexedTextBytes — (Integer)

          The total size, in bytes, of the indexed documents.

        • indexedTextDocumentCount — (Integer)

          The number of text documents indexed.

    • status — (String)

      The current status of the index. When the value is ACTIVE, the index is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
      • "UPDATING"
    • updatedAt — (Date)

      The Unix timestamp when the Amazon Q Business index was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  pluginId: 'STRING_VALUE' /* required */
};
qbusiness.getPlugin(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: {}) —
  • applicationId — (String)

    The identifier of the application which contains the plugin.

  • pluginId — (String)

    The identifier of the plugin.

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:

    • applicationId — (String)

      The identifier of the application which contains the plugin.

    • authConfiguration — (map)

      Authentication configuration information for an Amazon Q Business plugin.

      • basicAuthConfiguration — (map)

        Information about the basic authentication credentials used to configure a plugin.

        • roleArn — required — (String)

          The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

        • secretArn — required — (String)

          The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

      • oAuth2ClientCredentialConfiguration — (map)

        Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

        • roleArn — required — (String)

          The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0 authentication credentials stored in a Secrets Manager secret.

        • secretArn — required — (String)

          The ARN of the Secrets Manager secret that stores the OAuth 2.0 credentials/token used for plugin configuration.

    • createdAt — (Date)

      The timestamp for when the plugin was created.

    • displayName — (String)

      The name of the plugin.

    • pluginArn — (String)

      The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

    • pluginId — (String)

      The identifier of the plugin.

    • serverUrl — (String)

      The source URL used for plugin configuration.

    • state — (String)

      The current state of the plugin.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • type — (String)

      The type of the plugin.

      Possible values include:
      • "SERVICE_NOW"
      • "SALESFORCE"
      • "JIRA"
      • "ZENDESK"
    • updatedAt — (Date)

      The timestamp for when the plugin was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  retrieverId: 'STRING_VALUE' /* required */
};
qbusiness.getRetriever(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application using the retriever.

  • retrieverId — (String)

    The identifier of the retriever.

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:

    • applicationId — (String)

      The identifier of the Amazon Q Business application using the retriever.

    • configuration — (map)

      Provides information on how the retriever used for your Amazon Q Business application is configured.

      • kendraIndexConfiguration — (map)

        Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

        • indexId — required — (String)

          The identifier of the Amazon Kendra index.

      • nativeIndexConfiguration — (map)

        Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

        • boostingOverride — (map<map>)

          Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

          • dateConfiguration — (map)

            Provides information on boosting DATE type document attributes.

            • boostingDurationInSeconds — (Integer)

              Specifies the duration, in seconds, of a boost applies to a DATE type document attribute.

            • boostingLevel — required — (String)

              Specifies how much a document attribute is boosted.

              Possible values include:
              • "NONE"
              • "LOW"
              • "MEDIUM"
              • "HIGH"
              • "VERY_HIGH"
          • numberConfiguration — (map)

            Provides information on boosting NUMBER type document attributes.

            • boostingLevel — required — (String)

              Specifies the duration, in seconds, of a boost applies to a NUMBER type document attribute.

              Possible values include:
              • "NONE"
              • "LOW"
              • "MEDIUM"
              • "HIGH"
              • "VERY_HIGH"
            • boostingType — (String)

              Specifies how much a document attribute is boosted.

              Possible values include:
              • "PRIORITIZE_LARGER_VALUES"
              • "PRIORITIZE_SMALLER_VALUES"
          • stringConfiguration — (map)

            Provides information on boosting STRING type document attributes.

            • attributeValueBoosting — (map<String>)

              Specifies specific values of a STRING type document attribute being boosted.

            • boostingLevel — required — (String)

              Specifies how much a document attribute is boosted.

              Possible values include:
              • "NONE"
              • "LOW"
              • "MEDIUM"
              • "HIGH"
              • "VERY_HIGH"
          • stringListConfiguration — (map)

            Provides information on boosting STRING_LIST type document attributes.

            • boostingLevel — required — (String)

              Specifies how much a document attribute is boosted.

              Possible values include:
              • "NONE"
              • "LOW"
              • "MEDIUM"
              • "HIGH"
              • "VERY_HIGH"
        • indexId — required — (String)

          The identifier for the Amazon Q Business index.

    • createdAt — (Date)

      The Unix timestamp when the retriever was created.

    • displayName — (String)

      The name of the retriever.

    • retrieverArn — (String)

      The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

    • retrieverId — (String)

      The identifier of the retriever.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

    • status — (String)

      The status of the retriever.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "FAILED"
    • type — (String)

      The type of the retriever.

      Possible values include:
      • "NATIVE_INDEX"
      • "KENDRA_INDEX"
    • updatedAt — (Date)

      The Unix timestamp when the retriever was last updated.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  userId: 'STRING_VALUE' /* required */
};
qbusiness.getUser(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: {}) —
  • applicationId — (String)

    The identifier of the application connected to the user.

  • userId — (String)

    The user email address attached to 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. The data object has the following properties:

    • userAliases — (Array<map>)

      A list of user aliases attached to a user.

      • dataSourceId — (String)

        The identifier of the data source that the user aliases are associated with.

      • indexId — (String)

        The identifier of the index that the user aliases are associated with.

      • userId — required — (String)

        The identifier of the user id associated with the user aliases.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  webExperienceId: 'STRING_VALUE' /* required */
};
qbusiness.getWebExperience(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: {}) —
  • applicationId — (String)

    The identifier of the Amazon Q Business application linked to the web experience.

  • webExperienceId — (String)

    The identifier of the Amazon Q Business web experience.

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:

    • applicationId — (String)

      The identifier of the Amazon Q Business application linked to the web experience.

    • authenticationConfiguration — (map)

      The authentication configuration information for your Amazon Q Business web experience.

      • samlConfiguration — (map)

        Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

        • metadataXML — required — (String)

          The metadata XML that your IdP generated.

        • roleArn — required — (String)

          The Amazon Resource Name (ARN) of an IAM role assumed by users when they authenticate into their Amazon Q Business web experience, containing the relevant Amazon Q Business permissions for conversing with Amazon Q Business.

        • userGroupAttribute — (String)

          The group attribute name in your IdP that maps to user groups.

        • userIdAttribute — required — (String)

          The user attribute name in your IdP that maps to the user email.

    • createdAt — (Date)

      The Unix timestamp when the retriever was created.

    • defaultEndpoint — (String)

      The endpoint of your Amazon Q Business web experience.

    • error — (map)

      When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

      • errorCode — (String)

        The code associated with the data source sync error.

        Possible values include:
        • "InternalError"
        • "InvalidRequest"
        • "ResourceInactive"
        • "ResourceNotFound"
      • errorMessage — (String)

        The message explaining the data source sync error.

    • roleArn — (String)

      The Amazon Resource Name (ARN) of the service role attached to your web experience.

    • samplePromptsControlMode — (String)

      Determines whether sample prompts are enabled in the web experience for an end user.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
    • status — (String)

      The current status of the Amazon Q Business web experience. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

      Possible values include:
      • "CREATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
      • "PENDING_AUTH_CONFIG"
    • subtitle — (String)

      The subtitle for your Amazon Q Business web experience.

    • title — (String)

      The title for your Amazon Q Business web experience.

    • updatedAt — (Date)

      The Unix timestamp when the data source connector was last updated.

    • webExperienceArn — (String)

      The Amazon Resource Name (ARN) of the role with the permission to access the Amazon Q Business web experience and required resources.

    • webExperienceId — (String)

      The identifier of the Amazon Q Business web experience.

    • welcomeMessage — (String)

      The customized welcome message for end users of an Amazon Q Business web experience.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qbusiness.listApplications(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: {}) —
  • maxResults — (Integer)

    The maximum number of Amazon Q Business applications to return.

  • nextToken — (String)

    If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business applications.

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:

    • applications — (Array<map>)

      An array of summary information on the configuration of one or more Amazon Q Business applications.

      • applicationId — (String)

        The identifier for the Amazon Q Business application.

      • createdAt — (Date)

        The Unix timestamp when the Amazon Q Business application was created.

      • displayName — (String)

        The name of the Amazon Q Business application.

      • status — (String)

        The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.

        Possible values include:
        • "CREATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
        • "UPDATING"
      • updatedAt — (Date)

        The Unix timestamp when the Amazon Q Business application was last updated.

    • nextToken — (String)

      If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of applications.