External S3 Data Warehouse Integration

Get AWS Cloudformation setup information for a S3 Data Warehouse integration

Gets AWS Cloudformation setup information for an external S3 Data Warehouse integration

get/v1/integrations/s3-data-warehouse/cloudformation-setup-info

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Query parameters

bucketNamestring

Response

Cloudformation setup information retrieved successfully

awsAccountIdstring required

The AWS account ID

bucketNamestring required

The name of the S3 bucket to use for the data warehouse

orgNamestring required

The organization's name, which names its folder under the bucket's query-results prefix. The stack expires that folder's query results after a day.

regionstring required

The AWS region the bucket must be created in. Matches the region the Grepr deployment is running in.

roleNamestring required

The IAM role name for the data warehouse integration

stackNamestring required

The name of the CloudFormation stack

Changes

No recorded changes to this operation across all 1 revision of this API.