Skip to content

cloud_amplifier

cloud_amplifier

Cloud Amplifier Route Functions

This module provides functions for managing Domo Cloud Amplifier integrations, including integration management, warehouse configuration, and database operations.

The module is organized into functional areas: - core: Core integration management (get, create, update, delete) - metadata: Metadata and schema operations (databases, schemas, tables, federated metadata) - utils: Utility functions for request body generation - exceptions: All Cloud Amplifier-related exception classes

Functions:

Name Description
get_integrations

Retrieve all Cloud Amplifier integrations
get_integration_by_id

Retrieve a specific integration by ID
get_integration_permissions

Get permissions for integrations
check_for_colliding_datasources

Check for dataset collisions
get_federated_source_metadata

Retrieve federated source metadata
get_integration_warehouses

list available compute warehouses
get_databases

list databases for an integration
get_schemas

list schemas for a database
get_tables

list tables for a schema
convert_federated_to_cloud_amplifier

Convert federated dataset to Cloud Amplifier
create_integration

Create a new Cloud Amplifier integration
update_integration_warehouses

Update compute warehouses
update_integration

Update an existing integration
delete_integration

Delete a Cloud Amplifier integration
Utility Functions

create_integration_body: Generate request body for integration creation

Exception Classes

CloudAmplifier_GET_Error: Raised when integration retrieval fails SearchCloudAmplifierNotFoundError: Raised when integration search returns no results CloudAmplifier_CRUD_Error: Raised when integration create/update/delete operations fail

CloudAmplifier_CRUD_Error 

