list_archives ¶

def list_archives(
    self,
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
    name_prefix: Optional["capo_eventbridge.types.archive_name.ArchiveName"] = None,
    event_source_arn: Optional[
        "capo_eventbridge.types.event_bus_arn.EventBusArn"
    ] = None,
    state: Optional["capo_eventbridge.types.archive_state.ArchiveState"] = None,
    next_token: Optional["capo_eventbridge.types.next_token.NextToken"] = None,
    limit: Optional["capo_eventbridge.types.limit_max100.LimitMax100"] = None,
) -> "capo_eventbridge.types.list_archives_response.ListArchivesResponse":
    """<p>Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.</p>

    Args:
        name_prefix: <p>A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.</p>
        event_source_arn: <p>The ARN of the event source associated with the archive.</p>
        state: <p>The state of the archive.</p>
        next_token: <p>The token returned by a previous call, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p> Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>
        limit: <p>The maximum number of results to return.</p>

    Raises:
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridge.types.list_archives_request.ListArchivesRequest]",
    ) -> OperationResponse[
        "capo_eventbridge.types.list_archives_response.ListArchivesResponse"
    ]:
        import capo_eventbridge._operations.aws_events.list_archives

        output, http_response = (
            capo_eventbridge._operations.aws_events.list_archives.list_archives(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListArchives")
    )
    input_: capo_eventbridge.types.list_archives_request.ListArchivesRequest = {}
    if name_prefix is not None:
        input_["name_prefix"] = name_prefix
    if event_source_arn is not None:
        input_["event_source_arn"] = event_source_arn
    if state is not None:
        input_["state"] = state
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output