Class: AWS.QConnect

var params = {
  assistantId: 'STRING_VALUE', /* required */
  association: { /* required */
    knowledgeBaseId: 'STRING_VALUE'
  },
  associationType: KNOWLEDGE_BASE, /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qconnect.createAssistantAssociation(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • association — (map)

    The identifier of the associated resource.

    • knowledgeBaseId — (String)

      The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

  • associationType — (String)

    The type of association.

    Possible values include:
    • "KNOWLEDGE_BASE"
  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The tags used to organize, track, or control access for this resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • assistantAssociation — (map)

      The assistant association.

      • assistantArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • assistantAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the assistant association.

      • assistantAssociationId — required — (String)

        The identifier of the assistant association.

      • assistantId — required — (String)

        The identifier of the Amazon Q in Connect assistant.

      • associationData — required — (map)

        A union type that currently has a single argument, the knowledge base ID.

        • knowledgeBaseAssociation — (map)

          The knowledge base where output data is sent.

          • knowledgeBaseArn — (String)

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId — (String)

            The identifier of the knowledge base.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "KNOWLEDGE_BASE"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  knowledgeBaseId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  uploadId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  metadata: {
    '<NonEmptyString>': 'STRING_VALUE',
    /* '<NonEmptyString>': ... */
  },
  overrideLinkOutUri: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  title: 'STRING_VALUE'
};
qconnect.createContent(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • metadata — (map<String>)

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

  • name — (String)

    The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

  • overrideLinkOutUri — (String)

    The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

  • tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

  • title — (String)

    The title of the content. If not set, the title is equal to the name.

  • uploadId — (String)

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

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:

    • content — (map)

      The content.

      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentId — required — (String)

        The identifier of the content.

      • contentType — required — (String)

        The media type of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • linkOutUri — (String)

        The URI of the content.

      • metadata — required — (map<String>)

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

      • name — required — (String)

        The name of the content.

      • revisionId — required — (String)

        The identifier of the content revision.

      • status — required — (String)

        The status of the content.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • title — required — (String)

        The title of the content.

      • url — required — (String)

        The URL of the content.

      • urlExpiry — required — (Date)

        The expiration time of the URL as an epoch timestamp.

Returns:

• (AWS.Request) —

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

var params = {
  association: { /* required */
    amazonConnectGuideAssociation: {
      flowId: 'STRING_VALUE'
    }
  },
  associationType: AMAZON_CONNECT_GUIDE, /* required */
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qconnect.createContentAssociation(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: {}) —
  • association — (map)

    The identifier of the associated resource.

    • amazonConnectGuideAssociation — (map)

      The data of the step-by-step guide association.

      • flowId — (String)

        The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

  • associationType — (String)

    The type of association.

    Possible values include:
    • "AMAZON_CONNECT_GUIDE"
  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The identifier of the content.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base.

  • tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • contentAssociation — (map)

      The association between Amazon Q in Connect content and another resource.

      • associationData — required — (map)

        The content association.

        • amazonConnectGuideAssociation — (map)

          The data of the step-by-step guide association.

          • flowId — (String)

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "AMAZON_CONNECT_GUIDE"
      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId — required — (String)

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId — required — (String)

        The identifier of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  knowledgeBaseType: EXTERNAL | CUSTOM | QUICK_RESPONSES, /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  renderingConfiguration: {
    templateUri: 'STRING_VALUE'
  },
  serverSideEncryptionConfiguration: {
    kmsKeyId: 'STRING_VALUE'
  },
  sourceConfiguration: {
    appIntegrations: {
      appIntegrationArn: 'STRING_VALUE', /* required */
      objectFields: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qconnect.createKnowledgeBase(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: {}) —
  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The description.

  • knowledgeBaseType — (String)

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Possible values include:
    • "EXTERNAL"
    • "CUSTOM"
    • "QUICK_RESPONSES"
  • name — (String)

    The name of the knowledge base.

  • renderingConfiguration — (map)

    Information about how to render the content.

    • templateUri — (String)

      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

      • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

      • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

      • Zendesk: id, title, updated_at, or draft

      The variable is replaced with the actual value for a piece of content when calling GetContent.

  • serverSideEncryptionConfiguration — (map)

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    • kmsKeyId — (String)

      The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

  • sourceConfiguration — (map)

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    • appIntegrations — (map)

      Configuration information for Amazon AppIntegrations to automatically ingest content.

      • appIntegrationArn — required — (String)

        The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

        • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

        • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

        • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

        • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

        • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

          The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

      • objectFields — (Array<String>)

        The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

        • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

        • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

        • For Zendesk, you must include at least id, title, updated_at, and draft.

        Make sure to include additional fields. These fields are indexed and used to source recommendations.

  • tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • knowledgeBase — (map)

      The knowledge base.

      • description — (String)

        The description.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • knowledgeBaseType — required — (String)

        The type of knowledge base.

        Possible values include:
        • "EXTERNAL"
        • "CUSTOM"
        • "QUICK_RESPONSES"
      • lastContentModificationTime — (Date)

        An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      • name — required — (String)

        The name of the knowledge base.

      • renderingConfiguration — (map)

        Information about how to render the content.

        • templateUri — (String)

          A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

          • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

          • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

          • Zendesk: id, title, updated_at, or draft

          The variable is replaced with the actual value for a piece of content when calling GetContent.

      • serverSideEncryptionConfiguration — (map)

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

        For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • kmsKeyId — (String)

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

      • sourceConfiguration — (map)

        Source configuration information about the knowledge base.

        • appIntegrations — (map)

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn — required — (String)

            The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

            • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

            • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

            • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

            • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

              The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

          • objectFields — (Array<String>)

            The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

            • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

            • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

            • For Zendesk, you must include at least id, title, updated_at, and draft.

            Make sure to include additional fields. These fields are indexed and used to source recommendations.

      • status — required — (String)

        The status of the knowledge base.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  content: { /* required */
    content: 'STRING_VALUE'
  },
  knowledgeBaseId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  channels: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  contentType: 'STRING_VALUE',
  description: 'STRING_VALUE',
  groupingConfiguration: {
    criteria: 'STRING_VALUE',
    values: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  isActive: true || false,
  language: 'STRING_VALUE',
  shortcutKey: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qconnect.createQuickResponse(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: {}) —
  • channels — (Array<String>)

    The Amazon Connect channels this quick response applies to.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The content of the quick response.

    • content — (String)

      The content of the quick response.

  • contentType — (String)

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for a quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

  • description — (String)

    The description of the quick response.

  • groupingConfiguration — (map)

    The configuration information of the user groups that the quick response is accessible to.

    • criteria — (String)

      The criteria used for grouping Amazon Q in Connect users.

      The following is the list of supported criteria values.

      • RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

    • values — (Array<String>)

      The list of values that define different groups of Amazon Q in Connect users.

      • When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

  • isActive — (Boolean)

    Whether the quick response is active.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • language — (String)

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • name — (String)

    The name of the quick response.

  • shortcutKey — (String)

    The shortcut key of the quick response. The value should be unique across the knowledge base.

  • tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • quickResponse — (map)

      The quick response.

      • channels — (Array<String>)

        The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

      • contentType — required — (String)

        The media type of the quick response content.

        • Use application/x.quickresponse;format=plain for quick response written in plain text.

        • Use application/x.quickresponse;format=markdown for quick response written in richtext.

      • contents — (map)

        The contents of the quick response.

        • markdown — (map)

          The container quick response content.

          • content — (String)

            The content of the quick response.

        • plainText — (map)

          The container quick response content.

          • content — (String)

            The content of the quick response.

      • createdTime — required — (Date)

        The timestamp when the quick response was created.

      • description — (String)

        The description of the quick response.

      • groupingConfiguration — (map)

        The configuration information of the user groups that the quick response is accessible to.

        • criteria — (String)

          The criteria used for grouping Amazon Q in Connect users.

          The following is the list of supported criteria values.

          • RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

        • values — (Array<String>)

          The list of values that define different groups of Amazon Q in Connect users.

          • When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

      • isActive — (Boolean)

        Whether the quick response is active.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • language — (String)

        The language code value for the language in which the quick response is written.

      • lastModifiedBy — (String)

        The Amazon Resource Name (ARN) of the user who last updated the quick response data.

      • lastModifiedTime — required — (Date)

        The timestamp when the quick response data was last modified.

      • name — required — (String)

        The name of the quick response.

      • quickResponseArn — required — (String)

        The Amazon Resource Name (ARN) of the quick response.

      • quickResponseId — required — (String)

        The identifier of the quick response.

      • shortcutKey — (String)

        The shortcut key of the quick response. The value should be unique across the knowledge base.

      • status — required — (String)

        The status of the quick response data.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "CREATED"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tagFilter: {
    andConditions: [
      {
        key: 'STRING_VALUE', /* required */
        value: 'STRING_VALUE'
      },
      /* more items */
    ],
    orConditions: [
      {
        andConditions: [
          {
            key: 'STRING_VALUE', /* required */
            value: 'STRING_VALUE'
          },
          /* more items */
        ],
        tagCondition: {
          key: 'STRING_VALUE', /* required */
          value: 'STRING_VALUE'
        }
      },
      /* more items */
    ],
    tagCondition: {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE'
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
qconnect.createSession(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

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

    The description.

  • name — (String)

    The name of the session.

  • tagFilter — (map)

    An object that can be used to specify Tag conditions.

    • andConditions — (Array<map>)

      A list of conditions which would be applied together with an AND condition.

      • key — required — (String)

        The tag key in the tag condition.

      • value — (String)

        The tag value in the tag condition.

    • orConditions — (Array<map>)

      A list of conditions which would be applied together with an OR condition.

      • andConditions — (Array<map>)

        A list of conditions which would be applied together with an AND condition.

        • key — required — (String)

          The tag key in the tag condition.

        • value — (String)

          The tag value in the tag condition.

      • tagCondition — (map)

        A leaf node condition which can be used to specify a tag condition.

        • key — required — (String)

          The tag key in the tag condition.

        • value — (String)

          The tag value in the tag condition.

    • tagCondition — (map)

      A leaf node condition which can be used to specify a tag condition.

      • key — required — (String)

        The tag key in the tag condition.

      • value — (String)

        The tag value in the tag condition.

  • tags — (map<String>)

    The tags used to organize, track, or control access for this resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • session — (map)

      The session.

      • description — (String)

        The description of the session.

      • integrationConfiguration — (map)

        The configuration information for the session integration.

        • topicIntegrationArn — (String)

          The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

      • name — required — (String)

        The name of the session.

      • sessionArn — required — (String)

        The Amazon Resource Name (ARN) of the session.

      • sessionId — required — (String)

        The identifier of the session.

      • tagFilter — (map)

        An object that can be used to specify Tag conditions.

        • andConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • key — required — (String)

            The tag key in the tag condition.

          • value — (String)

            The tag value in the tag condition.

        • orConditions — (Array<map>)

          A list of conditions which would be applied together with an OR condition.

          • andConditions — (Array<map>)

            A list of conditions which would be applied together with an AND condition.

            • key — required — (String)

              The tag key in the tag condition.

            • value — (String)

              The tag value in the tag condition.

          • tagCondition — (map)

            A leaf node condition which can be used to specify a tag condition.

            • key — required — (String)

              The tag key in the tag condition.

            • value — (String)

              The tag value in the tag condition.

        • tagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • key — required — (String)

            The tag key in the tag condition.

          • value — (String)

            The tag value in the tag condition.

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

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

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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 = {
  assistantAssociationId: 'STRING_VALUE', /* required */
  assistantId: 'STRING_VALUE' /* required */
};
qconnect.deleteAssistantAssociation(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: {}) —
  • assistantAssociationId — (String)

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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 = {
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.deleteContent(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: {}) —
  • contentId — (String)

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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 = {
  contentAssociationId: 'STRING_VALUE', /* required */
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.deleteContentAssociation(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: {}) —
  • contentAssociationId — (String)

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • contentId — (String)

    The identifier of the content.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base.

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 = {
  importJobId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.deleteImportJob(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: {}) —
  • importJobId — (String)

    The identifier of the import job to be deleted.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base.

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

    The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

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 = {
  knowledgeBaseId: 'STRING_VALUE', /* required */
  quickResponseId: 'STRING_VALUE' /* required */
};
qconnect.deleteQuickResponse(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: {}) —
  • knowledgeBaseId — (String)

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base.

  • quickResponseId — (String)

    The identifier of the quick response to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • assistant — (map)

      Information about the assistant.

      • assistantArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • assistantId — required — (String)

        The identifier of the Amazon Q in Connect assistant.

      • capabilityConfiguration — (map)

        The configuration information for the Amazon Q in Connect assistant capability.

        • type — (String)

          The type of Amazon Q in Connect assistant capability.

          Possible values include:
          • "V1"
          • "V2"
      • description — (String)

        The description.

      • integrationConfiguration — (map)

        The configuration information for the Amazon Q in Connect assistant integration.

        • topicIntegrationArn — (String)

          The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

      • name — required — (String)

        The name.

      • serverSideEncryptionConfiguration — (map)

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

        For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • kmsKeyId — (String)

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

      • status — required — (String)

        The status of the assistant.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • type — required — (String)

        The type of assistant.

        Possible values include:
        • "AGENT"

Returns:

• (AWS.Request) —

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

var params = {
  assistantAssociationId: 'STRING_VALUE', /* required */
  assistantId: 'STRING_VALUE' /* required */
};
qconnect.getAssistantAssociation(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: {}) —
  • assistantAssociationId — (String)

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • assistantAssociation — (map)

      The assistant association.

      • assistantArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • assistantAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the assistant association.

      • assistantAssociationId — required — (String)

        The identifier of the assistant association.

      • assistantId — required — (String)

        The identifier of the Amazon Q in Connect assistant.

      • associationData — required — (map)

        A union type that currently has a single argument, the knowledge base ID.

        • knowledgeBaseAssociation — (map)

          The knowledge base where output data is sent.

          • knowledgeBaseArn — (String)

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId — (String)

            The identifier of the knowledge base.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "KNOWLEDGE_BASE"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.getContent(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: {}) —
  • contentId — (String)

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • content — (map)

      The content.

      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentId — required — (String)

        The identifier of the content.

      • contentType — required — (String)

        The media type of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • linkOutUri — (String)

        The URI of the content.

      • metadata — required — (map<String>)

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

      • name — required — (String)

        The name of the content.

      • revisionId — required — (String)

        The identifier of the content revision.

      • status — required — (String)

        The status of the content.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • title — required — (String)

        The title of the content.

      • url — required — (String)

        The URL of the content.

      • urlExpiry — required — (Date)

        The expiration time of the URL as an epoch timestamp.

Returns:

• (AWS.Request) —

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

var params = {
  contentAssociationId: 'STRING_VALUE', /* required */
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.getContentAssociation(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: {}) —
  • contentAssociationId — (String)

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • contentId — (String)

    The identifier of the content.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base.

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:

    • contentAssociation — (map)

      The association between Amazon Q in Connect content and another resource.

      • associationData — required — (map)

        The content association.

        • amazonConnectGuideAssociation — (map)

          The data of the step-by-step guide association.

          • flowId — (String)

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "AMAZON_CONNECT_GUIDE"
      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId — required — (String)

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId — required — (String)

        The identifier of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  contentId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.getContentSummary(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: {}) —
  • contentId — (String)

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • contentSummary — (map)

      The content summary.

      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentId — required — (String)

        The identifier of the content.

      • contentType — required — (String)

        The media type of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

      • metadata — required — (map<String>)

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

      • name — required — (String)

        The name of the content.

      • revisionId — required — (String)

        The identifier of the revision of the content.

      • status — required — (String)

        The status of the content.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • title — required — (String)

        The title of the content.

Returns:

• (AWS.Request) —

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

var params = {
  importJobId: 'STRING_VALUE', /* required */
  knowledgeBaseId: 'STRING_VALUE' /* required */
};
qconnect.getImportJob(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: {}) —
  • importJobId — (String)

    The identifier of the import job to retrieve.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base that the import job belongs 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:

    • importJob — (map)

      The import job.

      • createdTime — required — (Date)

        The timestamp when the import job was created.

      • externalSourceConfiguration — (map)

        The configuration information of the external data source.

        • configuration — required — (map)

          The configuration information of the external data source.

          • connectConfiguration — (map)

            The configuration information of the Amazon Connect data source.

            • instanceId — (String)

              The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • source — required — (String)

          The type of the external data source.

          Possible values include:
          • "AMAZON_CONNECT"
      • failedRecordReport — (String)

        The link to download the information of resource data that failed to be imported.

      • importJobId — required — (String)

        The identifier of the import job.

      • importJobType — required — (String)

        The type of the import job.

        Possible values include:
        • "QUICK_RESPONSES"
      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • lastModifiedTime — required — (Date)

        The timestamp when the import job data was last modified.

      • metadata — (map<String>)

        The metadata fields of the imported Amazon Q in Connect resources.

      • status — required — (String)

        The status of the import job.

        Possible values include:
        • "START_IN_PROGRESS"
        • "FAILED"
        • "COMPLETE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • uploadId — required — (String)

        A pointer to the uploaded asset. This value is returned by StartContentUpload.

      • url — required — (String)

        The download link to the resource file that is uploaded to the import job.

      • urlExpiry — required — (Date)

        The expiration time of the URL as an epoch timestamp.

Returns:

• (AWS.Request) —

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

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

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • knowledgeBase — (map)

      The knowledge base.

      • description — (String)

        The description.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • knowledgeBaseType — required — (String)

        The type of knowledge base.

        Possible values include:
        • "EXTERNAL"
        • "CUSTOM"
        • "QUICK_RESPONSES"
      • lastContentModificationTime — (Date)

        An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

      • name — required — (String)

        The name of the knowledge base.

      • renderingConfiguration — (map)

        Information about how to render the content.

        • templateUri — (String)

          A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

          • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

          • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

          • Zendesk: id, title, updated_at, or draft

          The variable is replaced with the actual value for a piece of content when calling GetContent.

      • serverSideEncryptionConfiguration — (map)

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

        For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • kmsKeyId — (String)

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

      • sourceConfiguration — (map)

        Source configuration information about the knowledge base.

        • appIntegrations — (map)

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn — required — (String)

            The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

            • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

            • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

            • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

            • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

              The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

          • objectFields — (Array<String>)

            The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

            • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

            • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

            • For Zendesk, you must include at least id, title, updated_at, and draft.

            Make sure to include additional fields. These fields are indexed and used to source recommendations.

      • status — required — (String)

        The status of the knowledge base.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  knowledgeBaseId: 'STRING_VALUE', /* required */
  quickResponseId: 'STRING_VALUE' /* required */
};
qconnect.getQuickResponse(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: {}) —
  • knowledgeBaseId — (String)

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

  • quickResponseId — (String)

    The identifier of the quick response.

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:

    • quickResponse — (map)

      The quick response.

      • channels — (Array<String>)

        The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

      • contentType — required — (String)

        The media type of the quick response content.

        • Use application/x.quickresponse;format=plain for quick response written in plain text.

        • Use application/x.quickresponse;format=markdown for quick response written in richtext.

      • contents — (map)

        The contents of the quick response.

        • markdown — (map)

          The container quick response content.

          • content — (String)

            The content of the quick response.

        • plainText — (map)

          The container quick response content.

          • content — (String)

            The content of the quick response.

      • createdTime — required — (Date)

        The timestamp when the quick response was created.

      • description — (String)

        The description of the quick response.

      • groupingConfiguration — (map)

        The configuration information of the user groups that the quick response is accessible to.

        • criteria — (String)

          The criteria used for grouping Amazon Q in Connect users.

          The following is the list of supported criteria values.

          • RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.

        • values — (Array<String>)

          The list of values that define different groups of Amazon Q in Connect users.

          • When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.

      • isActive — (Boolean)

        Whether the quick response is active.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • language — (String)

        The language code value for the language in which the quick response is written.

      • lastModifiedBy — (String)

        The Amazon Resource Name (ARN) of the user who last updated the quick response data.

      • lastModifiedTime — required — (Date)

        The timestamp when the quick response data was last modified.

      • name — required — (String)

        The name of the quick response.

      • quickResponseArn — required — (String)

        The Amazon Resource Name (ARN) of the quick response.

      • quickResponseId — required — (String)

        The identifier of the quick response.

      • shortcutKey — (String)

        The shortcut key of the quick response. The value should be unique across the knowledge base.

      • status — required — (String)

        The status of the quick response data.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "CREATED"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  waitTimeSeconds: 'NUMBER_VALUE'
};
qconnect.getRecommendations(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • sessionId — (String)

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • waitTimeSeconds — (Integer)

    The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

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:

    • recommendations — (Array<map>)

      The recommendations.

      • data — (map)

        Summary of the recommended content.

        • details — required — (map)

          Details about the data.

          • contentData — (map)

            Details about the content data.

            • rankingData — required — (map)

              Details about the content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • textData — required — (map)

              Details about the content text data.

              • excerpt — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

              • title — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

          • generativeData — (map)

            Details about the generative data.

            • completion — required — (String)

              The LLM response.

            • rankingData — required — (map)

              Details about the generative content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • references — required — (Array<map>)

              The references used to generative the LLM response.

          • sourceContentData — (map)

            Details about the content data.

            • id — required — (String)

              The identifier of the source content.

            • rankingData — required — (map)

              Details about the source content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • textData — required — (map)

              Details about the source content text data.

              • excerpt — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

              • title — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

            • type — required — (String)

              The type of the source content.

              Possible values include:
              • "KNOWLEDGE_CONTENT"
        • reference — required — (map)

          Reference information about the content.

          • contentReference — (map)

            Reference information about the content.

            • contentArn — (String)

              The Amazon Resource Name (ARN) of the content.

            • contentId — (String)

              The identifier of the content.

            • knowledgeBaseArn — (String)

              The Amazon Resource Name (ARN) of the knowledge base.

            • knowledgeBaseId — (String)

              The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

          • generativeReference — (map)

            Reference information about the generative content.

            • generationId — (String)

              The identifier of the LLM model.

            • modelId — (String)

              The identifier of the LLM model.

      • document — (map)

        The recommended document.

        • contentReference — required — (map)

          A reference to the content resource.

          • contentArn — (String)

            The Amazon Resource Name (ARN) of the content.

          • contentId — (String)

            The identifier of the content.

          • knowledgeBaseArn — (String)

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId — (String)

            The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

        • excerpt — (map)

          The excerpt from the document.

          • highlights — (Array<map>)

            Highlights in the document text.

            • beginOffsetInclusive — (Integer)

              The offset for the start of the highlight.

            • endOffsetExclusive — (Integer)

              The offset for the end of the highlight.

          • text — (String)

            Text in the document.

        • title — (map)

          The title of the document.

          • highlights — (Array<map>)

            Highlights in the document text.

            • beginOffsetInclusive — (Integer)

              The offset for the start of the highlight.

            • endOffsetExclusive — (Integer)

              The offset for the end of the highlight.

          • text — (String)

            Text in the document.

      • recommendationId — required — (String)

        The identifier of the recommendation.

      • relevanceLevel — (String)

        The relevance level of the recommendation.

        Possible values include:
        • "HIGH"
        • "MEDIUM"
        • "LOW"
      • relevanceScore — (Float)

        The relevance score of the recommendation.

      • type — (String)

        The type of recommendation.

        Possible values include:
        • "KNOWLEDGE_CONTENT"
        • "GENERATIVE_RESPONSE"
        • "GENERATIVE_ANSWER"
    • triggers — (Array<map>)

      The triggers corresponding to recommendations.

      • data — required — (map)

        A union type containing information related to the trigger.

        • query — (map)

          Data associated with the QUERY RecommendationTriggerType.

          • text — (String)

            The text associated with the recommendation trigger.

      • id — required — (String)

        The identifier of the recommendation trigger.

      • recommendationIds — required — (Array<String>)

        The identifiers of the recommendations.

      • source — required — (String)

        The source of the recommendation trigger.

        • ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens issue.

        • RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens rule.

        Possible values include:
        • "ISSUE_DETECTION"
        • "RULE_EVALUATION"
        • "OTHER"
      • type — required — (String)

        The type of recommendation trigger.

        Possible values include:
        • "QUERY"
        • "GENERATIVE"

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE' /* required */
};
qconnect.getSession(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • sessionId — (String)

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • session — (map)

      The session.

      • description — (String)

        The description of the session.

      • integrationConfiguration — (map)

        The configuration information for the session integration.

        • topicIntegrationArn — (String)

          The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

      • name — required — (String)

        The name of the session.

      • sessionArn — required — (String)

        The Amazon Resource Name (ARN) of the session.

      • sessionId — required — (String)

        The identifier of the session.

      • tagFilter — (map)

        An object that can be used to specify Tag conditions.

        • andConditions — (Array<map>)

          A list of conditions which would be applied together with an AND condition.

          • key — required — (String)

            The tag key in the tag condition.

          • value — (String)

            The tag value in the tag condition.

        • orConditions — (Array<map>)

          A list of conditions which would be applied together with an OR condition.

          • andConditions — (Array<map>)

            A list of conditions which would be applied together with an AND condition.

            • key — required — (String)

              The tag key in the tag condition.

            • value — (String)

              The tag value in the tag condition.

          • tagCondition — (map)

            A leaf node condition which can be used to specify a tag condition.

            • key — required — (String)

              The tag key in the tag condition.

            • value — (String)

              The tag value in the tag condition.

        • tagCondition — (map)

          A leaf node condition which can be used to specify a tag condition.

          • key — required — (String)

            The tag key in the tag condition.

          • value — (String)

            The tag value in the tag condition.

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

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

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • assistantAssociationSummaries — (Array<map>)

      Summary information about assistant associations.

      • assistantArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • assistantAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the assistant association.

      • assistantAssociationId — required — (String)

        The identifier of the assistant association.

      • assistantId — required — (String)

        The identifier of the Amazon Q in Connect assistant.

      • associationData — required — (map)

        The association data.

        • knowledgeBaseAssociation — (map)

          The knowledge base where output data is sent.

          • knowledgeBaseArn — (String)

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId — (String)

            The identifier of the knowledge base.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "KNOWLEDGE_BASE"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qconnect.listAssistants(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 results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • assistantSummaries — (Array<map>)

      Information about the assistants.

      • assistantArn — required — (String)

        The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

      • assistantId — required — (String)

        The identifier of the Amazon Q in Connect assistant.

      • capabilityConfiguration — (map)

        The configuration information for the Amazon Q in Connect assistant capability.

        • type — (String)

          The type of Amazon Q in Connect assistant capability.

          Possible values include:
          • "V1"
          • "V2"
      • description — (String)

        The description of the assistant.

      • integrationConfiguration — (map)

        The configuration information for the Amazon Q in Connect assistant integration.

        • topicIntegrationArn — (String)

          The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.

      • name — required — (String)

        The name of the assistant.

      • serverSideEncryptionConfiguration — (map)

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

        For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • kmsKeyId — (String)

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

      • status — required — (String)

        The status of the assistant.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • type — required — (String)

        The type of the assistant.

        Possible values include:
        • "AGENT"
    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

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

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

    The identifier of the content.

  • knowledgeBaseId — (String)

    The identifier of the knowledge base.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • contentAssociationSummaries — (Array<map>)

      Summary information about content associations.

      • associationData — required — (map)

        The content association.

        • amazonConnectGuideAssociation — (map)

          The data of the step-by-step guide association.

          • flowId — (String)

            The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.

      • associationType — required — (String)

        The type of association.

        Possible values include:
        • "AMAZON_CONNECT_GUIDE"
      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentAssociationArn — required — (String)

        The Amazon Resource Name (ARN) of the content association.

      • contentAssociationId — required — (String)

        The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • contentId — required — (String)

        The identifier of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

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

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

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • contentSummaries — (Array<map>)

      Information about the content.

      • contentArn — required — (String)

        The Amazon Resource Name (ARN) of the content.

      • contentId — required — (String)

        The identifier of the content.

      • contentType — required — (String)

        The media type of the content.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

      • metadata — required — (map<String>)

        A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

      • name — required — (String)

        The name of the content.

      • revisionId — required — (String)

        The identifier of the revision of the content.

      • status — required — (String)

        The status of the content.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

      • title — required — (String)

        The title of the content.

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

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

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

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • importJobSummaries — (Array<map>)

      Summary information about the import jobs.

      • createdTime — required — (Date)

        The timestamp when the import job was created.

      • externalSourceConfiguration — (map)

        The configuration information of the external source that the resource data are imported from.

        • configuration — required — (map)

          The configuration information of the external data source.

          • connectConfiguration — (map)

            The configuration information of the Amazon Connect data source.

            • instanceId — (String)

              The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

        • source — required — (String)

          The type of the external data source.

          Possible values include:
          • "AMAZON_CONNECT"
      • importJobId — required — (String)

        The identifier of the import job.

      • importJobType — required — (String)

        The type of import job.

        Possible values include:
        • "QUICK_RESPONSES"
      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • lastModifiedTime — required — (Date)

        The timestamp when the import job was last modified.

      • metadata — (map<String>)

        The metadata fields of the imported Amazon Q in Connect resources.

      • status — required — (String)

        The status of the import job.

        Possible values include:
        • "START_IN_PROGRESS"
        • "FAILED"
        • "COMPLETE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • uploadId — required — (String)

        A pointer to the uploaded asset. This value is returned by StartContentUpload.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
qconnect.listKnowledgeBases(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 results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • knowledgeBaseSummaries — (Array<map>)

      Information about the knowledge bases.

      • description — (String)

        The description of the knowledge base.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • knowledgeBaseType — required — (String)

        The type of knowledge base.

        Possible values include:
        • "EXTERNAL"
        • "CUSTOM"
        • "QUICK_RESPONSES"
      • name — required — (String)

        The name of the knowledge base.

      • renderingConfiguration — (map)

        Information about how to render the content.

        • templateUri — (String)

          A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

          • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

          • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

          • Zendesk: id, title, updated_at, or draft

          The variable is replaced with the actual value for a piece of content when calling GetContent.

      • serverSideEncryptionConfiguration — (map)

        The configuration information for the customer managed key used for encryption.

        This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

        For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

        • kmsKeyId — (String)

          The customer managed key used for encryption. For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance. For information about valid ID values, see Key identifiers (KeyId).

      • sourceConfiguration — (map)

        Configuration information about the external data source.

        • appIntegrations — (map)

          Configuration information for Amazon AppIntegrations to automatically ingest content.

          • appIntegrationArn — required — (String)

            The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

            • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

            • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

            • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

            • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

            • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

              The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

          • objectFields — (Array<String>)

            The fields from the source that are made available to your agents in Amazon Q in Connect. Optional if ObjectConfiguration is included in the provided DataIntegration.

            • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

            • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

            • For Zendesk, you must include at least id, title, updated_at, and draft.

            Make sure to include additional fields. These fields are indexed and used to source recommendations.

      • status — required — (String)

        The status of the knowledge base summary.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

Returns:

• (AWS.Request) —

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

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

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • quickResponseSummaries — (Array<map>)

      Summary information about the quick responses.

      • channels — (Array<String>)

        The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

      • contentType — required — (String)

        The media type of the quick response content.

        • Use application/x.quickresponse;format=plain for quick response written in plain text.

        • Use application/x.quickresponse;format=markdown for quick response written in richtext.

      • createdTime — required — (Date)

        The timestamp when the quick response was created.

      • description — (String)

        The description of the quick response.

      • isActive — (Boolean)

        Whether the quick response is active.

      • knowledgeBaseArn — required — (String)

        The Amazon Resource Name (ARN) of the knowledge base.

      • knowledgeBaseId — required — (String)

        The identifier of the knowledge base.

      • lastModifiedBy — (String)

        The Amazon Resource Name (ARN) of the user who last updated the quick response data.

      • lastModifiedTime — required — (Date)

        The timestamp when the quick response summary was last modified.

      • name — required — (String)

        The name of the quick response.

      • quickResponseArn — required — (String)

        The Amazon Resource Name (ARN) of the quick response.

      • quickResponseId — required — (String)

        The identifier of the quick response.

      • status — required — (String)

        The resource status of the quick response.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "CREATED"
        • "DELETE_IN_PROGRESS"
        • "DELETE_FAILED"
        • "DELETED"
        • "UPDATE_IN_PROGRESS"
        • "UPDATE_FAILED"
      • tags — (map<String>)

        The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

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

Parameters:

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

    The Amazon Resource Name (ARN) of the resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • tags — (map<String>)

      The tags used to organize, track, or control access for this resource.

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  recommendationIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  sessionId: 'STRING_VALUE' /* required */
};
qconnect.notifyRecommendationsReceived(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • recommendationIds — (Array<String>)

    The identifiers of the recommendations.

  • sessionId — (String)

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • errors — (Array<map>)

      The identifiers of recommendations that are causing errors.

      • message — (String)

        A recommendation is causing an error.

      • recommendationId — (String)

        The identifier of the recommendation that is in error.

    • recommendationIds — (Array<String>)

      The identifiers of the recommendations.

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  contentFeedback: { /* required */
    generativeContentFeedbackData: {
      relevance: HELPFUL | NOT_HELPFUL /* required */
    }
  },
  targetId: 'STRING_VALUE', /* required */
  targetType: RECOMMENDATION | RESULT /* required */
};
qconnect.putFeedback(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant.

  • contentFeedback — (map)

    Information about the feedback provided.

    • generativeContentFeedbackData — (map)

      Information about the feedback for a generative target type.

      • relevance — required — (String)

        The relevance of the feedback.

        Possible values include:
        • "HELPFUL"
        • "NOT_HELPFUL"
  • targetId — (String)

    The identifier of the feedback target.

  • targetType — (String)

    The type of the feedback target.

    Possible values include:
    • "RECOMMENDATION"
    • "RESULT"

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:

    • assistantArn — (String)

      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    • assistantId — (String)

      The identifier of the Amazon Q in Connect assistant.

    • contentFeedback — (map)

      Information about the feedback provided.

      • generativeContentFeedbackData — (map)

        Information about the feedback for a generative target type.

        • relevance — required — (String)

          The relevance of the feedback.

          Possible values include:
          • "HELPFUL"
          • "NOT_HELPFUL"
    • targetId — (String)

      The identifier of the feedback target.

    • targetType — (String)

      The type of the feedback target.

      Possible values include:
      • "RECOMMENDATION"
      • "RESULT"

Returns:

• (AWS.Request) —

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

var params = {
  assistantId: 'STRING_VALUE', /* required */
  queryText: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  queryCondition: [
    {
      single: {
        comparator: EQUALS, /* required */
        field: RESULT_TYPE, /* required */
        value: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  sessionId: 'STRING_VALUE'
};
qconnect.queryAssistant(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: {}) —
  • assistantId — (String)

    The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • maxResults — (Integer)

    The maximum number of results to return per page.

  • nextToken — (String)

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • queryCondition — (Array<map>)

    Information about how to query content.

    • single — (map)

      The condition for the query.

      • comparator — required — (String)

        The comparison operator for query condition to query on.

        Possible values include:
        • "EQUALS"
      • field — required — (String)

        The name of the field for query condition to query on.

        Possible values include:
        • "RESULT_TYPE"
      • value — required — (String)

        The value for the query condition to query on.

  • queryText — (String)

    The text to search for.

  • sessionId — (String)

    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

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:

    • nextToken — (String)

      If there are additional results, this is the token for the next set of results.

    • results — (Array<map>)

      The results of the query.

      • data — (map)

        Summary of the recommended content.

        • details — required — (map)

          Details about the data.

          • contentData — (map)

            Details about the content data.

            • rankingData — required — (map)

              Details about the content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • textData — required — (map)

              Details about the content text data.

              • excerpt — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

              • title — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

          • generativeData — (map)

            Details about the generative data.

            • completion — required — (String)

              The LLM response.

            • rankingData — required — (map)

              Details about the generative content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • references — required — (Array<map>)

              The references used to generative the LLM response.

          • sourceContentData — (map)

            Details about the content data.

            • id — required — (String)

              The identifier of the source content.

            • rankingData — required — (map)

              Details about the source content ranking data.

              • relevanceLevel — (String)

                The relevance score of the content.

                Possible values include:
                • "HIGH"
                • "MEDIUM"
                • "LOW"
              • relevanceScore — (Float)

                The relevance level of the recommendation.

            • textData — required — (map)

              Details about the source content text data.

              • excerpt — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

              • title — (map)

                The text of the document.

                • highlights — (Array<map>)

                  Highlights in the document text.

                  • beginOffsetInclusive — (Integer)

                    The offset for the start of the highlight.

                  • endOffsetExclusive — (Integer)

                    The offset for the end of the highlight.

                • text — (String)

                  Text in the document.

            • type — required — (String)

              The type of the source content.

              Possible values include:
              • "KNOWLEDGE_CONTENT"
        • reference — required — (map)

          Reference information about the content.

          • contentReference — (map)

            Reference information about the content.

            • contentArn — (String)

              The Amazon Resource Name (ARN) of the content.

            • contentId — (String)

              The identifier of the content.

            • knowledgeBaseArn — (String)

              The Amazon Resource Name (ARN) of the knowledge base.

            • knowledgeBaseId — (String)

              The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

          • generativeReference — (map)

            Reference information about the generative content.

            • generationId — (String)

              The identifier of the LLM model.

            • modelId — (String)

              The identifier of the LLM model.

      • document — (map)

        The document.

        • contentReference — required — (map)

          A reference to the content resource.

          • contentArn — (String)

            The Amazon Resource Name (ARN) of the content.

          • contentId — (String)

            The identifier of the content.

          • knowledgeBaseArn — (String)

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId — (String)

            The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.

        • excerpt — (map)

          The excerpt from the document.

          • highlights — (Array<map>)

            Highlights in the document text.

            • beginOffsetInclusive — (Integer)

              The offset for the start of the highlight.

            • endOffsetExclusive — (Integer)

              The offset for the end of the highlight.

          • text — (String)

            Text in the document.

        • title — (map)

          The title of the document.

          • highlights — (Array<map>)

            Highlights in the document text.

            • beginOffsetInclusive — (Integer)

              The offset for the start of the highlight.

            • endOffsetExclusive — (Integer)

              The offset for the end of the highlight.

          • text — (String)

            Text in the document.

      • relevanceScore — (Float)

        The relevance score of the results.

      • resultId — required — (String)

        The identifier of the result data.

      • type — (String)

        The type of the query result.

        Possible values include:
        • "KNOWLEDGE_CONTENT"
        • "GENERATIVE_ANSWER"