Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Parameters:
-
parameter_group_family
(Optional[String], default:
None
)
–
The name of the cluster parameter group family.
-
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 DescribeDefaultClusterParameters 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/redshift.py
| def describe_default_cluster_parameters(
self,
*,
config_overrides: Optional[RedshiftClientConfig] = None,
parameter_group_family: 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.describe_default_cluster_parameters_result.DescribeDefaultClusterParametersResult":
"""<p>Returns a list of parameter settings for the specified parameter group family.</p> <p> For more information about parameters and parameter groups, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html">Amazon Redshift Parameter Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
Args:
parameter_group_family: <p>The name of the cluster parameter group family.</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>DescribeDefaultClusterParameters</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.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_redshift.types.describe_default_cluster_parameters_message.DescribeDefaultClusterParametersMessage]",
) -> OperationResponse[
"capo_redshift.types.describe_default_cluster_parameters_result.DescribeDefaultClusterParametersResult"
]:
import capo_redshift._operations.redshift_service_version20121201.describe_default_cluster_parameters
output, http_response = (
capo_redshift._operations.redshift_service_version20121201.describe_default_cluster_parameters.describe_default_cluster_parameters(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDefaultClusterParameters")
)
input_: capo_redshift.types.describe_default_cluster_parameters_message.DescribeDefaultClusterParametersMessage = {}
if parameter_group_family is not None:
input_["parameter_group_family"] = parameter_group_family
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|