Skip to content

describe_engine_versions async

describe_engine_versions(
    *,
    config_overrides: Optional[AsyncMemoryDBClientConfig] = None,
    engine: Optional[String] = None,
    engine_version: Optional[String] = None,
    parameter_group_family: Optional[String] = None,
    max_results: Optional[IntegerOptional] = None,
    next_token: Optional[String] = None,
    default_only: Optional[Boolean] = None,
) -> DescribeEngineVersionsResponse

Returns a list of the available Redis OSS engine versions.

Parameters:

  • engine (Optional[String], default: None ) –

    The name of the engine for which to list available versions.

  • engine_version (Optional[String], default: None ) –

    The Redis OSS engine version

  • parameter_group_family (Optional[String], default: None ) –

    The name of a specific parameter group family to return details for.

  • max_results (Optional[IntegerOptional], default: None ) –

    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.

  • next_token (Optional[String], default: None ) –

    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.

  • default_only (Optional[Boolean], default: None ) –

    If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Raises:

Source code in docs_src/capo_memorydb/_services/async_memory_db.py
async def describe_engine_versions(
    self,
    *,
    config_overrides: Optional[AsyncMemoryDBClientConfig] = None,
    engine: Optional["capo_memorydb.types.string.String"] = None,
    engine_version: Optional["capo_memorydb.types.string.String"] = None,
    parameter_group_family: 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,
    default_only: Optional["capo_memorydb.types.boolean.Boolean"] = None,
) -> "capo_memorydb.types.describe_engine_versions_response.DescribeEngineVersionsResponse":
    """<p>Returns a list of the available Redis OSS engine versions.</p>

    Args:
        engine: <p>The name of the engine for which to list available versions.</p>
        engine_version: <p>The Redis OSS engine version</p>
        parameter_group_family: <p>The name of a specific parameter group family to return details for.</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 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. </p>
        default_only: <p>If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_memorydb.types.describe_engine_versions_request.DescribeEngineVersionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_memorydb.types.describe_engine_versions_response.DescribeEngineVersionsResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.describe_engine_versions

        (
            output,
            http_response,
        ) = await capo_memorydb._operations.amazon_memory_db.describe_engine_versions.async_describe_engine_versions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEngineVersions")
    )
    input_: capo_memorydb.types.describe_engine_versions_request.DescribeEngineVersionsRequest = {}
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if parameter_group_family is not None:
        input_["parameter_group_family"] = parameter_group_family
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if default_only is not None:
        input_["default_only"] = default_only

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output