describe_connections `async` ¶

describe_connections(
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeConnectionsResponse

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

Parameters:

filters (Optional[FilterList], default: None ) –

The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn
max_records (Optional[IntegerOptional], default: None ) –

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.
marker (Optional[String], default: None ) –

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Raises:

ResourceNotFoundFault –

The resource could not be found.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

Describe connections Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

>>> await client.describe_connections(filters=[{'Name': 'string', 'Values': ['string', 'string']}], max_records=123, marker='')

Source code in docs_src/capo_database_migration_service/_services/async_database_migration_service.py

async def describe_connections(
    self,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    filters: Optional[
        "capo_database_migration_service.types.filter_list.FilterList"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.string.String"] = None,
) -> "capo_database_migration_service.types.describe_connections_response.DescribeConnectionsResponse":
    """<p>Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.</p>

    Args:
        filters: <p>The filters applied to the connection.</p> <p>Valid filter names: endpoint-arn | replication-instance-arn</p>
        max_records: <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>

    Raises:
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe connections
        Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

        >>> await client.describe_connections(filters=[{'Name': 'string', 'Values': ['string', 'string']}], max_records=123, marker='')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_connections_message.DescribeConnectionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_connections_response.DescribeConnectionsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_connections

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.describe_connections.async_describe_connections(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConnections")
    )
    input_: capo_database_migration_service.types.describe_connections_message.DescribeConnectionsMessage = {}
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_connections async ¶

describe_connections `async` ¶