Skip to content

list_events async

list_events(
    filters: ListEventsFilters,
    *,
    config_overrides: Optional[AsyncDevOpsGuruClientConfig] = None,
    max_results: Optional[ListEventsMaxResults] = None,
    next_token: Optional[UuidNextToken] = None,
    account_id: Optional[AwsAccountId] = None,
) -> ListEventsResponse

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.

Parameters:

  • filters (ListEventsFilters) –

    A ListEventsFilters object used to specify which events to return.

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

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

  • account_id (Optional[AwsAccountId], default: None ) –

    The ID of the Amazon Web Services account.

Raises:

  • AccessDeniedException –

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

  • InternalServerException –

    An internal failure in an Amazon service occurred.

  • ResourceNotFoundException –

    A requested resource could not be found

  • ThrottlingException –

    The request was denied due to a request throttling.

  • ValidationException –

    Contains information about data passed in to a field during a request that is not valid.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_devops_guru/_services/async_dev_ops_guru.py
async def list_events(
    self,
    filters: "capo_devops_guru.types.list_events_filters.ListEventsFilters",
    *,
    config_overrides: Optional[AsyncDevOpsGuruClientConfig] = None,
    max_results: Optional[
        "capo_devops_guru.types.list_events_max_results.ListEventsMaxResults"
    ] = None,
    next_token: Optional[
        "capo_devops_guru.types.uuid_next_token.UuidNextToken"
    ] = None,
    account_id: Optional[
        "capo_devops_guru.types.aws_account_id.AwsAccountId"
    ] = None,
) -> "capo_devops_guru.types.list_events_response.ListEventsResponse":
    """<p> Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. </p>

    Args:
        filters: <p> A <code>ListEventsFilters</code> object used to specify which events to return. </p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        next_token: <p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>
        account_id: <p>The ID of the Amazon Web Services account. </p>

    Raises:
        capo_devops_guru.errors.access_denied_exception.AccessDeniedException: <p> You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access Management</a> in the <i>IAM User Guide</i>. </p>
        capo_devops_guru.errors.internal_server_exception.InternalServerException: <p>An internal failure in an Amazon service occurred.</p>
        capo_devops_guru.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource could not be found</p>
        capo_devops_guru.errors.throttling_exception.ThrottlingException: <p>The request was denied due to a request throttling.</p>
        capo_devops_guru.errors.validation_exception.ValidationException: <p> Contains information about data passed in to a field during a request that is not valid. </p>
        capo_devops_guru.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_devops_guru.types.list_events_request.ListEventsRequest]",
    ) -> AsyncOperationResponse[
        "capo_devops_guru.types.list_events_response.ListEventsResponse"
    ]:
        import capo_devops_guru._operations.capstone_control_plane_service.list_events

        (
            output,
            http_response,
        ) = await capo_devops_guru._operations.capstone_control_plane_service.list_events.async_list_events(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEvents")
    )
    input_: capo_devops_guru.types.list_events_request.ListEventsRequest = {
        "filters": filters
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if account_id is not None:
        input_["account_id"] = account_id

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