describe_endpoint_settings `async` ¶

describe_endpoint_settings(
    engine_name: String,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeEndpointSettingsResponse

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Parameters:

engine_name (String) –

The database engine used for your source or target endpoint.
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.
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:

UnknownServiceError –

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

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

async def describe_endpoint_settings(
    self,
    engine_name: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = 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_endpoint_settings_response.DescribeEndpointSettingsResponse":
    """<p>Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.</p>

    Args:
        engine_name: <p>The database engine used for your source or target endpoint.</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>
        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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_endpoint_settings_message.DescribeEndpointSettingsMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_endpoint_settings_response.DescribeEndpointSettingsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_endpoint_settings

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEndpointSettings")
    )
    input_: capo_database_migration_service.types.describe_endpoint_settings_message.DescribeEndpointSettingsMessage = {
        "engine_name": engine_name
    }
    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_endpoint_settings async ¶

describe_endpoint_settings `async` ¶