MemoryDB / Client / describe_multi_region_parameters

describe_multi_region_parameters

MemoryDB.Client.describe_multi_region_parameters(**kwargs)

Returns the detailed parameter list for a particular multi-region parameter group.

See also: AWS API Documentation

Request Syntax

response = client.describe_multi_region_parameters(
    MultiRegionParameterGroupName='string',
    Source='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MultiRegionParameterGroupName (string) –

    [REQUIRED]

    The name of the multi-region parameter group to return details for.

  • Source (string) – The parameter types to return. Valid values: user | system | engine-default

  • 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',
    'MultiRegionParameters': [
        {
            'Name': 'string',
            'Value': 'string',
            'Description': 'string',
            'Source': 'string',
            'DataType': 'string',
            'AllowedValues': 'string',
            'MinimumEngineVersion': '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.

    • MultiRegionParameters (list) –

      A list of parameters specific to a particular multi-region 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 across multiple regions.

        • Name (string) –

          The name of the parameter.

        • Value (string) –

          The value of the parameter.

        • Description (string) –

          A description of the parameter.

        • Source (string) –

          Indicates the source of the parameter value. Valid values: user | system | engine-default

        • DataType (string) –

          The valid data type for the parameter.

        • 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.MultiRegionParameterGroupNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException