ElastiCache / Client / describe_cache_parameter_groups

describe_cache_parameter_groups#

ElastiCache.Client.describe_cache_parameter_groups(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_cache_parameter_groups(
    CacheParameterGroupName='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • CacheParameterGroupName (string) – The name of a specific cache parameter group to return details for.

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20; maximum 100.

  • Marker (string) – An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'CacheParameterGroups': [
        {
            'CacheParameterGroupName': 'string',
            'CacheParameterGroupFamily': 'string',
            'Description': 'string',
            'IsGlobal': True|False,
            'ARN': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Represents the output of a DescribeCacheParameterGroups operation.

    • Marker (string) –

      Provides an identifier to allow retrieval of paginated results.

    • CacheParameterGroups (list) –

      A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

      • (dict) –

        Represents the output of a CreateCacheParameterGroup operation.

        • CacheParameterGroupName (string) –

          The name of the cache parameter group.

        • CacheParameterGroupFamily (string) –

          The name of the cache parameter group family that this cache parameter group is compatible with.

          Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

        • Description (string) –

          The description for this cache parameter group.

        • IsGlobal (boolean) –

          Indicates whether the parameter group is associated with a Global datastore

        • ARN (string) –

          The ARN (Amazon Resource Name) of the cache parameter group.

Exceptions

  • ElastiCache.Client.exceptions.CacheParameterGroupNotFoundFault

  • ElastiCache.Client.exceptions.InvalidParameterValueException

  • ElastiCache.Client.exceptions.InvalidParameterCombinationException

Examples

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

response = client.describe_cache_parameter_groups(
    CacheParameterGroupName='custom-mem1-4',
)

print(response)

Expected Output:

{
    'CacheParameterGroups': [
        {
            'CacheParameterGroupFamily': 'memcached1.4',
            'CacheParameterGroupName': 'custom-mem1-4',
            'Description': 'Custom memcache param group',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}