GetDataSourceCommand

Suggest an Edit

Gets information about an existing Amazon Q Business data source connector.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetDataSourceCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetDataSourceCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetDataSourceRequest
  applicationId: "STRING_VALUE", // required
  indexId: "STRING_VALUE", // required
  dataSourceId: "STRING_VALUE", // required
};
const command = new GetDataSourceCommand(input);
const response = await client.send(command);
// { // GetDataSourceResponse
//   applicationId: "STRING_VALUE",
//   indexId: "STRING_VALUE",
//   dataSourceId: "STRING_VALUE",
//   dataSourceArn: "STRING_VALUE",
//   displayName: "STRING_VALUE",
//   type: "STRING_VALUE",
//   configuration: "DOCUMENT_VALUE",
//   vpcConfiguration: { // DataSourceVpcConfiguration
//     subnetIds: [ // SubnetIds // required
//       "STRING_VALUE",
//     ],
//     securityGroupIds: [ // SecurityGroupIds // required
//       "STRING_VALUE",
//     ],
//   },
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   description: "STRING_VALUE",
//   status: "PENDING_CREATION" || "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
//   syncSchedule: "STRING_VALUE",
//   roleArn: "STRING_VALUE",
//   error: { // ErrorDetail
//     errorMessage: "STRING_VALUE",
//     errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//   },
//   documentEnrichmentConfiguration: { // DocumentEnrichmentConfiguration
//     inlineConfigurations: [ // InlineDocumentEnrichmentConfigurations
//       { // InlineDocumentEnrichmentConfiguration
//         condition: { // DocumentAttributeCondition
//           key: "STRING_VALUE", // required
//           operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
//           value: { // DocumentAttributeValue Union: only one key present
//             stringValue: "STRING_VALUE",
//             stringListValue: [ // DocumentAttributeStringListValue
//               "STRING_VALUE",
//             ],
//             longValue: Number("long"),
//             dateValue: new Date("TIMESTAMP"),
//           },
//         },
//         target: { // DocumentAttributeTarget
//           key: "STRING_VALUE", // required
//           value: {//  Union: only one key present
//             stringValue: "STRING_VALUE",
//             stringListValue: [
//               "STRING_VALUE",
//             ],
//             longValue: Number("long"),
//             dateValue: new Date("TIMESTAMP"),
//           },
//           attributeValueOperator: "DELETE",
//         },
//         documentContentOperator: "DELETE",
//       },
//     ],
//     preExtractionHookConfiguration: { // HookConfiguration
//       invocationCondition: {
//         key: "STRING_VALUE", // required
//         operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
//         value: {//  Union: only one key present
//           stringValue: "STRING_VALUE",
//           stringListValue: [
//             "STRING_VALUE",
//           ],
//           longValue: Number("long"),
//           dateValue: new Date("TIMESTAMP"),
//         },
//       },
//       lambdaArn: "STRING_VALUE",
//       s3BucketName: "STRING_VALUE",
//       roleArn: "STRING_VALUE",
//     },
//     postExtractionHookConfiguration: {
//       invocationCondition: {
//         key: "STRING_VALUE", // required
//         operator: "GREATER_THAN" || "GREATER_THAN_OR_EQUALS" || "LESS_THAN" || "LESS_THAN_OR_EQUALS" || "EQUALS" || "NOT_EQUALS" || "CONTAINS" || "NOT_CONTAINS" || "EXISTS" || "NOT_EXISTS" || "BEGINS_WITH", // required
//         value: {//  Union: only one key present
//           stringValue: "STRING_VALUE",
//           stringListValue: [
//             "STRING_VALUE",
//           ],
//           longValue: Number("long"),
//           dateValue: new Date("TIMESTAMP"),
//         },
//       },
//       lambdaArn: "STRING_VALUE",
//       s3BucketName: "STRING_VALUE",
//       roleArn: "STRING_VALUE",
//     },
//   },
//   mediaExtractionConfiguration: { // MediaExtractionConfiguration
//     imageExtractionConfiguration: { // ImageExtractionConfiguration
//       imageExtractionStatus: "ENABLED" || "DISABLED", // required
//     },
//     audioExtractionConfiguration: { // AudioExtractionConfiguration
//       audioExtractionStatus: "ENABLED" || "DISABLED", // required
//     },
//     videoExtractionConfiguration: { // VideoExtractionConfiguration
//       videoExtractionStatus: "ENABLED" || "DISABLED", // required
//     },
//   },
// };

GetDataSourceCommand Input

See GetDataSourceCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business application.

dataSourceId
Required
string | undefined

The identifier of the data source connector.

indexId
Required
string | undefined

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

GetDataSourceCommand Output

See GetDataSourceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationId
string | undefined

The identifier of the Amazon Q Business application.

configuration
__DocumentType | undefined

The details of how the data source connector is configured.

createdAt
Date | undefined

The Unix timestamp when the data source connector was created.

dataSourceArn
string | undefined

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

dataSourceId
string | undefined

The identifier of the data source connector.

description
string | undefined

The description for the data source connector.

displayName
string | undefined

The name for the data source connector.

documentEnrichmentConfiguration
DocumentEnrichmentConfiguration | undefined

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

For more information, see Custom document enrichment .

error
ErrorDetail | undefined

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

indexId
string | undefined

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

mediaExtractionConfiguration
MediaExtractionConfiguration | undefined

The configuration for extracting information from media in documents for the data source.

roleArn
string | undefined

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

status
DataSourceStatus | undefined

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.

syncSchedule
string | undefined

The schedule for Amazon Q Business to update the index.

type
string | undefined

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

updatedAt
Date | undefined

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

vpcConfiguration
DataSourceVpcConfiguration | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.