Skip to content

GetTranscriptRequest

Source code in docs_src/capo_connectparticipant/types/get_transcript_request.py
class GetTranscriptRequest(TypedDict, closed=True):
    contact_id: NotRequired["capo_connectparticipant.types.contact_id.ContactId"]
    """<p>The contactId from the current contact chain for which transcript is needed.</p>"""
    max_results: NotRequired["capo_connectparticipant.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in the page. Default: 10. </p>"""
    next_token: NotRequired["capo_connectparticipant.types.next_token.NextToken"]
    """<p>The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.</p>"""
    scan_direction: NotRequired[
        "capo_connectparticipant.types.scan_direction.ScanDirection"
    ]
    """<p>The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition. </p>"""
    sort_order: NotRequired["capo_connectparticipant.types.sort_key.SortKey"]
    """<p>The sort order for the records. Default: DESCENDING.</p>"""
    start_position: NotRequired[
        "capo_connectparticipant.types.start_position.StartPosition"
    ]
    """<p>A filtering option for where to start.</p>"""
    connection_token: "capo_connectparticipant.types.participant_token.ParticipantToken"
    """<p>The authentication token associated with the participant's connection.</p>"""

connection_token instance-attribute

connection_token: ParticipantToken

The authentication token associated with the participant's connection.

contact_id instance-attribute

contact_id: NotRequired[ContactId]

The contactId from the current contact chain for which transcript is needed.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return in the page. Default: 10.

next_token instance-attribute

next_token: NotRequired[NextToken]

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

scan_direction instance-attribute

scan_direction: NotRequired[ScanDirection]

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

sort_order instance-attribute

sort_order: NotRequired[SortKey]

The sort order for the records. Default: DESCENDING.

start_position instance-attribute

start_position: NotRequired[StartPosition]

A filtering option for where to start.