Struct aws_sdk_redshift::client::fluent_builders::DescribeClusterParameterGroups

pub struct DescribeClusterParameterGroups<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to DescribeClusterParameterGroups.

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Implementations

impl<C, M, R> DescribeClusterParameterGroups<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeClusterParameterGroupsOutput, SdkError<DescribeClusterParameterGroupsError>> where
    R::Policy: SmithyRetryPolicy<DescribeClusterParameterGroupsInputOperationOutputAlias, DescribeClusterParameterGroupsOutput, DescribeClusterParameterGroupsError, DescribeClusterParameterGroupsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeClusterParameterGroupsPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn parameter_group_name(self, input: impl Into<String>) -> Self

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

pub fn set_parameter_group_name(self, input: Option<String>) -> Self

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

pub fn max_records(self, input: i32) -> Self

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.

pub fn set_max_records(self, input: Option<i32>) -> Self

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.

pub fn marker(self, input: impl Into<String>) -> Self

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups 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.

pub fn set_marker(self, input: Option<String>) -> Self

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups 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.

pub fn tag_keys(self, input: impl Into<String>) -> Self

Appends an item to TagKeys.

To override the contents of this collection use set_tag_keys.

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

pub fn set_tag_keys(self, input: Option<Vec<String>>) -> Self

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

pub fn tag_values(self, input: impl Into<String>) -> Self

Appends an item to TagValues.

To override the contents of this collection use set_tag_values.

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

pub fn set_tag_values(self, input: Option<Vec<String>>) -> Self

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeClusterParameterGroups<C, M, R>

fn clone(&self) -> DescribeClusterParameterGroups<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeClusterParameterGroups<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.