Skip to content

ListConnectionsInput

Source code in docs_src/capo_datazone/types/list_connections_input.py
class ListConnectionsInput(TypedDict, closed=True):
    domain_identifier: "capo_datazone.types.domain_id.DomainId"
    """<p>The ID of the domain where you want to list connections.</p>"""
    max_results: NotRequired["capo_datazone.types.max_results.MaxResults"]
    """<p>The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.</p>"""
    next_token: NotRequired["capo_datazone.types.pagination_token.PaginationToken"]
    """<p>When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.</p>"""
    sort_by: NotRequired[
        "capo_datazone.types.sort_field_connection.SortFieldConnection"
    ]
    """<p>Specifies how you want to sort the listed connections.</p>"""
    sort_order: NotRequired["capo_datazone.types.sort_order.SortOrder"]
    """<p>Specifies the sort order for the listed connections.</p>"""
    name: NotRequired["capo_datazone.types.connection_name.ConnectionName"]
    """<p>The name of the connection.</p>"""
    environment_identifier: NotRequired[
        "capo_datazone.types.environment_id.EnvironmentId"
    ]
    """<p>The ID of the environment where you want to list connections.</p>"""
    project_identifier: NotRequired["capo_datazone.types.project_id.ProjectId"]
    """<p>The ID of the project where you want to list connections.</p>"""
    type: NotRequired["capo_datazone.types.connection_type.ConnectionType"]
    """<p>The type of connection.</p>"""
    scope: NotRequired["capo_datazone.types.connection_scope.ConnectionScope"]
    """<p>The scope of the connection.</p>"""

domain_identifier instance-attribute

domain_identifier: DomainId

The ID of the domain where you want to list connections.

environment_identifier instance-attribute

environment_identifier: NotRequired[EnvironmentId]

The ID of the environment where you want to list connections.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.

name instance-attribute

name: NotRequired[ConnectionName]

The name of the connection.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

project_identifier instance-attribute

project_identifier: NotRequired[ProjectId]

The ID of the project where you want to list connections.

scope instance-attribute

scope: NotRequired[ConnectionScope]

The scope of the connection.

sort_by instance-attribute

sort_by: NotRequired[SortFieldConnection]

Specifies how you want to sort the listed connections.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

Specifies the sort order for the listed connections.

type instance-attribute

type: NotRequired[ConnectionType]

The type of connection.