describe_events async ¶

async def describe_events(
    self,
    *,
    config_overrides: Optional[AsyncDAXClientConfig] = None,
    source_name: Optional["capo_dax.types.string.String"] = None,
    source_type: Optional["capo_dax.types.source_type.SourceType"] = None,
    start_time: Optional["capo_dax.types.t_stamp.TStamp"] = None,
    end_time: Optional["capo_dax.types.t_stamp.TStamp"] = None,
    duration: Optional["capo_dax.types.integer_optional.IntegerOptional"] = None,
    max_results: Optional["capo_dax.types.integer_optional.IntegerOptional"] = None,
    next_token: Optional["capo_dax.types.string.String"] = None,
) -> "capo_dax.types.describe_events_response.DescribeEventsResponse":
    """<p>Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>

    Args:
        source_name: <p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p>
        source_type: <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
        start_time: <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p>
        end_time: <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p>
        duration: <p>The number of minutes' worth of events to retrieve.</p>
        max_results: <p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</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 <code>MaxResults</code>.</p>

    Raises:
        capo_dax.errors.invalid_parameter_combination_exception.InvalidParameterCombinationException: <p>Two or more incompatible parameters were specified.</p>
        capo_dax.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value for a parameter is invalid.</p>
        capo_dax.errors.service_linked_role_not_found_fault.ServiceLinkedRoleNotFoundFault: <p>The specified service linked role (SLR) was not found.</p>
        capo_dax.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_dax.types.describe_events_request.DescribeEventsRequest]",
    ) -> AsyncOperationResponse[
        "capo_dax.types.describe_events_response.DescribeEventsResponse"
    ]:
        import capo_dax._operations.amazon_daxv3.describe_events

        (
            output,
            http_response,
        ) = await capo_dax._operations.amazon_daxv3.describe_events.async_describe_events(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEvents")
    )
    input_: capo_dax.types.describe_events_request.DescribeEventsRequest = {}
    if source_name is not None:
        input_["source_name"] = source_name
    if source_type is not None:
        input_["source_type"] = source_type
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time
    if duration is not None:
        input_["duration"] = duration
    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