DAX / Client / describe_parameter_groups

describe_parameter_groups#

DAX.Client.describe_parameter_groups(**kwargs)#

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

Request Syntax

response = client.describe_parameter_groups(
    ParameterGroupNames=[
        'string',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

ParameterGroupNames (list) –
The names of the parameter groups.
- (string) –
MaxResults (integer) –
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.
NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ParameterGroups': [
        {
            'ParameterGroupName': 'string',
            'Description': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  Provides an identifier to allow retrieval of paginated results.
- ParameterGroups (list) –
  
  An array of parameter groups. Each element in the array represents one parameter group.
  - (dict) –
    
    A named set of parameters that are applied to all of the nodes in a DAX cluster.
    - ParameterGroupName (string) –
      
      The name of the parameter group.
    - Description (string) –
      
      A description of the parameter group.

Exceptions

DAX.Client.exceptions.ParameterGroupNotFoundFault
DAX.Client.exceptions.ServiceLinkedRoleNotFoundFault
DAX.Client.exceptions.InvalidParameterValueException
DAX.Client.exceptions.InvalidParameterCombinationException