Skip to content

ListReplaysRequest

Source code in docs_src/capo_eventbridge/types/list_replays_request.py
class ListReplaysRequest(TypedDict, closed=True):
    name_prefix: NotRequired["capo_eventbridge.types.replay_name.ReplayName"]
    """<p>A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.</p>"""
    state: NotRequired["capo_eventbridge.types.replay_state.ReplayState"]
    """<p>The state of the replay.</p>"""
    event_source_arn: NotRequired["capo_eventbridge.types.archive_arn.ArchiveArn"]
    """<p>The ARN of the archive from which the events are replayed.</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 replays to retrieve.</p>"""

event_source_arn instance-attribute

event_source_arn: NotRequired[ArchiveArn]

The ARN of the archive from which the events are replayed.

limit instance-attribute

limit: NotRequired[LimitMax100]

The maximum number of replays to retrieve.

name_prefix instance-attribute

name_prefix: NotRequired[ReplayName]

A name prefix to filter the replays returned. Only replays 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[ReplayState]

The state of the replay.