core-account-subscription-estimate

Creates a new mytiki data estimate

API

Request (JSON)

• requestId: A unique identifier (uuid) for the transaction.
• query: The filter query to calculate the estimate for.

{
  "requestId": "string",
  "query": "string"
}

Response (JSON) - /api/latest/ocean/subscription/estimate

• requestId: The unique identifier for the transaction.
• count: The total number of matching rows.
• sample: An array of sample rows matching the query.

{
  "requestId": "string",
  "count": "number",
  "sample": [
    [
      { "VarCharValue":  "string" }
    ]
  ]
}

{
  "requestId": "string",
  "error": {
    "message": "string",
    "cause": "string"
  }
}

Error Response (JSON) - /api/latest/ocean/error

• requestId: The unique identifier for the transaction.
• error: An optional error if the transaction failed.
  • message: A description of the error event.
  • cause: Additional details describing what created the error event.

{
  "requestId": "string",
  "error": {
    "message": "string",
    "cause": "string"
  }
}

Configuration

Standard SAM CLI flags for build, package, and deploy phases can be provided via command line flags using "flags="<config>".

example: make build flags="--profile aws_profile"

Standard configuration parameters are provided the same way using the --parameter-overrides flag.

Required

• ApiAuthorization: The EventBridge connection id (i.e. name/id)
• OceanAccount: The AWS account number for the ocean data lake

Optional

• Name: The service name (lowercase pipecase). Default is core-account-cleanroom-create.
• Workgroup: The athena workgroup to use. Default is primary.
• Bucket: The S3 bucket to host the cleanroom. Default is mytiki-ocean
• ApiEndpoint: The base http endpoint to receive the result (without https:// prefix). Default is account.mytiki.com
• OceanDatabase: The database name within the ocean catalog. Requires a resource link. Default is tiki

Build and Deploy

Dependencies

• AWS SAM CLI for step function deployment.
• JQ for composite JSON assembly.
• S3 Buckets for uploading cloudformation template and hosting the cleanroom.
• AWS Athena for glue database creation.
• AWS Glue for database metadata catalog.
• AWS LakeFormation for database access control.
• AWS Step Functions for serverless event execution.

Compile

The project uses a composite JSON assembled at compile time.

make compile

Build

Requires compile step. At build time the cloudformation template is assembled and validate

make build flags="--parameter-overrides ApiAuthorization=<xyz/123>"

Package

Requires compile and build steps.

make package

Deploy

Requires compile, build, and package steps.

make deploy flags="--parameter-overrides ApiAuthorization=<xyz/123>"