NAME

Paws::ConnectParticipant::GetTranscript - Arguments for method GetTranscript on Paws::ConnectParticipant

DESCRIPTION

This class represents the parameters used for calling the method GetTranscript on the Amazon Connect Participant Service service. Use the attributes of this class as arguments to method GetTranscript.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTranscript.

SYNOPSIS

    my $participant.connect = Paws->service('ConnectParticipant');
    my $GetTranscriptResponse = $participant . connect->GetTranscript(
      ConnectionToken => 'MyParticipantToken',
      ContactId       => 'MyContactId',          # OPTIONAL
      MaxResults      => 1,                      # OPTIONAL
      NextToken       => 'MyNextToken',          # OPTIONAL
      ScanDirection   => 'FORWARD',              # OPTIONAL
      SortOrder       => 'DESCENDING',           # OPTIONAL
      StartPosition   => {
        AbsoluteTime => 'MyInstant',             # min: 1, max: 100; OPTIONAL
        Id           => 'MyChatItemId',          # min: 1, max: 256; OPTIONAL
        MostRecent   => 1,                       # max: 100; OPTIONAL
      },    # OPTIONAL
    );

    # Results:
    my $InitialContactId = $GetTranscriptResponse->InitialContactId;
    my $NextToken        = $GetTranscriptResponse->NextToken;
    my $Transcript       = $GetTranscriptResponse->Transcript;

    # Returns a L<Paws::ConnectParticipant::GetTranscriptResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/participant.connect/GetTranscript

ATTRIBUTES

REQUIRED ConnectionToken => Str

The authentication token associated with the participant's connection.

ContactId => Str

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

MaxResults => Int

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

NextToken => Str

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

ScanDirection => Str

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

Valid values are: "FORWARD", "BACKWARD"

SortOrder => Str

The sort order for the records. Default: DESCENDING.

Valid values are: "DESCENDING", "ASCENDING"

StartPosition => Paws::ConnectParticipant::StartPosition

A filtering option for where to start.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetTranscript in Paws::ConnectParticipant

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues