Update Data Source

bedrockagent_update_data_source

R Documentation

Updates the configurations for a data source connector

Description

Updates the configurations for a data source connector.

You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.

Usage

bedrockagent_update_data_source(dataDeletionPolicy,
  dataSourceConfiguration, dataSourceId, description, knowledgeBaseId,
  name, serverSideEncryptionConfiguration, vectorIngestionConfiguration)

Arguments

dataDeletionPolicy

The data deletion policy for the data source that you want to update.

dataSourceConfiguration

[required] The connection configuration for the data source that you want to update.

dataSourceId

[required] The unique identifier of the data source.

description

Specifies a new description for the data source.

knowledgeBaseId

[required] The unique identifier of the knowledge base for the data source.

name

[required] Specifies a new name for the data source.

serverSideEncryptionConfiguration

Contains details about server-side encryption of the data source.

vectorIngestionConfiguration

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

Value

A list with the following syntax:

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

Request syntax

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