aws_sdk_redshift/client/

describe_orderable_cluster_options.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeOrderableClusterOptions`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_version(impl Into<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::cluster_version) / [`set_cluster_version(Option<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::set_cluster_version):<br>required: **false**<br><p>The version filter value. Specify this parameter to show only the available offerings matching the specified version.</p> <p>Default: All versions.</p> <p>Constraints: Must be one of the version returned from <code>DescribeClusterVersions</code>.</p><br>
    ///   - [`node_type(impl Into<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::node_type) / [`set_node_type(Option<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::set_node_type):<br>required: **false**<br><p>The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.</p><br>
    ///   - [`max_records(i32)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::set_max_records):<br>required: **false**<br><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><br>
    ///   - [`marker(impl Into<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeOrderableClusterOptions</code> 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><br>
    /// - On success, responds with [`DescribeOrderableClusterOptionsOutput`](crate::operation::describe_orderable_cluster_options::DescribeOrderableClusterOptionsOutput) with field(s):
    ///   - [`orderable_cluster_options(Option<Vec::<OrderableClusterOption>>)`](crate::operation::describe_orderable_cluster_options::DescribeOrderableClusterOptionsOutput::orderable_cluster_options): <p>An <code>OrderableClusterOption</code> structure containing information about orderable options for the cluster.</p>
    ///   - [`marker(Option<String>)`](crate::operation::describe_orderable_cluster_options::DescribeOrderableClusterOptionsOutput::marker): <p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the <code>Marker</code> parameter and retrying the command. If the <code>Marker</code> field is empty, all response records have been retrieved for the request.</p>
    /// - On failure, responds with [`SdkError<DescribeOrderableClusterOptionsError>`](crate::operation::describe_orderable_cluster_options::DescribeOrderableClusterOptionsError)
    pub fn describe_orderable_cluster_options(
        &self,
    ) -> crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder {
        crate::operation::describe_orderable_cluster_options::builders::DescribeOrderableClusterOptionsFluentBuilder::new(self.handle.clone())
    }
}