MemoryDB / Client / describe_parameters

describe_parameters#

MemoryDB.Client.describe_parameters(**kwargs)#

Returns the detailed parameter list for a particular parameter group.

See also: AWS API Documentation

Request Syntax

response = client.describe_parameters(
    ParameterGroupName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ParameterGroupName (string) –

    [REQUIRED]

    he name of a specific parameter group to return details for.

  • MaxResults (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • NextToken (string) – An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Parameters': [
        {
            'Name': 'string',
            'Value': 'string',
            'Description': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'MinimumEngineVersion': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

    • Parameters (list) –

      A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

      • (dict) –

        Describes an individual setting that controls some aspect of MemoryDB behavior.

        • Name (string) –

          The name of the parameter

        • Value (string) –

          The value of the parameter

        • Description (string) –

          A description of the parameter

        • DataType (string) –

          The parameter’s data type

        • AllowedValues (string) –

          The valid range of values for the parameter.

        • MinimumEngineVersion (string) –

          The earliest engine version to which the parameter can apply.

Exceptions

  • MemoryDB.Client.exceptions.ParameterGroupNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException