aws_sdk_redshift/client/
describe_node_configuration_options.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeNodeConfigurationOptions`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`action_type(ActionType)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::action_type) / [`set_action_type(Option<ActionType>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_action_type):<br>required: **true**<br><p>The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.</p><br>
8    ///   - [`cluster_identifier(impl Into<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_cluster_identifier):<br>required: **false**<br><p>The identifier of the cluster to evaluate for possible node configurations.</p><br>
9    ///   - [`snapshot_identifier(impl Into<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::snapshot_identifier) / [`set_snapshot_identifier(Option<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_snapshot_identifier):<br>required: **false**<br><p>The identifier of the snapshot to evaluate for possible node configurations.</p><br>
10    ///   - [`snapshot_arn(impl Into<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::snapshot_arn) / [`set_snapshot_arn(Option<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_snapshot_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.</p><br>
11    ///   - [`owner_account(impl Into<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::owner_account) / [`set_owner_account(Option<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_owner_account):<br>required: **false**<br><p>The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.</p><br>
12    ///   - [`filters(NodeConfigurationOptionsFilter)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::filters) / [`set_filters(Option<Vec::<NodeConfigurationOptionsFilter>>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::set_filters):<br>required: **false**<br><p>A set of name, operator, and value items to filter the results.</p><br>
13    ///   - [`marker(impl Into<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::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>DescribeNodeConfigurationOptions</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>
14    ///   - [`max_records(i32)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::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>500</code></p> <p>Constraints: minimum 100, maximum 500.</p><br>
15    /// - On success, responds with [`DescribeNodeConfigurationOptionsOutput`](crate::operation::describe_node_configuration_options::DescribeNodeConfigurationOptionsOutput) with field(s):
16    ///   - [`node_configuration_option_list(Option<Vec::<NodeConfigurationOption>>)`](crate::operation::describe_node_configuration_options::DescribeNodeConfigurationOptionsOutput::node_configuration_option_list): <p>A list of valid node configurations.</p>
17    ///   - [`marker(Option<String>)`](crate::operation::describe_node_configuration_options::DescribeNodeConfigurationOptionsOutput::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>
18    /// - On failure, responds with [`SdkError<DescribeNodeConfigurationOptionsError>`](crate::operation::describe_node_configuration_options::DescribeNodeConfigurationOptionsError)
19    pub fn describe_node_configuration_options(
20        &self,
21    ) -> crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder {
22        crate::operation::describe_node_configuration_options::builders::DescribeNodeConfigurationOptionsFluentBuilder::new(self.handle.clone())
23    }
24}