This product is not supported for your selected Datadog site. ().
Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

aws_qbusiness_data_source

account_id

Type: STRING

application_id

Type: STRING
Provider name: applicationId
Description: The identifier of the Amazon Q Business application.

configuration

Type: STRUCT
Provider name: configuration
Description: The details of how the data source connector is configured.

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The Unix timestamp when the data source connector was created.

data_source_arn

Type: STRING
Provider name: dataSourceArn
Description: The Amazon Resource Name (ARN) of the data source.

data_source_id

Type: STRING
Provider name: dataSourceId
Description: The identifier of the data source connector.

description

Type: STRING
Provider name: description
Description: The description for the data source connector.

document_enrichment_configuration

Type: STRUCT
Provider name: documentEnrichmentConfiguration

  • inline_configurations
    Type: UNORDERED_LIST_STRUCT
    Provider name: inlineConfigurations
    Description: Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Q Business.
    • condition
      Type: STRUCT
      Provider name: condition
      • key
        Type: STRING
        Provider name: key
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn’t support _document_body as an attribute key used for the condition.
      • operator
        Type: STRING
        Provider name: operator
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
      • value
        Type: STRUCT
        Provider name: value
        • date_value
          Type: TIMESTAMP
          Provider name: dateValue
          Description: A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
        • long_value
          Type: INT64
          Provider name: longValue
          Description: A long integer value.
        • string_list_value
          Type: UNORDERED_LIST_STRING
          Provider name: stringListValue
          Description: A list of strings.
        • string_value
          Type: STRING
          Provider name: stringValue
          Description: A string.
    • document_content_operator
      Type: STRING
      Provider name: documentContentOperator
      Description: TRUE to delete content if the condition used for the target attribute is met.
    • target
      Type: STRUCT
      Provider name: target
      • attribute_value_operator
        Type: STRING
        Provider name: attributeValueOperator
        Description: TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE.
      • key
        Type: STRING
        Provider name: key
        Description: The identifier of the target document attribute or metadata field. For example, ‘Department’ could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
      • value
        Type: STRUCT
        Provider name: value
        • date_value
          Type: TIMESTAMP
          Provider name: dateValue
          Description: A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
        • long_value
          Type: INT64
          Provider name: longValue
          Description: A long integer value.
        • string_list_value
          Type: UNORDERED_LIST_STRING
          Provider name: stringListValue
          Description: A list of strings.
        • string_value
          Type: STRING
          Provider name: stringValue
          Description: A string.
  • post_extraction_hook_configuration
    Type: STRUCT
    Provider name: postExtractionHookConfiguration
    • invocation_condition
      Type: STRUCT
      Provider name: invocationCondition
      Description: The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
      • key
        Type: STRING
        Provider name: key
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn’t support _document_body as an attribute key used for the condition.
      • operator
        Type: STRING
        Provider name: operator
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
      • value
        Type: STRUCT
        Provider name: value
        • date_value
          Type: TIMESTAMP
          Provider name: dateValue
          Description: A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
        • long_value
          Type: INT64
          Provider name: longValue
          Description: A long integer value.
        • string_list_value
          Type: UNORDERED_LIST_STRING
          Provider name: stringListValue
          Description: A list of strings.
        • string_value
          Type: STRING
          Provider name: stringValue
          Description: A string.
    • lambda_arn
      Type: STRING
      Provider name: lambdaArn
      Description: The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
    • role_arn
      Type: STRING
      Provider name: roleArn
      Description: The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    • s3_bucket_name
      Type: STRING
      Provider name: s3BucketName
      Description: Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.
  • pre_extraction_hook_configuration
    Type: STRUCT
    Provider name: preExtractionHookConfiguration
    • invocation_condition
      Type: STRUCT
      Provider name: invocationCondition
      Description: The condition used for when a Lambda function should be invoked. For example, you can specify a condition that if there are empty date-time values, then Amazon Q Business should invoke a function that inserts the current date-time.
      • key
        Type: STRING
        Provider name: key
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently doesn’t support _document_body as an attribute key used for the condition.
      • operator
        Type: STRING
        Provider name: operator
        Description: The identifier of the document attribute used for the condition. For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents. Amazon Q Business currently does not support _document_body as an attribute key used for the condition.
      • value
        Type: STRUCT
        Provider name: value
        • date_value
          Type: TIMESTAMP
          Provider name: dateValue
          Description: A date expressed as an ISO 8601 string. It’s important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
        • long_value
          Type: INT64
          Provider name: longValue
          Description: A long integer value.
        • string_list_value
          Type: UNORDERED_LIST_STRING
          Provider name: stringListValue
          Description: A list of strings.
        • string_value
          Type: STRING
          Provider name: stringValue
          Description: A string.
    • lambda_arn
      Type: STRING
      Provider name: lambdaArn
      Description: The Amazon Resource Name (ARN) of the Lambda function sduring ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
    • role_arn
      Type: STRING
      Provider name: roleArn
      Description: The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.
    • s3_bucket_name
      Type: STRING
      Provider name: s3BucketName
      Description: Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

error

Type: STRUCT
Provider name: error
Description: When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

  • error_code
    Type: STRING
    Provider name: errorCode
    Description: The code associated with the Amazon Q Business request error.
  • error_message
    Type: STRING
    Provider name: errorMessage
    Description: The message explaining the Amazon Q Business request error.

index_id

Type: STRING
Provider name: indexId
Description: The identifier of the index linked to the data source connector.

media_extraction_configuration

Type: STRUCT
Provider name: mediaExtractionConfiguration
Description: The configuration for extracting information from media in documents for the data source.

  • audio_extraction_configuration
    Type: STRUCT
    Provider name: audioExtractionConfiguration
    Description: Configuration settings for extracting and processing audio content from media files.
    • audio_extraction_status
      Type: STRING
      Provider name: audioExtractionStatus
      Description: The status of audio extraction (ENABLED or DISABLED) for processing audio content from files.
  • image_extraction_configuration
    Type: STRUCT
    Provider name: imageExtractionConfiguration
    Description: The configuration for extracting semantic meaning from images in documents. For more information, see Extracting semantic meaning from images and visuals.
    • image_extraction_status
      Type: STRING
      Provider name: imageExtractionStatus
      Description: Specify whether to extract semantic meaning from images and visuals from documents.
  • video_extraction_configuration
    Type: STRUCT
    Provider name: videoExtractionConfiguration
    Description: Configuration settings for extracting and processing video content from media files.
    • video_extraction_status
      Type: STRING
      Provider name: videoExtractionStatus
      Description: The status of video extraction (ENABLED or DISABLED) for processing video content from files.

role_arn

Type: STRING
Provider name: roleArn
Description: The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

status

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

sync_schedule

Type: STRING
Provider name: syncSchedule
Description: The schedule for Amazon Q Business to update the index.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: type
Description: The type of the data source connector. For example, S3.

updated_at

Type: TIMESTAMP
Provider name: updatedAt
Description: The Unix timestamp when the data source connector was last updated.

vpc_configuration

Type: STRUCT
Provider name: vpcConfiguration
Description: Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

  • security_group_ids
    Type: UNORDERED_LIST_STRING
    Provider name: securityGroupIds
    Description: A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Q Business to connect to the data source.
  • subnet_ids
    Type: UNORDERED_LIST_STRING
    Provider name: subnetIds
    Description: A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.