Skip to content

ListArchivesRequest

Source code in docs_src/capo_eventbridge/types/list_archives_request.py 
15
16
17
18
19
20
21
22
23
24
25
class ListArchivesRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_eventbridge.types.archive_name.ArchiveName"]
    """<p>A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.</p>"""
    event_source_arn: NotRequired["capo_eventbridge.types.event_bus_arn.EventBusArn"]
    """<p>The ARN of the event source associated with the archive.</p>"""
    state: NotRequired["capo_eventbridge.types.archive_state.ArchiveState"]
    """<p>The state of the archive.</p>"""
    next_token: NotRequired["capo_eventbridge.types.next_token.NextToken"]
    """<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: NotRequired["capo_eventbridge.types.limit_max100.LimitMax100"]
    """<p>The maximum number of results to return.</p>"""

event_source_arn instance-attribute 

event_source_arn: NotRequired[EventBusArn]

The ARN of the event source associated with the archive.

limit instance-attribute 

limit: NotRequired[LimitMax100]

The maximum number of results to return.

name_prefix instance-attribute 

name_prefix: NotRequired[ArchiveName]

A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken 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.

Using an expired pagination token results in an HTTP 400 InvalidToken error.

state instance-attribute 

state: NotRequired[ArchiveState]

The state of the archive.