DescribeDefaultClusterParameters - Amazon Redshift

DescribeDefaultClusterParameters

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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ParameterGroupFamily

The name of the cluster parameter group family.

Type: String

Required: Yes

Marker

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, AWS 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.

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

Response Elements

The following element is returned by the service.

DefaultClusterParameters

Describes the default cluster parameters for a parameter group family.

Type: DefaultClusterParameters object

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=DescribeDefaultClusterParameters &ParameterGroupFamily=redshift-1.0 &SignatureMethod=HmacSHA256&SignatureVersion=4 &Version=2012-12-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request &X-Amz-Date=20190825T160000Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b

Sample Response

<DescribeDefaultClusterParametersResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <DescribeDefaultClusterParametersResult> <DefaultClusterParameters> <ParameterGroupFamily>redshift-1.0</ParameterGroupFamily> <Parameters> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>true,false</AllowedValues> <DataType>boolean</DataType> <Description>Use auto analyze</Description> <Source>engine-default</Source> <ParameterName>auto_analyze</ParameterName> <ParameterValue>true</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <DataType>string</DataType> <Description>Sets the display format for date and time values.</Description> <Source>engine-default</Source> <ParameterName>datestyle</ParameterName> <ParameterValue>ISO, MDY</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>true,false</AllowedValues> <DataType>boolean</DataType> <Description>parameter for audit logging purpose</Description> <Source>engine-default</Source> <ParameterName>enable_user_activity_logging</ParameterName> <ParameterValue>false</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>-15-2</AllowedValues> <DataType>integer</DataType> <Description>Sets the number of digits displayed for floating-point values</Description> <Source>engine-default</Source> <ParameterName>extra_float_digits</ParameterName> <ParameterValue>0</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>0-10</AllowedValues> <DataType>integer</DataType> <Description>The maximum concurrency scaling clusters can be used.</Description> <Source>engine-default</Source> <ParameterName>max_concurrency_scaling_clusters</ParameterName> <ParameterValue>1</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>0-14400000</AllowedValues> <DataType>integer</DataType> <Description>Sets the max cursor result set size</Description> <Source>engine-default</Source> <ParameterName>max_cursor_result_set_size</ParameterName> <ParameterValue>default</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <DataType>string</DataType> <Description>This parameter applies a user-defined label to a group of queries that are run during the same session..</Description> <Source>engine-default</Source> <ParameterName>query_group</ParameterName> <ParameterValue>default</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>true,false</AllowedValues> <DataType>boolean</DataType> <Description>require ssl for all databaseconnections</Description> <Source>engine-default</Source> <ParameterName>require_ssl</ParameterName> <ParameterValue>false</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <DataType>string</DataType> <Description>Sets the schema search order for names that are not schema-qualified.</Description> <Source>engine-default</Source> <ParameterName>search_path</ParameterName> <ParameterValue>$user, public</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>0,100-2147483647</AllowedValues> <DataType>integer</DataType> <Description>Aborts any statement that takes over the specified number of milliseconds.</Description> <Source>engine-default</Source> <ParameterName>statement_timeout</ParameterName> <ParameterValue>0</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <AllowedValues>true,false</AllowedValues> <DataType>boolean</DataType> <Description>Use fips ssl library</Description> <Source>engine-default</Source> <ParameterName>use_fips_ssl</ParameterName> <ParameterValue>false</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> <Parameter> <ApplyType>static</ApplyType> <DataType>string</DataType> <Description>wlm json configuration</Description> <Source>engine-default</Source> <ParameterName>wlm_json_configuration</ParameterName> <ParameterValue>[{"auto_wlm":true}]</ParameterValue> <IsModifiable>true</IsModifiable> </Parameter> </Parameters> </DefaultClusterParameters> </DescribeDefaultClusterParametersResult> <ResponseMetadata> <RequestId>2ee9dbcc-283f-11ea-8a28-2fd1719d0e86</RequestId> </ResponseMetadata> </DescribeDefaultClusterParametersResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: