AgentsforBedrock / Client / get_data_source

get_data_source#

AgentsforBedrock.Client.get_data_source(**kwargs)#

Gets information about a data source.

See also: AWS API Documentation

Request Syntax

response = client.get_data_source(
    dataSourceId='string',
    knowledgeBaseId='string'
)
Parameters:

  • dataSourceId (string) –

    [REQUIRED]

    The unique identifier of the data source.

  • knowledgeBaseId (string) –

    [REQUIRED]

    The unique identifier of the knowledge base for the data source.

Return type:

dict

Returns:

Response Syntax

{
    'dataSource': {
        'createdAt': datetime(2015, 1, 1),
        'dataDeletionPolicy': 'RETAIN'|'DELETE',
        'dataSourceConfiguration': {
            'confluenceConfiguration': {
                'crawlerConfiguration': {
                    'filterConfiguration': {
                        'patternObjectFilter': {
                            'filters': [
                                {
                                    'exclusionFilters': [
                                        'string',
                                    ],
                                    'inclusionFilters': [
                                        'string',
                                    ],
                                    'objectType': 'string'
                                },
                            ]
                        },
                        'type': 'PATTERN'
                    }
                },
                'sourceConfiguration': {
                    'authType': 'BASIC'|'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn': 'string',
                    'hostType': 'SAAS',
                    'hostUrl': 'string'
                }
            },
            's3Configuration': {
                'bucketArn': 'string',
                'bucketOwnerAccountId': 'string',
                'inclusionPrefixes': [
                    'string',
                ]
            },
            'salesforceConfiguration': {
                'crawlerConfiguration': {
                    'filterConfiguration': {
                        'patternObjectFilter': {
                            'filters': [
                                {
                                    'exclusionFilters': [
                                        'string',
                                    ],
                                    'inclusionFilters': [
                                        'string',
                                    ],
                                    'objectType': 'string'
                                },
                            ]
                        },
                        'type': 'PATTERN'
                    }
                },
                'sourceConfiguration': {
                    'authType': 'OAUTH2_CLIENT_CREDENTIALS',
                    'credentialsSecretArn': 'string',
                    'hostUrl': 'string'
                }
            },
            'sharePointConfiguration': {
                'crawlerConfiguration': {
                    'filterConfiguration': {
                        'patternObjectFilter': {
                            'filters': [
                                {
                                    'exclusionFilters': [
                                        'string',
                                    ],
                                    'inclusionFilters': [
                                        'string',
                                    ],
                                    'objectType': 'string'
                                },
                            ]
                        },
                        'type': 'PATTERN'
                    }
                },
                'sourceConfiguration': {
                    'authType': 'OAUTH2_CLIENT_CREDENTIALS'|'OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS',
                    'credentialsSecretArn': 'string',
                    'domain': 'string',
                    'hostType': 'ONLINE',
                    'siteUrls': [
                        'string',
                    ],
                    'tenantId': 'string'
                }
            },
            'type': 'S3'|'WEB'|'CONFLUENCE'|'SALESFORCE'|'SHAREPOINT'|'CUSTOM'|'REDSHIFT_METADATA',
            'webConfiguration': {
                'crawlerConfiguration': {
                    'crawlerLimits': {
                        'maxPages': 123,
                        'rateLimit': 123
                    },
                    'exclusionFilters': [
                        'string',
                    ],
                    'inclusionFilters': [
                        'string',
                    ],
                    'scope': 'HOST_ONLY'|'SUBDOMAINS',
                    'userAgent': 'string'
                },
                'sourceConfiguration': {
                    'urlConfiguration': {
                        'seedUrls': [
                            {
                                'url': 'string'
                            },
                        ]
                    }
                }
            }
        },
        'dataSourceId': 'string',
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'knowledgeBaseId': 'string',
        'name': 'string',
        'serverSideEncryptionConfiguration': {
            'kmsKeyArn': 'string'
        },
        'status': 'AVAILABLE'|'DELETING'|'DELETE_UNSUCCESSFUL',
        'updatedAt': datetime(2015, 1, 1),
        'vectorIngestionConfiguration': {
            'chunkingConfiguration': {
                'chunkingStrategy': 'FIXED_SIZE'|'NONE'|'HIERARCHICAL'|'SEMANTIC',
                'fixedSizeChunkingConfiguration': {
                    'maxTokens': 123,
                    'overlapPercentage': 123
                },
                'hierarchicalChunkingConfiguration': {
                    'levelConfigurations': [
                        {
                            'maxTokens': 123
                        },
                    ],
                    'overlapTokens': 123
                },
                'semanticChunkingConfiguration': {
                    'breakpointPercentileThreshold': 123,
                    'bufferSize': 123,
                    'maxTokens': 123
                }
            },
            'customTransformationConfiguration': {
                'intermediateStorage': {
                    's3Location': {
                        'uri': 'string'
                    }
                },
                'transformations': [
                    {
                        'stepToApply': 'POST_CHUNKING',
                        'transformationFunction': {
                            'transformationLambdaConfiguration': {
                                'lambdaArn': 'string'
                            }
                        }
                    },
                ]
            },
            'parsingConfiguration': {
                'bedrockDataAutomationConfiguration': {
                    'parsingModality': 'MULTIMODAL'
                },
                'bedrockFoundationModelConfiguration': {
                    'modelArn': 'string',
                    'parsingModality': 'MULTIMODAL',
                    'parsingPrompt': {
                        'parsingPromptText': 'string'
                    }
                },
                'parsingStrategy': 'BEDROCK_FOUNDATION_MODEL'|'BEDROCK_DATA_AUTOMATION'
            }
        }
    }
}

