MemoryDB / Client / describe_multi_region_parameter_groups

describe_multi_region_parameter_groups¶

MemoryDB.Client.describe_multi_region_parameter_groups(**kwargs)¶

Returns a list of multi-region parameter groups.

Request Syntax

response = client.describe_multi_region_parameter_groups(
    MultiRegionParameterGroupName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

MultiRegionParameterGroupName (string) – The request for information on a specific multi-region parameter group.
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 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',
    'MultiRegionParameterGroups': [
        {
            'Name': 'string',
            'Family': 'string',
            'Description': 'string',
            'ARN': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  An optional token to include in the response. If this token is provided, the response includes only results beyond the token, up to the value specified by MaxResults.
- MultiRegionParameterGroups (list) –
  
  A list of multi-region parameter groups. Each element in the list contains detailed information about one parameter group.
  - (dict) –
    
    Represents the output of a CreateMultiRegionParameterGroup operation. A multi-region parameter group represents a collection of parameters that can be applied to clusters across multiple regions.
    - Name (string) –
      
      The name of the multi-region parameter group.
    - Family (string) –
      
      The name of the parameter group family that this multi-region parameter group is compatible with.
    - Description (string) –
      
      A description of the multi-region parameter group.
    - ARN (string) –
      
      The Amazon Resource Name (ARN) of the multi-region parameter group.

Exceptions

MemoryDB.Client.exceptions.MultiRegionParameterGroupNotFoundFault
MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault
MemoryDB.Client.exceptions.InvalidParameterValueException
MemoryDB.Client.exceptions.InvalidParameterCombinationException