Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
Parameters:
-
reserved_node_offering_id
(Optional[String], default:
None
)
–
The unique identifier for the offering.
-
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.
Default: 100
Constraints: minimum 20, maximum 100.
-
marker
(Optional[String], default:
None
)
–
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. 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_offerings(
self,
*,
config_overrides: Optional[AsyncRedshiftClientConfig] = None,
reserved_node_offering_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.reserved_node_offerings_message.ReservedNodeOfferingsMessage":
"""<p>Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to <a>PurchaseReservedNodeOffering</a> to reserve one or more nodes for your Amazon Redshift cluster. </p> <p> For more information about reserved node offerings, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html">Purchasing Reserved Nodes</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
Args:
reserved_node_offering_id: <p>The unique identifier for the offering.</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> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>
marker: <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeReservedNodeOfferings</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. 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.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.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.describe_reserved_node_offerings_message.DescribeReservedNodeOfferingsMessage]",
) -> AsyncOperationResponse[
"capo_redshift.types.reserved_node_offerings_message.ReservedNodeOfferingsMessage"
]:
import capo_redshift._operations.redshift_service_version20121201.describe_reserved_node_offerings
(
output,
http_response,
) = await capo_redshift._operations.redshift_service_version20121201.describe_reserved_node_offerings.async_describe_reserved_node_offerings(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeReservedNodeOfferings")
)
input_: capo_redshift.types.describe_reserved_node_offerings_message.DescribeReservedNodeOfferingsMessage = {}
if reserved_node_offering_id is not None:
input_["reserved_node_offering_id"] = reserved_node_offering_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
|