Skip to content

describe_service_updates async

describe_service_updates(
    *,
    config_overrides: Optional[AsyncMemoryDBClientConfig] = None,
    service_update_name: Optional[String] = None,
    cluster_names: Optional[ClusterNameList] = None,
    status: Optional[ServiceUpdateStatusList] = None,
    max_results: Optional[IntegerOptional] = None,
    next_token: Optional[String] = None,
) -> DescribeServiceUpdatesResponse

Returns details of the service updates.

Parameters:

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

    The unique ID of the service update to describe.

  • cluster_names (Optional[ClusterNameList], default: None ) –

    The list of cluster names to identify service updates to apply.

  • status (Optional[ServiceUpdateStatusList], default: None ) –

    The status(es) of the service updates to filter on.

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

Raises:

Source code in docs_src/capo_memorydb/_services/async_memory_db.py
async def describe_service_updates(
    self,
    *,
    config_overrides: Optional[AsyncMemoryDBClientConfig] = None,
    service_update_name: Optional["capo_memorydb.types.string.String"] = None,
    cluster_names: Optional[
        "capo_memorydb.types.cluster_name_list.ClusterNameList"
    ] = None,
    status: Optional[
        "capo_memorydb.types.service_update_status_list.ServiceUpdateStatusList"
    ] = None,
    max_results: Optional[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ] = None,
    next_token: Optional["capo_memorydb.types.string.String"] = None,
) -> "capo_memorydb.types.describe_service_updates_response.DescribeServiceUpdatesResponse":
    """<p>Returns details of the service updates.</p>

    Args:
        service_update_name: <p>The unique ID of the service update to describe.</p>
        cluster_names: <p>The list of cluster names to identify service updates to apply.</p>
        status: <p>The status(es) of the service updates to filter on.</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>

    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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_memorydb.types.describe_service_updates_request.DescribeServiceUpdatesRequest]",
    ) -> AsyncOperationResponse[
        "capo_memorydb.types.describe_service_updates_response.DescribeServiceUpdatesResponse"
    ]:
        import capo_memorydb._operations.amazon_memory_db.describe_service_updates

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeServiceUpdates")
    )
    input_: capo_memorydb.types.describe_service_updates_request.DescribeServiceUpdatesRequest = {}
    if service_update_name is not None:
        input_["service_update_name"] = service_update_name
    if cluster_names is not None:
        input_["cluster_names"] = cluster_names
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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