Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Cloud

Create Model from AWS Data Source

Create a new model containing the visualization of data from an AWS data source. Returns a jobId that can be used to retrieve the status from the Get "Create Model from AWS Data Source" Job Status endpoint.

post/v1/documents/cloud/aws

Request body

titlestring required

The name to give the created model

autosyncboolean required

Whether this model should automatically update with changes to its data source(s)

viewTemplatesstring[]

The view templates to create in the generated model. Use the "Get Supported AWS View Templates" endpoint to see a list of all supported view templates.

Example request

{
  "title": "AWS Infrastructure Diagram",
  "dataSources": [
    {
      "dataSourceId": "awsds_12345",
      "filter": {
        "awsTags": [
          {
            "key": "Environment",
            "value": "Production"
          }
        ],
        "includeUntaggedResources": true,
        "resourceGroups": [
          "Some-AWS-Resource::Some-AWS-Server"
        ]
      }
    }
  ],
  "autosync": true,
  "viewTemplates": [
    "vpc-topology",
    "ecs"
  ]
}

Response

Accepted. Occurs when the model creation job has been queued.

jobIdstring required

Unique identifier for an asynchronous job

Example response

{
  "jobId": "jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454"
}