Response Structure

  • (dict) –

    • dataSource (dict) –

      Contains details about the data source.

      • createdAt (datetime) –

        The time at which the data source was created.

      • dataDeletionPolicy (string) –

        The data deletion policy for the data source.

      • dataSourceConfiguration (dict) –

        The connection configuration for the data source.

        • confluenceConfiguration (dict) –

          The configuration information to connect to Confluence as your data source.

          Note

          Confluence data source connector is in preview release and is subject to change.

          • crawlerConfiguration (dict) –

            The configuration of the Confluence content. For example, configuring specific types of Confluence content.

            • filterConfiguration (dict) –

              The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter (dict) –

                The configuration of filtering certain objects or content types of the data source.

                • filters (list) –

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • (dict) –

                    The specific filters applied to your data source content. You can filter out or include certain content.

                    • exclusionFilters (list) –

                      A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • inclusionFilters (list) –

                      A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • objectType (string) –

                      The supported object type or content type of the data source.

              • type (string) –

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

          • sourceConfiguration (dict) –

            The endpoint information to connect to your Confluence data source.

            • authType (string) –

              The supported authentication type to authenticate and connect to your Confluence instance.

            • credentialsSecretArn (string) –

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Confluence connection configuration.

            • hostType (string) –

              The supported host type, whether online/cloud or server/on-premises.

            • hostUrl (string) –

              The Confluence host URL or instance URL.

        • s3Configuration (dict) –

          The configuration information to connect to Amazon S3 as your data source.

          • bucketArn (string) –

            The Amazon Resource Name (ARN) of the S3 bucket that contains your data.

          • bucketOwnerAccountId (string) –

            The account ID for the owner of the S3 bucket.

          • inclusionPrefixes (list) –

            A list of S3 prefixes to include certain files or content. For more information, see Organizing objects using prefixes.

            • (string) –

        • salesforceConfiguration (dict) –

          The configuration information to connect to Salesforce as your data source.

          Note

          Salesforce data source connector is in preview release and is subject to change.

          • crawlerConfiguration (dict) –

            The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.

            • filterConfiguration (dict) –

              The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter (dict) –

                The configuration of filtering certain objects or content types of the data source.

                • filters (list) –

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • (dict) –

                    The specific filters applied to your data source content. You can filter out or include certain content.

                    • exclusionFilters (list) –

                      A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • inclusionFilters (list) –

                      A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • objectType (string) –

                      The supported object type or content type of the data source.

              • type (string) –

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

          • sourceConfiguration (dict) –

            The endpoint information to connect to your Salesforce data source.

            • authType (string) –

              The supported authentication type to authenticate and connect to your Salesforce instance.

            • credentialsSecretArn (string) –

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see Salesforce connection configuration.

            • hostUrl (string) –

              The Salesforce host URL or instance URL.

        • sharePointConfiguration (dict) –

          The configuration information to connect to SharePoint as your data source.

          Note

          SharePoint data source connector is in preview release and is subject to change.

          • crawlerConfiguration (dict) –

            The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.

            • filterConfiguration (dict) –

              The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.

              • patternObjectFilter (dict) –

                The configuration of filtering certain objects or content types of the data source.

                • filters (list) –

                  The configuration of specific filters applied to your data source content. You can filter out or include certain content.

                  • (dict) –

                    The specific filters applied to your data source content. You can filter out or include certain content.

                    • exclusionFilters (list) –

                      A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • inclusionFilters (list) –

                      A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

                      • (string) –

                    • objectType (string) –

                      The supported object type or content type of the data source.

              • type (string) –

                The type of filtering that you want to apply to certain objects or content of the data source. For example, the PATTERN type is regular expression patterns you can apply to filter your content.

          • sourceConfiguration (dict) –

            The endpoint information to connect to your SharePoint data source.

            • authType (string) –

              The supported authentication type to authenticate and connect to your SharePoint site/sites.

            • credentialsSecretArn (string) –

              The Amazon Resource Name of an Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see SharePoint connection configuration.

            • domain (string) –

              The domain of your SharePoint instance or site URL/URLs.

            • hostType (string) –

              The supported host type, whether online/cloud or server/on-premises.

            • siteUrls (list) –

              A list of one or more SharePoint site URLs.

              • (string) –

            • tenantId (string) –

              The identifier of your Microsoft 365 tenant.

        • type (string) –

          The type of data source.

        • webConfiguration (dict) –

          The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.

          Note

          Crawling web URLs as your data source is in preview release and is subject to change.

          • crawlerConfiguration (dict) –

            The Web Crawler configuration details for the web data source.

            • crawlerLimits (dict) –

              The configuration of crawl limits for the web URLs.

              • maxPages (integer) –

                The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.

              • rateLimit (integer) –

                The max rate at which pages are crawled, up to 300 per minute per host.

            • exclusionFilters (list) –

              A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

              • (string) –

            • inclusionFilters (list) –

              A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.

              • (string) –

            • scope (string) –

              The scope of what is crawled for your URLs.

              You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL “https://docs.aws.amazon.com/bedrock/latest/userguide/” and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain “aws.amazon.com” can also include sub domain “docs.aws.amazon.com”.

            • userAgent (string) –

              A string used for identifying the crawler or a bot when it accesses a web server. By default, this is set to bedrockbot_UUID for your crawler. You can optionally append a custom string to bedrockbot_UUID to allowlist a specific user agent permitted to access your source URLs.

          • sourceConfiguration (dict) –

            The source configuration details for the web data source.

            • urlConfiguration (dict) –

              The configuration of the URL/URLs.

              • seedUrls (list) –

                One or more seed or starting point URLs.

                • (dict) –

                  The seed or starting point URL. You should be authorized to crawl the URL.

                  • url (string) –

                    A seed or starting point URL.

      • dataSourceId (string) –

        The unique identifier of the data source.

      • description (string) –

        The description of the data source.

      • failureReasons (list) –

        The detailed reasons on the failure to delete a data source.

        • (string) –

      • knowledgeBaseId (string) –

        The unique identifier of the knowledge base to which the data source belongs.

      • name (string) –

        The name of the data source.

      • serverSideEncryptionConfiguration (dict) –

        Contains details about the configuration of the server-side encryption.

        • kmsKeyArn (string) –

          The Amazon Resource Name (ARN) of the KMS key used to encrypt the resource.

      • status (string) –

        The status of the data source. The following statuses are possible:

        • Available – The data source has been created and is ready for ingestion into the knowledge base.

        • Deleting – The data source is being deleted.

      • updatedAt (datetime) –

        The time at which the data source was last updated.

      • vectorIngestionConfiguration (dict) –

        Contains details about how to ingest the documents in the data source.

        • chunkingConfiguration (dict) –

          Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

          • chunkingStrategy (string) –

            Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

            • FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

            • HIERARCHICAL – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

            • SEMANTIC – Split documents into chunks based on groups of similar content derived with natural language processing.

            • NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

          • fixedSizeChunkingConfiguration (dict) –

            Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

            • maxTokens (integer) –

              The maximum number of tokens to include in a chunk.

            • overlapPercentage (integer) –

              The percentage of overlap between adjacent chunks of a data source.

          • hierarchicalChunkingConfiguration (dict) –

            Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.

            • levelConfigurations (list) –

              Token settings for each layer.

              • (dict) –

                Token settings for a layer in a hierarchical chunking configuration.

                • maxTokens (integer) –

                  The maximum number of tokens that a chunk can contain in this layer.

            • overlapTokens (integer) –

              The number of tokens to repeat across chunks in the same layer.

          • semanticChunkingConfiguration (dict) –

            Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.

            • breakpointPercentileThreshold (integer) –

              The dissimilarity threshold for splitting chunks.

            • bufferSize (integer) –

              The buffer size.

            • maxTokens (integer) –

              The maximum number of tokens that a chunk can contain.

        • customTransformationConfiguration (dict) –

          A custom document transformer for parsed data source documents.

          • intermediateStorage (dict) –

            An S3 bucket path for input and output objects.

            • s3Location (dict) –

              An S3 bucket path.

              • uri (string) –

                The location’s URI. For example, s3://my-bucket/chunk-processor/.

          • transformations (list) –

            A Lambda function that processes documents.

            • (dict) –

              A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to POST_CHUNKING.

              • stepToApply (string) –

                When the service applies the transformation.

              • transformationFunction (dict) –

                A Lambda function that processes documents.

                • transformationLambdaConfiguration (dict) –

                  The Lambda function.

                  • lambdaArn (string) –

                    The function’s ARN identifier.

        • parsingConfiguration (dict) –

          Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.

          • bedrockDataAutomationConfiguration (dict) –

            If you specify BEDROCK_DATA_AUTOMATION as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.

            • parsingModality (string) –

              Specifies whether to enable parsing of multimodal data, including both text and/or images.

          • bedrockFoundationModelConfiguration (dict) –

            If you specify BEDROCK_FOUNDATION_MODEL as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.

            • modelArn (string) –

              The ARN of the foundation model or inference profile to use for parsing.

            • parsingModality (string) –

              Specifies whether to enable parsing of multimodal data, including both text and/or images.

            • parsingPrompt (dict) –

              Instructions for interpreting the contents of a document.

              • parsingPromptText (string) –

                Instructions for interpreting the contents of a document.

          • parsingStrategy (string) –

            The parsing strategy for the data source.

Exceptions