Skip to content

describe_update_actions async

describe_update_actions(
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    service_update_name: Optional[String] = None,
    replication_group_ids: Optional[ReplicationGroupIdList] = None,
    cache_cluster_ids: Optional[CacheClusterIdList] = None,
    engine: Optional[String] = None,
    service_update_status: Optional[ServiceUpdateStatusList] = None,
    service_update_time_range: Optional[TimeRangeFilter] = None,
    update_action_status: Optional[UpdateActionStatusList] = None,
    show_node_level_update_status: Optional[BooleanOptional] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> UpdateActionsMessage

Returns details of the update actions

Parameters:

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

    The unique ID of the service update

  • replication_group_ids (Optional[ReplicationGroupIdList], default: None ) –

    The replication group IDs

  • cache_cluster_ids (Optional[CacheClusterIdList], default: None ) –

    The cache cluster IDs

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

    The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.

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

    The status of the service update

  • service_update_time_range (Optional[TimeRangeFilter], default: None ) –

    The range of time specified to search for service updates that are in available status

  • update_action_status (Optional[UpdateActionStatusList], default: None ) –

    The status of the update action.

  • show_node_level_update_status (Optional[BooleanOptional], default: None ) –

    Dictates whether to include node level update status in the response

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

    The maximum number of records to include in the response

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

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Raises:

Source code in docs_src/capo_elasticache/_services/async_elasti_cache.py
async def describe_update_actions(
    self,
    *,
    config_overrides: Optional[AsyncElastiCacheClientConfig] = None,
    service_update_name: Optional["capo_elasticache.types.string.String"] = None,
    replication_group_ids: Optional[
        "capo_elasticache.types.replication_group_id_list.ReplicationGroupIdList"
    ] = None,
    cache_cluster_ids: Optional[
        "capo_elasticache.types.cache_cluster_id_list.CacheClusterIdList"
    ] = None,
    engine: Optional["capo_elasticache.types.string.String"] = None,
    service_update_status: Optional[
        "capo_elasticache.types.service_update_status_list.ServiceUpdateStatusList"
    ] = None,
    service_update_time_range: Optional[
        "capo_elasticache.types.time_range_filter.TimeRangeFilter"
    ] = None,
    update_action_status: Optional[
        "capo_elasticache.types.update_action_status_list.UpdateActionStatusList"
    ] = None,
    show_node_level_update_status: Optional[
        "capo_elasticache.types.boolean_optional.BooleanOptional"
    ] = None,
    max_records: Optional[
        "capo_elasticache.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_elasticache.types.string.String"] = None,
) -> "capo_elasticache.types.update_actions_message.UpdateActionsMessage":
    """<p>Returns details of the update actions </p>

    Args:
        service_update_name: <p>The unique ID of the service update</p>
        replication_group_ids: <p>The replication group IDs</p>
        cache_cluster_ids: <p>The cache cluster IDs</p>
        engine: <p>The Elasticache engine to which the update applies. Either Valkey, Redis OSS or Memcached.</p>
        service_update_status: <p>The status of the service update</p>
        service_update_time_range: <p>The range of time specified to search for service updates that are in available status</p>
        update_action_status: <p>The status of the update action.</p>
        show_node_level_update_status: <p>Dictates whether to include node level update status in the response </p>
        max_records: <p>The maximum number of records to include in the response</p>
        marker: <p>An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>

    Raises:
        capo_elasticache.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_elasticache.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_elasticache.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elasticache.types.describe_update_actions_message.DescribeUpdateActionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_elasticache.types.update_actions_message.UpdateActionsMessage"
    ]:
        import capo_elasticache._operations.amazon_elasti_cache_v9.describe_update_actions

        (
            output,
            http_response,
        ) = await capo_elasticache._operations.amazon_elasti_cache_v9.describe_update_actions.async_describe_update_actions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeUpdateActions")
    )
    input_: capo_elasticache.types.describe_update_actions_message.DescribeUpdateActionsMessage = {}
    if service_update_name is not None:
        input_["service_update_name"] = service_update_name
    if replication_group_ids is not None:
        input_["replication_group_ids"] = replication_group_ids
    if cache_cluster_ids is not None:
        input_["cache_cluster_ids"] = cache_cluster_ids
    if engine is not None:
        input_["engine"] = engine
    if service_update_status is not None:
        input_["service_update_status"] = service_update_status
    if service_update_time_range is not None:
        input_["service_update_time_range"] = service_update_time_range
    if update_action_status is not None:
        input_["update_action_status"] = update_action_status
    if show_node_level_update_status is not None:
        input_["show_node_level_update_status"] = show_node_level_update_status
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

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