Skip to content

GetConnectionsRequest

Source code in docs_src/capo_glue/types/get_connections_request.py 
15
16
17
18
19
20
21
22
23
24
25
class GetConnectionsRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.</p>"""
    filter: NotRequired["capo_glue.types.get_connections_filter.GetConnectionsFilter"]
    """<p>A filter that controls which connections are returned.</p>"""
    hide_password: "capo_glue.types.boolean.Boolean"
    """<p>Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.</p>"""
    next_token: NotRequired["capo_glue.types.token.Token"]
    """<p>A continuation token, if this is a continuation call.</p>"""
    max_results: NotRequired["capo_glue.types.page_size.PageSize"]
    """<p>The maximum number of connections to return in one response.</p>"""

catalog_id instance-attribute 

catalog_id: NotRequired[CatalogIdString]

The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.

filter instance-attribute 

filter: NotRequired[GetConnectionsFilter]

A filter that controls which connections are returned.

hide_password instance-attribute 

hide_password: Boolean

Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

max_results instance-attribute 

max_results: NotRequired[PageSize]

The maximum number of connections to return in one response.

next_token instance-attribute 

next_token: NotRequired[Token]

A continuation token, if this is a continuation call.