Skip to content

get_reserved_node_exchange_configuration_options async

get_reserved_node_exchange_configuration_options(
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    action_type: Optional[ReservedNodeExchangeActionType] = None,
    cluster_identifier: Optional[String] = None,
    snapshot_identifier: Optional[String] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> GetReservedNodeExchangeConfigurationOptionsOutputMessage

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

Parameters:

  • action_type (Optional[ReservedNodeExchangeActionType], default: None ) –

    The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.

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

    The identifier for the cluster that is the source for a reserved-node exchange.

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

    The identifier for the snapshot that is the source for the reserved-node exchange.

  • 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 GetReservedNodeExchangeConfigurationOptions 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 get_reserved_node_exchange_configuration_options(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftClientConfig] = None,
    action_type: Optional[
        "capo_redshift.types.reserved_node_exchange_action_type.ReservedNodeExchangeActionType"
    ] = None,
    cluster_identifier: Optional["capo_redshift.types.string.String"] = None,
    snapshot_identifier: 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.get_reserved_node_exchange_configuration_options_output_message.GetReservedNodeExchangeConfigurationOptionsOutputMessage":
    """<p>Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.</p>

    Args:
        action_type: <p>The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.</p>
        cluster_identifier: <p>The identifier for the cluster that is the source for a reserved-node exchange.</p>
        snapshot_identifier: <p>The identifier for the snapshot that is the source for the reserved-node exchange.</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>GetReservedNodeExchangeConfigurationOptions</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.cluster_not_found_fault.ClusterNotFoundFault: <p>The <code>ClusterIdentifier</code> parameter does not refer to an existing cluster. </p>
        capo_redshift.errors.cluster_snapshot_not_found_fault.ClusterSnapshotNotFoundFault: <p>The snapshot identifier does not refer to an existing cluster snapshot.</p>
        capo_redshift.errors.dependent_service_unavailable_fault.DependentServiceUnavailableFault: <p>Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.</p>
        capo_redshift.errors.invalid_reserved_node_state_fault.InvalidReservedNodeStateFault: <p>Indicates that the Reserved Node being exchanged is not in an active state.</p>
        capo_redshift.errors.reserved_node_already_migrated_fault.ReservedNodeAlreadyMigratedFault: <p>Indicates that the reserved node has already been exchanged.</p>
        capo_redshift.errors.reserved_node_not_found_fault.ReservedNodeNotFoundFault: <p>The specified reserved compute node not found.</p>
        capo_redshift.errors.reserved_node_offering_not_found_fault.ReservedNodeOfferingNotFoundFault: <p>Specified offering does not exist.</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.get_reserved_node_exchange_configuration_options_input_message.GetReservedNodeExchangeConfigurationOptionsInputMessage]",
    ) -> AsyncOperationResponse[
        "capo_redshift.types.get_reserved_node_exchange_configuration_options_output_message.GetReservedNodeExchangeConfigurationOptionsOutputMessage"
    ]:
        import capo_redshift._operations.redshift_service_version20121201.get_reserved_node_exchange_configuration_options

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetReservedNodeExchangeConfigurationOptions"),
    )
    input_: capo_redshift.types.get_reserved_node_exchange_configuration_options_input_message.GetReservedNodeExchangeConfigurationOptionsInputMessage = {}
    if action_type is not None:
        input_["action_type"] = action_type
    if cluster_identifier is not None:
        input_["cluster_identifier"] = cluster_identifier
    if snapshot_identifier is not None:
        input_["snapshot_identifier"] = snapshot_identifier
    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