Connecting Amazon Q Business to GoogleDrive using API - Amazon Q Business
Google Drive configuration propertiesGoogle Drive JSON schemaGoogleDrive JSON schema exampleGoogleDrive minimal configuration example

Connecting Amazon Q Business to GoogleDrive using API

You use the CreateDataSource action to connect a data source to your Amazon Q application. You can also use the UpdateDataSource action to modify an existing data source configuration.

Then, you use the configuration parameter to provide a JSON blob that conforms the AWS-defined JSON schema.

For an example of the API request, see CreateDataSource and UpdateDataSource in the Amazon Q API Reference.

Google Drive configuration properties

The following provides information about important configuration properties required in the schema.

Configuration Description Type Required
type The connector type. Must be GOOGLEDRIVEV3. string Yes
connectionConfiguration Configuration information for the data source connection.

object

This property has the following sub-properties: secretArn, authType.

 Yes
secretArn The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the Google Drive credentials. string Yes
authType The authentication type. The valid value is: SERVICE_ACCOUNT. string Yes
dataEntityConfiguration Configuration for which Google Drive entities to crawl.

object

This property has the following sub-properties: crawlMyDrive, crawlSharedWithMe, crawlSharedDrives.

 Yes
crawlMyDrive Whether to crawl the user's personal drive. Default is true. boolean No
crawlSharedWithMe Whether to crawl files shared with the user. Default is true. boolean No
crawlSharedDrives Whether to crawl shared drives. Default is true. boolean No
accessControlConfiguration Configuration for access control list (ACL) crawling.

object

This property has the following sub-property: crawlAcl.

 Yes
crawlAcl Whether to crawl access control lists for documents. boolean No
filterConfiguration Configuration for filtering which content to crawl.

object

Contains various filtering options including shared drives, MIME types, and date ranges.

 No
maxFileSizeInMegaBytes Maximum file size to crawl in megabytes. string No
exclusionSharedDriveIds Array of shared drive IDs to exclude from crawling. Maximum 1024 entries. array No
inclusionSharedDriveIds Array of shared drive IDs to include in crawling. Maximum 1024 entries. array No
exclusionMimeTypes Array of MIME types to exclude from crawling. Maximum 1024 entries. array No
inclusionMimeTypes Array of MIME types to include in crawling. Maximum 1024 entries. array No
modifiedDateBefore Only crawl files modified before this date. ISO 8601 format (e.g., 2024-12-31T23:59:59Z). string No
modifiedDateAfter Only crawl files modified after this date. ISO 8601 format (e.g., 2024-01-01T00:00:00Z). string No
crawlIdentities Whether to crawl user and group identities. Not supported in new. boolean No
deletionProtectionConfiguration Configuration for deletion protection settings.

object

This property has the following sub-properties: enableDeletionProtection, deletionProtectionThreshold.

 No
enableDeletionProtection Whether to enable deletion protection. boolean No
deletionProtectionThreshold Threshold percentage for deletion protection. string No
version Version of the connector configuration. string No
identityLoggingStatus Status of identity logging. Valid values are ENABLED and DISABLED. string No

Google Drive JSON schema

The following is the Google Drive New JSON schema:

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": ["GOOGLEDRIVEV3"]
    },
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "secretArn": {
          "type": "string",
          "minLength": 20,
          "maxLength": 2048
        },
        "authType": {
          "type": "string",
          "enum": ["SERVICE_ACCOUNT"]
        }
      },
      "required": ["secretArn", "authType"]
    },
    "dataEntityConfiguration": {
      "type": "object",
      "properties": {
        "crawlMyDrive": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "crawlSharedWithMe": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "crawlSharedDrives": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        }
      }
    },
    "filterConfiguration": {
      "type": "object",
      "properties": {
        "maxFileSizeInMegaBytes": {
          "type": "string"
        },
        "exclusionSharedDriveIds": {
          "type": "array",
          "maxItems": 1024,
          "items": {
            "type": "string"
          }
        },
        "inclusionSharedDriveIds": {
          "type": "array",
          "maxItems": 1024,
          "items": {
            "type": "string"
          }
        },
        "exclusionMimeTypes": {
          "type": "array",
          "maxItems": 1024,
          "items": {
            "type": "string"
          }
        },
        "inclusionMimeTypes": {
          "type": "array",
          "maxItems": 1024,
          "items": {
            "type": "string"
          }
        },
        "modifiedDateBefore": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 date-time format (e.g., 2024-12-31T23:59:59Z)"
        },
        "modifiedDateAfter": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 date-time format (e.g., 2024-01-01T00:00:00Z)"
        }
      }
    },
    "accessControlConfiguration": {
      "type": "object",
      "properties": {
        "crawlAcl": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        }
      }
    },
    "crawlIdentities": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string",
          "enum": ["true", "false"]
        }
      ]
    },
    "deletionProtectionConfiguration": {
      "type": "object",
      "properties": {
        "enableDeletionProtection": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "deletionProtectionThreshold": {
          "type": "string"
        }
      }
    },
    "version": {
      "type": "string"
    },
    "identityLoggingStatus": {
      "type": "string",
      "enum": ["ENABLED", "DISABLED"]
    }
  },
  "required": ["type", "connectionConfiguration", "dataEntityConfiguration", "accessControlConfiguration"]
}
Show moreShow less

GoogleDrive JSON schema example

The following is the GoogleDrive New JSON schema example:

{
  "type": "GOOGLEDRIVEV3",
  "connectionConfiguration": {
    "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-google-drive-secret",
    "authType": "SERVICE_ACCOUNT"
  },
  "dataEntityConfiguration": {
    "crawlMyDrive": true,
    "crawlSharedWithMe": true,
    "crawlSharedDrives": true
  },
  "filterConfiguration": {
    "maxFileSizeInMegaBytes": "50",
    "exclusionSharedDriveIds": ["SharedDrive1"],
    "inclusionSharedDriveIds": ["SharedDrive2"],
    "exclusionMimeTypes": ["application/vnd.google-apps.folder"],
    "inclusionMimeTypes": ["application/pdf", "application/vnd.google-apps.document"],
    "modifiedDateBefore": "2024-12-31T23:59:59Z",
    "modifiedDateAfter": "2024-01-01T00:00:00Z"
  },
  "accessControlConfiguration": {
    "crawlAcl": true
  },
  "crawlIdentities": true,
  "deletionProtectionConfiguration": {
    "enableDeletionProtection": false,
    "deletionProtectionThreshold": "10"
  },
  "version": "3.0.0",
  "identityLoggingStatus": "DISABLED"
}
Show moreShow less

GoogleDrive minimal configuration example

The following is the minimum required configuration for GoogleDrive New:

{
  "type": "GOOGLEDRIVEV3",
  "connectionConfiguration": {
    "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-google-drive-secret",
    "authType": "SERVICE_ACCOUNT"
  },
  "dataEntityConfiguration": {
    "crawlMyDrive": true,
    "crawlSharedWithMe": false,
    "crawlSharedDrives": false
  },
  "accessControlConfiguration": {
    "crawlAcl": false
  }
}
Show moreShow less