Skip to content

describe_reserved_node_exchange_status async

describe_reserved_node_exchange_status(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    reserved_node_id: Optional[String] = None,
    reserved_node_exchange_request_id: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeReservedNodeExchangeStatusOutputMessage

Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.

Parameters:

  • reserved_node_id (Optional[String], default: None ) –

    The identifier of the source reserved node in a reserved-node exchange request.

  • reserved_node_exchange_request_id (Optional[String], default: None ) –

    The identifier of the reserved-node exchange request.

  • max_records (Optional[IntegerOptional], default: None ) –

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a Marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  • marker (Optional[String], default: None ) –

    An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Raises:

Source code in docs_src/capo_redshift/_services/async_redshift.py
async def describe_reserved_node_exchange_status(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    reserved_node_id: Optional["capo_redshift.types.string.String"] = None,
    reserved_node_exchange_request_id: Optional[
        "capo_redshift.types.string.String"
    ] = None,
    max_records: Optional[
        "capo_redshift.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_redshift.types.string.String"] = None,
) -> "capo_redshift.types.describe_reserved_node_exchange_status_output_message.DescribeReservedNodeExchangeStatusOutputMessage":
    """<p>Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.</p>

    Args:
        reserved_node_id: <p>The identifier of the source reserved node in a reserved-node exchange request.</p>
        reserved_node_exchange_request_id: <p>The identifier of the reserved-node exchange request.</p>
        max_records: <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>Marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
        marker: <p>An optional pagination token provided by a previous <code>DescribeReservedNodeExchangeStatus</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the <code>MaxRecords</code> parameter. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>

    Raises:
        capo_redshift.errors.reserved_node_exchange_not_found_fault.ReservedNodeExchangeNotFoundFault: <p>The reserved-node exchange status wasn't found.</p>
        capo_redshift.errors.reserved_node_not_found_fault.ReservedNodeNotFoundFault: <p>The specified reserved compute node not found.</p>
        capo_redshift.errors.unsupported_operation_fault.UnsupportedOperationFault: <p>The requested operation isn't supported.</p>
        capo_redshift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift.types.describe_reserved_node_exchange_status_input_message.DescribeReservedNodeExchangeStatusInputMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.describe_reserved_node_exchange_status_output_message.DescribeReservedNodeExchangeStatusOutputMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.describe_reserved_node_exchange_status

        (
            output,
            http_response,
        ) = await capo_redshift._operations.redshift_service_version20121201.describe_reserved_node_exchange_status.async_describe_reserved_node_exchange_status(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReservedNodeExchangeStatus")
    )
    input_: capo_redshift.types.describe_reserved_node_exchange_status_input_message.DescribeReservedNodeExchangeStatusInputMessage = {}
    if reserved_node_id is not None:
        input_["reserved_node_id"] = reserved_node_id
    if reserved_node_exchange_request_id is not None:
        input_["reserved_node_exchange_request_id"] = (
            reserved_node_exchange_request_id
        )
    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