CloudAmplifier_CRUD_Error(
    operation: str,
    entity_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when Cloud Amplifier integration create, update, or delete operations fail.

This exception is used for failures during integration creation, modification, deletion, warehouse updates, and federated dataset conversion operations.

Source code in src/crew_dcs/routes/cloud_amplifier/exceptions.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def __init__(
    self,
    operation: str,
    entity_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message:
        if entity_id:
            message = (
                f"Cloud Amplifier {operation} failed for integration {entity_id}"
            )
        else:
            message = f"Cloud Amplifier {operation} operation failed"

    super().__init__(
        message=message,
        entity_id=entity_id,
        res=res,
        **kwargs,
    )

CloudAmplifier_GET_Error 

CloudAmplifier_GET_Error(
    entity_id: str | None = None,
    res: ResponseGetData | None = None,
    message: str | None = None,
    **kwargs
)

Bases: RouteError

Raised when Cloud Amplifier integration retrieval operations fail.

This exception is used for failures during GET operations on integrations, warehouses, databases, schemas, tables, and metadata retrieval.

Source code in src/crew_dcs/routes/cloud_amplifier/exceptions.py 
27
28
29
30
31
32
33
34
35
def __init__(
    self,
    entity_id: str | None = None,
    res: rgd.ResponseGetData | None = None,
    message: str | None = None,
    **kwargs,
):
    if not message and entity_id:
        message = f"Failed to retrieve Cloud Amplifier integration {entity_id}"

SearchCloudAmplifierNotFoundError 

SearchCloudAmplifierNotFoundError(
    search_criteria: str,
    res: ResponseGetData | None = None,
    **kwargs
)

Bases: RouteError

Raised when Cloud Amplifier integration search operations return no results.

Source code in src/crew_dcs/routes/cloud_amplifier/exceptions.py 
42
43
44
45
46
47
48
49
50
51
52
53
def __init__(
    self,
    search_criteria: str,
    res: rgd.ResponseGetData | None = None,
    **kwargs,
):
    message = f"No Cloud Amplifier resources found matching: {search_criteria}"
    super().__init__(
        message=message,
        res=res,
        **kwargs,
    )

SearchCloudAmplifierNotFoundError 

SearchCloudAmplifierNotFoundError(
    search_criteria: str,
    res: ResponseGetData | None = None,
    **kwargs
)

Bases: RouteError

Raised when Cloud Amplifier integration search operations return no results.

This exception is used when searching for specific integrations, warehouses, databases, schemas, or tables that don't exist or when search criteria match nothing.

Source code in src/crew_dcs/routes/cloud_amplifier/exceptions.py 
64
65
66
67
68
69
70
71
72
73
74
75
def __init__(
    self,
    search_criteria: str,
    res: rgd.ResponseGetData | None = None,
    **kwargs,
):
    message = f"No Cloud Amplifier resources found matching: {search_criteria}"
    super().__init__(
        message=message,
        res=res,
        **kwargs,
    )

check_for_colliding_datasources async 

check_for_colliding_datasources(
    auth: DomoAuth,
    dataset_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Check for Cloud Amplifier integrations that collide with an existing Domo Dataset.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
dataset_id str

Dataset ID to check for collisions

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing collision information

Raises:

Type Description
CloudAmplifier_GET_Error

If collision check fails or no federated metadata exists
Example

collisions = await check_for_colliding_datasources(auth, "dataset-123") print(collisions.response)

Source code in src/crew_dcs/routes/cloud_amplifier/metadata.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def check_for_colliding_datasources(
    auth: DomoAuth,
    dataset_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Check for Cloud Amplifier integrations that collide with an existing Domo Dataset.

    Args:
        auth: Authentication object containing instance and credentials
        dataset_id: Dataset ID to check for collisions
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing collision information

    Raises:
        CloudAmplifier_GET_Error: If collision check fails or no federated metadata exists

    Example:
        >>> collisions = await check_for_colliding_datasources(auth, "dataset-123")
        >>> print(collisions.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/migration/integrations/datasource/{dataset_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    # A 400 may be returned if no federated metadata exists for the dataset
    if res.status == 400:
        raise CloudAmplifier_GET_Error(
            entity_id=dataset_id,
            res=res,
            message=f"No federated metadata exists for the datasource {dataset_id}",
        )

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=dataset_id, res=res)

    return res

convert_federated_to_cloud_amplifier async 

convert_federated_to_cloud_amplifier(
    auth: DomoAuth,
    federated_dataset_id: str,
    cloud_amplifier_integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Convert a federated dataset to use a Cloud Amplifier integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
federated_dataset_id str

Dataset ID of the federated dataset to convert

 required
cloud_amplifier_integration_id str

Integration ID to convert to

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing conversion result

Raises:

Type Description
CloudAmplifier_CRUD_Error

If conversion operation fails
Example

result = await convert_federated_to_cloud_amplifier( ... auth, "dataset-123", "integration-456" ... ) print(result.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def convert_federated_to_cloud_amplifier(
    auth: DomoAuth,
    federated_dataset_id: str,
    cloud_amplifier_integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Convert a federated dataset to use a Cloud Amplifier integration.

    Args:
        auth: Authentication object containing instance and credentials
        federated_dataset_id: Dataset ID of the federated dataset to convert
        cloud_amplifier_integration_id: Integration ID to convert to
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing conversion result

    Raises:
        CloudAmplifier_CRUD_Error: If conversion operation fails

    Example:
        >>> result = await convert_federated_to_cloud_amplifier(
        ...     auth, "dataset-123", "integration-456"
        ... )
        >>> print(result.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = (
        f"https://{auth.domo_instance}.domo.com/api/query/migration/federated/to/amplifier/"
        f"{federated_dataset_id}/integrations/{cloud_amplifier_integration_id}"
    )

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body={},
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_CRUD_Error(
            operation="convert",
            entity_id=federated_dataset_id,
            res=res,
        )

    return res

create_integration async 

create_integration(
    auth: DomoAuth,
    engine: ENGINES,
    friendly_name: str,
    service_account_id: str,
    auth_method: str,
    description: str = "",
    admin_auth_method: str | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Create a new Cloud Amplifier integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
engine ENGINES

Cloud platform engine (SNOWFLAKE or BIGQUERY)

 required
friendly_name str

Display name for the integration

 required
service_account_id str

Service account ID to use for authentication

 required
auth_method str

Authentication method

 required
description str

Optional description for the integration (default: "")

 ''
admin_auth_method str | None

Admin authentication method (defaults to auth_method)

 None
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing created integration details

Raises:

Type Description
CloudAmplifier_CRUD_Error

If integration creation fails
Example

result = await create_integration( ... auth, ... engine="SNOWFLAKE", ... friendly_name="My Snowflake Integration", ... service_account_id="account-123", ... auth_method="OAUTH" ... ) print(result.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def create_integration(
    auth: DomoAuth,
    engine: ENGINES,
    friendly_name: str,
    service_account_id: str,
    auth_method: str,
    description: str = "",
    admin_auth_method: str | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Create a new Cloud Amplifier integration.

    Args:
        auth: Authentication object containing instance and credentials
        engine: Cloud platform engine (SNOWFLAKE or BIGQUERY)
        friendly_name: Display name for the integration
        service_account_id: Service account ID to use for authentication
        auth_method: Authentication method
        description: Optional description for the integration (default: "")
        admin_auth_method: Admin authentication method (defaults to auth_method)
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing created integration details

    Raises:
        CloudAmplifier_CRUD_Error: If integration creation fails

    Example:
        >>> result = await create_integration(
        ...     auth,
        ...     engine="SNOWFLAKE",
        ...     friendly_name="My Snowflake Integration",
        ...     service_account_id="account-123",
        ...     auth_method="OAUTH"
        ... )
        >>> print(result.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    if admin_auth_method is None:
        admin_auth_method = auth_method

    body = create_integration_body(
        engine=engine,
        friendly_name=friendly_name,
        service_account_id=service_account_id,
        auth_method=auth_method,
        admin_auth_method=admin_auth_method,
        description=description,
    )

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_CRUD_Error(
            operation="create",
            res=res,
        )

    return res

delete_integration async 

delete_integration(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Delete a Cloud Amplifier integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID to delete

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing deletion confirmation

Raises:

Type Description
CloudAmplifier_CRUD_Error

If integration deletion fails
Example

result = await delete_integration(auth, "integration-123") print(result.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def delete_integration(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Delete a Cloud Amplifier integration.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID to delete
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing deletion confirmation

    Raises:
        CloudAmplifier_CRUD_Error: If integration deletion fails

    Example:
        >>> result = await delete_integration(auth, "integration-123")
        >>> print(result.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/data/v1/byos/accounts/{integration_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="DELETE",
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_CRUD_Error(
            operation="delete",
            entity_id=integration_id,
            res=res,
        )

    return res

get_databases async 

get_databases(
    auth: DomoAuth,
    integration_id: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a list of all databases for a Cloud Amplifier integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID to list databases for

 required
page int

Page number for pagination (default: 0)

 0
rows int

Number of rows per page (default: 5000)

 5000
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing list of databases

Raises:

Type Description
CloudAmplifier_GET_Error

If database retrieval fails
Example

databases = await get_databases(auth, "integration-123") for db in databases.response: ... print(db['databaseName'])

Source code in src/crew_dcs/routes/cloud_amplifier/metadata.py 
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_databases(
    auth: DomoAuth,
    integration_id: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a list of all databases for a Cloud Amplifier integration.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID to list databases for
        page: Page number for pagination (default: 0)
        rows: Number of rows per page (default: 5000)
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of databases

    Raises:
        CloudAmplifier_GET_Error: If database retrieval fails

    Example:
        >>> databases = await get_databases(auth, "integration-123")
        >>> for db in databases.response:
        ...     print(db['databaseName'])
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/{integration_id}/databases"

    params = {"page": page, "rows": rows}

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        params=params,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=integration_id, res=res)

    return res

get_federated_source_metadata async 

get_federated_source_metadata(
    auth: DomoAuth,
    dataset_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve federated source metadata for a dataset.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
dataset_id str

Dataset ID to retrieve metadata for

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing federated source metadata

Raises:

Type Description
SearchCloudAmplifierNotFoundError

If no federated datasource exists with the ID
CloudAmplifier_GET_Error

If metadata retrieval fails
Example

metadata = await get_federated_source_metadata(auth, "dataset-123") print(metadata.response)

Source code in src/crew_dcs/routes/cloud_amplifier/metadata.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_federated_source_metadata(
    auth: DomoAuth,
    dataset_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve federated source metadata for a dataset.

    Args:
        auth: Authentication object containing instance and credentials
        dataset_id: Dataset ID to retrieve metadata for
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing federated source metadata

    Raises:
        SearchCloudAmplifierNotFoundError: If no federated datasource exists with the ID
        CloudAmplifier_GET_Error: If metadata retrieval fails

    Example:
        >>> metadata = await get_federated_source_metadata(auth, "dataset-123")
        >>> print(metadata.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/federated/v1/config/datasources/{dataset_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    # A 404 may be returned if no federated metadata exists for the dataset
    if res.status == 404:
        raise SearchCloudAmplifierNotFoundError(
            search_criteria=f"Federated datasource ID: {dataset_id}",
            res=res,
        )

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=dataset_id, res=res)

    return res

get_integration_by_id async 

get_integration_by_id(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a specific Cloud Amplifier integration by ID.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Unique identifier for the integration

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing integration details

Raises:

Type Description
CloudAmplifier_GET_Error

If integration retrieval fails
SearchCloudAmplifierNotFoundError

If integration doesn't exist
Example

integration = await get_integration_by_id(auth, "12345") print(integration.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_integration_by_id(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a specific Cloud Amplifier integration by ID.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Unique identifier for the integration
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing integration details

    Raises:
        CloudAmplifier_GET_Error: If integration retrieval fails
        SearchCloudAmplifierNotFoundError: If integration doesn't exist

    Example:
        >>> integration = await get_integration_by_id(auth, "12345")
        >>> print(integration.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/{integration_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    if res.status == 404:
        raise SearchCloudAmplifierNotFoundError(
            search_criteria=f"Integration ID: {integration_id}",
            res=res,
        )

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=integration_id, res=res)

    return res

get_integration_permissions async 

get_integration_permissions(
    auth: DomoAuth,
    user_id: str | None = None,
    integration_ids: list[str] | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve permissions for Cloud Amplifier integrations.

Lists permissions for specified integrations and/or user.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
user_id str | None

Optional user ID to filter permissions

 None
integration_ids list[str] | None

Optional list of integration IDs to check permissions for

 None
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing permissions information

Raises:

Type Description
CloudAmplifier_GET_Error

If permissions retrieval fails
Example

permissions = await get_integration_permissions(auth, user_id="123") print(permissions.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_integration_permissions(
    auth: DomoAuth,
    user_id: str | None = None,
    integration_ids: list[str] | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve permissions for Cloud Amplifier integrations.

    Lists permissions for specified integrations and/or user.

    Args:
        auth: Authentication object containing instance and credentials
        user_id: Optional user ID to filter permissions
        integration_ids: Optional list of integration IDs to check permissions for
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing permissions information

    Raises:
        CloudAmplifier_GET_Error: If permissions retrieval fails

    Example:
        >>> permissions = await get_integration_permissions(auth, user_id="123")
        >>> print(permissions.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/permissions/list"

    body = {}

    if user_id:
        body.update({"userId": user_id})

    if integration_ids:
        body.update({"integrationIds": integration_ids})

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="POST",
        body=body,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_GET_Error(res=res)

    return res

get_integration_warehouses async 

get_integration_warehouses(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

list available compute warehouses for a Cloud Amplifier integration.

User must have permission to view the integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID to list warehouses for

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing list of warehouses

Raises:

Type Description
CloudAmplifier_GET_Error

If warehouse retrieval fails or user lacks permission
Example

warehouses = await get_integration_warehouses(auth, "integration-123") for warehouse in warehouses.response: ... print(warehouse['name'])

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_integration_warehouses(
    auth: DomoAuth,
    integration_id: str,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    list available compute warehouses for a Cloud Amplifier integration.

    User must have permission to view the integration.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID to list warehouses for
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of warehouses

    Raises:
        CloudAmplifier_GET_Error: If warehouse retrieval fails or user lacks permission

    Example:
        >>> warehouses = await get_integration_warehouses(auth, "integration-123")
        >>> for warehouse in warehouses.response:
        ...     print(warehouse['name'])
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/warehouses/{integration_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        context=context,
    )

    if return_raw:
        return res

    if res.status == 403:
        raise CloudAmplifier_GET_Error(
            entity_id=integration_id,
            res=res,
            message=f"User may not have permission to view the warehouses - {integration_id}",
        )

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=integration_id, res=res)

    return res

get_integrations async 

get_integrations(
    auth: DomoAuth,
    integration_engine: ENGINES | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a list of all Cloud Amplifier integrations.

Fetches all integrations associated with the current Domo instance, optionally filtered by engine type (SNOWFLAKE, BIGQUERY).

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_engine ENGINES | None

Optional filter by engine type (SNOWFLAKE or BIGQUERY)

 None
context RouteContext | None

Optional RouteContext for request configuration

 None
return_raw bool

Return raw API response without processing

 False
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing list of integrations

Raises:

Type Description
CloudAmplifier_GET_Error

If integration retrieval fails
Example

integrations_response = await get_integrations(auth) for integration in integrations_response.response: ... print(f"Integration: {integration['id']}")

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_integrations(
    auth: DomoAuth,
    integration_engine: ENGINES | None = None,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a list of all Cloud Amplifier integrations.

    Fetches all integrations associated with the current Domo instance,
    optionally filtered by engine type (SNOWFLAKE, BIGQUERY).

    Args:
        auth: Authentication object containing instance and credentials
        integration_engine: Optional filter by engine type (SNOWFLAKE or BIGQUERY)
        context: Optional RouteContext for request configuration
        return_raw: Return raw API response without processing
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of integrations

    Raises:
        CloudAmplifier_GET_Error: If integration retrieval fails

    Example:
        >>> integrations_response = await get_integrations(auth)
        >>> for integration in integrations_response.response:
        ...     print(f"Integration: {integration['id']}")
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    api_type = "data"
    params = None

    if integration_engine:  # Change to query if engine is provided to filter by engine
        api_type = "query"
        params = {"deviceEngine": integration_engine}

    url = f"https://{auth.domo_instance}.domo.com/api/{api_type}/v1/byos/accounts"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        params=params,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_GET_Error(res=res)

    return res

get_schemas async 

get_schemas(
    auth: DomoAuth,
    integration_id: str,
    database: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a list of all schemas for a Cloud Amplifier integration database.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID

 required
database str

Database name to list schemas for

 required
page int

Page number for pagination (default: 0)

 0
rows int

Number of rows per page (default: 5000)

 5000
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing list of schemas

Raises:

Type Description
CloudAmplifier_GET_Error

If schema retrieval fails
Example

schemas = await get_schemas(auth, "integration-123", "MY_DATABASE") for schema in schemas.response: ... print(schema['schemaName'])

Source code in src/crew_dcs/routes/cloud_amplifier/metadata.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_schemas(
    auth: DomoAuth,
    integration_id: str,
    database: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a list of all schemas for a Cloud Amplifier integration database.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID
        database: Database name to list schemas for
        page: Page number for pagination (default: 0)
        rows: Number of rows per page (default: 5000)
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of schemas

    Raises:
        CloudAmplifier_GET_Error: If schema retrieval fails

    Example:
        >>> schemas = await get_schemas(auth, "integration-123", "MY_DATABASE")
        >>> for schema in schemas.response:
        ...     print(schema['schemaName'])
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/{integration_id}/databases/{database}/schemas"

    params = {"page": page, "rows": rows}

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        params=params,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=integration_id, res=res)

    return res

get_tables async 

get_tables(
    auth: DomoAuth,
    integration_id: str,
    database: str,
    schema: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Retrieve a list of all tables for a Cloud Amplifier integration schema.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID

 required
database str

Database name

 required
schema str

Schema name to list tables for

 required
page int

Page number for pagination (default: 0)

 0
rows int

Number of rows per page (default: 5000)

 5000
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing list of tables

Raises:

Type Description
CloudAmplifier_GET_Error

If table retrieval fails
Example

tables = await get_tables(auth, "integration-123", "MY_DB", "MY_SCHEMA") for table in tables.response: ... print(table['tableName'])

Source code in src/crew_dcs/routes/cloud_amplifier/metadata.py 
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def get_tables(
    auth: DomoAuth,
    integration_id: str,
    database: str,
    schema: str,
    page: int = 0,
    rows: int = 5000,
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Retrieve a list of all tables for a Cloud Amplifier integration schema.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID
        database: Database name
        schema: Schema name to list tables for
        page: Page number for pagination (default: 0)
        rows: Number of rows per page (default: 5000)
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing list of tables

    Raises:
        CloudAmplifier_GET_Error: If table retrieval fails

    Example:
        >>> tables = await get_tables(auth, "integration-123", "MY_DB", "MY_SCHEMA")
        >>> for table in tables.response:
        ...     print(table['tableName'])
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/{integration_id}/databases/{database}/schemas/{schema}/objects"

    params = {"page": page, "rows": rows}

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="GET",
        params=params,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_GET_Error(entity_id=integration_id, res=res)

    return res

update_integration async 

update_integration(
    auth: DomoAuth,
    integration_id: str,
    update_body: dict[str, Any],
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Update a Cloud Amplifier integration.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID to update

 required
update_body dict[str, Any]

Dictionary containing fields to update

 required
return_raw bool

Return raw API response without processing

 False
context RouteContext | None

RouteContext for request configuration

 None
**context_kwargs

Additional context parameters (session, debug_api, etc.)

 {}

Returns:

Type Description
ResponseGetData

ResponseGetData object containing update result

Raises:

Type Description
CloudAmplifier_CRUD_Error

If integration update fails
Example

update_body = {"properties": {"friendlyName": {"value": "New Name"}}} result = await update_integration(auth, "integration-123", update_body) print(result.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def update_integration(
    auth: DomoAuth,
    integration_id: str,
    update_body: dict[str, Any],
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Update a Cloud Amplifier integration.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID to update
        update_body: Dictionary containing fields to update
        return_raw: Return raw API response without processing
        context: RouteContext for request configuration
        **context_kwargs: Additional context parameters (session, debug_api, etc.)

    Returns:
        ResponseGetData object containing update result

    Raises:
        CloudAmplifier_CRUD_Error: If integration update fails

    Example:
        >>> update_body = {"properties": {"friendlyName": {"value": "New Name"}}}
        >>> result = await update_integration(auth, "integration-123", update_body)
        >>> print(result.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/accounts/{integration_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=update_body,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_CRUD_Error(
            operation="update",
            entity_id=integration_id,
            res=res,
        )

    return res

update_integration_warehouses async 

update_integration_warehouses(
    auth: DomoAuth,
    integration_id: str,
    warehouses: list[dict[str, Any]],
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs
) -> ResponseGetData

Update the compute warehouses for a Cloud Amplifier integration.

Expects a list of warehouse dicts as returned by the GET warehouses endpoint.

Parameters:

Name Type Description Default
auth DomoAuth

Authentication object containing instance and credentials

 required
integration_id str

Integration ID to update warehouses for

 required
warehouses list[dict[str, Any]]

list of warehouse configuration dictionaries

 required
session

Optional HTTP client session for connection reuse

 required
debug_api

Enable detailed API request/response logging

 required
debug_num_stacks_to_drop

Number of stack frames to omit in debug output

 required
parent_class

Name of calling class for debugging context

 required
return_raw bool

Return raw API response without processing

 False

Returns:

Type Description
ResponseGetData

ResponseGetData object containing update result

Raises:

Type Description
CloudAmplifier_CRUD_Error

If warehouse update fails
Example

warehouses = [{"name": "COMPUTE_WH", "size": "LARGE"}] result = await update_integration_warehouses( ... auth, "integration-123", warehouses ... ) print(result.response)

Source code in src/crew_dcs/routes/cloud_amplifier/core.py 
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
@gd.route_function
@log_call(
    level_name="route",
    config=LogDecoratorConfig(
        entity_extractor=DomoEntityExtractor(),
        result_processor=DomoEntityResultProcessor(),
    ),
)
async def update_integration_warehouses(
    auth: DomoAuth,
    integration_id: str,
    warehouses: list[dict[str, Any]],
    return_raw: bool = False,
    *,
    context: RouteContext | None = None,
    **context_kwargs,
) -> rgd.ResponseGetData:
    """
    Update the compute warehouses for a Cloud Amplifier integration.

    Expects a list of warehouse dicts as returned by the GET warehouses endpoint.

    Args:
        auth: Authentication object containing instance and credentials
        integration_id: Integration ID to update warehouses for
        warehouses: list of warehouse configuration dictionaries
        session: Optional HTTP client session for connection reuse
        debug_api: Enable detailed API request/response logging
        debug_num_stacks_to_drop: Number of stack frames to omit in debug output
        parent_class: Name of calling class for debugging context
        return_raw: Return raw API response without processing

    Returns:
        ResponseGetData object containing update result

    Raises:
        CloudAmplifier_CRUD_Error: If warehouse update fails

    Example:
        >>> warehouses = [{"name": "COMPUTE_WH", "size": "LARGE"}]
        >>> result = await update_integration_warehouses(
        ...     auth, "integration-123", warehouses
        ... )
        >>> print(result.response)
    """
    context = RouteContext.build_context(context=context, **context_kwargs)

    url = f"https://{auth.domo_instance}.domo.com/api/query/v1/byos/warehouses/{integration_id}"

    res = await gd.get_data(
        auth=auth,
        url=url,
        method="PUT",
        body=warehouses,
        context=context,
    )

    if return_raw:
        return res

    if not res.is_success:
        raise CloudAmplifier_CRUD_Error(
            operation="update warehouses",
            entity_id=integration_id,
            res=res,
        )

    return res

Modules