describe_multi_region_parameter_groups ¶

def describe_multi_region_parameter_groups(
    self,
    *,
    config_overrides: Optional[MemoryDBClientConfig] = None,
    multi_region_parameter_group_name: Optional[
        "capo_memorydb.types.string.String"
    ] = None,
    max_results: Optional[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ] = None,
    next_token: Optional["capo_memorydb.types.string.String"] = None,
) -> "capo_memorydb.types.describe_multi_region_parameter_groups_response.DescribeMultiRegionParameterGroupsResponse":
    """<p>Returns a list of multi-region parameter groups.</p>

    Args:
        multi_region_parameter_group_name: <p>The request for information on a specific multi-region parameter group.</p>
        max_results: <p>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.</p>
        next_token: <p>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.</p>

    Raises:
        capo_memorydb.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>The specified parameter combination is not valid.</p>
        capo_memorydb.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The specified parameter value is not valid.</p>
        capo_memorydb.errors.multi_region_parameter_group_not_found_fault.MultiRegionParameterGroupNotFoundFault: <p>The specified multi-Region parameter group does not exist.</p>
        capo_memorydb.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The required service-linked role was not found.</p>
        capo_memorydb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_memorydb.types.describe_multi_region_parameter_groups_request.DescribeMultiRegionParameterGroupsRequest]",
    ) -> OperationResponse[
        "capo_memorydb.types.describe_multi_region_parameter_groups_response.DescribeMultiRegionParameterGroupsResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.describe_multi_region_parameter_groups

        output, http_response = (
            capo_memorydb._operations.amazon_memory_db.describe_multi_region_parameter_groups.describe_multi_region_parameter_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMultiRegionParameterGroups")
    )
    input_: capo_memorydb.types.describe_multi_region_parameter_groups_request.DescribeMultiRegionParameterGroupsRequest = {}
    if multi_region_parameter_group_name is not None:
        input_["multi_region_parameter_group_name"] = (
            multi_region_parameter_group_name
        )
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output