describe_db_proxy_endpoints ¶

def describe_db_proxy_endpoints(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    db_proxy_name: Optional["capo_rds.types.db_proxy_name.DBProxyName"] = None,
    db_proxy_endpoint_name: Optional[
        "capo_rds.types.db_proxy_endpoint_name.DBProxyEndpointName"
    ] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    max_records: Optional["capo_rds.types.max_records.MaxRecords"] = None,
) -> "capo_rds.types.describe_db_proxy_endpoints_response.DescribeDBProxyEndpointsResponse":
    """<p>Returns information about DB proxy endpoints.</p>

    Args:
        db_proxy_name: <p>The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.</p>
        db_proxy_endpoint_name: <p>The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.</p>
        filters: <p>This parameter is not currently supported.</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>
        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>

    Raises:
        capo_rds.errors.db_proxy_endpoint_not_found_fault.DBProxyEndpointNotFoundFault: <p>The DB proxy endpoint doesn't exist.</p>
        capo_rds.errors.db_proxy_not_found_fault.DBProxyNotFoundFault: <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_db_proxy_endpoints_request.DescribeDBProxyEndpointsRequest]",
    ) -> OperationResponse[
        "capo_rds.types.describe_db_proxy_endpoints_response.DescribeDBProxyEndpointsResponse"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_proxy_endpoints

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_db_proxy_endpoints.describe_db_proxy_endpoints(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBProxyEndpoints")
    )
    input_: capo_rds.types.describe_db_proxy_endpoints_request.DescribeDBProxyEndpointsRequest = {}
    if db_proxy_name is not None:
        input_["db_proxy_name"] = db_proxy_name
    if db_proxy_endpoint_name is not None:
        input_["db_proxy_endpoint_name"] = db_proxy_endpoint_name
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output