« blib/lib/Paws/ConnectParticipant/GetAttachmentResponse.pm
↑ Summary
blib/lib/Paws/ConnectParticipant/GetTranscriptResponse.pm »
| 1 | |||
| 2 | package Paws::ConnectParticipant::GetTranscript; | ||
| 3 | use Moose; | ||
| 4 | has ConnectionToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amz-Bearer', required => 1); | ||
| 5 | has ContactId => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has ScanDirection => (is => 'ro', isa => 'Str'); | ||
| 9 | has SortOrder => (is => 'ro', isa => 'Str'); | ||
| 10 | has StartPosition => (is => 'ro', isa => 'Paws::ConnectParticipant::StartPosition'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetTranscript'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/participant/transcript'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ConnectParticipant::GetTranscriptResponse'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ConnectParticipant::GetTranscript - Arguments for method GetTranscript on L<Paws::ConnectParticipant> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetTranscript on the | ||
| 29 | L<Amazon Connect Participant Service|Paws::ConnectParticipant> service. Use the attributes of this class | ||
| 30 | as arguments to method GetTranscript. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTranscript. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $participant.connect = Paws->service('ConnectParticipant'); | ||
| 37 | my $GetTranscriptResponse = $participant . connect->GetTranscript( | ||
| 38 | ConnectionToken => 'MyParticipantToken', | ||
| 39 | ContactId => 'MyContactId', # OPTIONAL | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | ScanDirection => 'FORWARD', # OPTIONAL | ||
| 43 | SortOrder => 'DESCENDING', # OPTIONAL | ||
| 44 | StartPosition => { | ||
| 45 | AbsoluteTime => 'MyInstant', # min: 1, max: 100; OPTIONAL | ||
| 46 | Id => 'MyChatItemId', # min: 1, max: 256; OPTIONAL | ||
| 47 | MostRecent => 1, # max: 100; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $InitialContactId = $GetTranscriptResponse->InitialContactId; | ||
| 53 | my $NextToken = $GetTranscriptResponse->NextToken; | ||
| 54 | my $Transcript = $GetTranscriptResponse->Transcript; | ||
| 55 | |||
| 56 | # Returns a L<Paws::ConnectParticipant::GetTranscriptResponse> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/participant.connect/GetTranscript> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> ConnectionToken => Str | ||
| 65 | |||
| 66 | The authentication token associated with the participant's connection. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 ContactId => Str | ||
| 71 | |||
| 72 | The contactId from the current contact chain for which transcript is | ||
| 73 | needed. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxResults => Int | ||
| 78 | |||
| 79 | The maximum number of results to return in the page. Default: 10. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 NextToken => Str | ||
| 84 | |||
| 85 | The pagination token. Use the value returned previously in the next | ||
| 86 | subsequent request to retrieve the next set of results. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 ScanDirection => Str | ||
| 91 | |||
| 92 | The direction from StartPosition from which to retrieve message. | ||
| 93 | Default: BACKWARD when no StartPosition is provided, FORWARD with | ||
| 94 | StartPosition. | ||
| 95 | |||
| 96 | Valid values are: C<"FORWARD">, C<"BACKWARD"> | ||
| 97 | |||
| 98 | =head2 SortOrder => Str | ||
| 99 | |||
| 100 | The sort order for the records. Default: DESCENDING. | ||
| 101 | |||
| 102 | Valid values are: C<"DESCENDING">, C<"ASCENDING"> | ||
| 103 | |||
| 104 | =head2 StartPosition => L<Paws::ConnectParticipant::StartPosition> | ||
| 105 | |||
| 106 | A filtering option for where to start. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method GetTranscript in L<Paws::ConnectParticipant> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |