« blib/lib/Paws/ConnectContactLens/Transcript.pm
↑ Summary
blib/lib/Paws/ConnectParticipant/AttachmentItem.pm »
| 1 | package Paws::ConnectParticipant; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'participant.connect' } | ||
| 4 | sub signing_name { 'execute-api' } | ||
| 5 | sub version { '2018-09-07' } | ||
| 6 | sub flattened_arrays { 0 } | ||
| 7 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 8 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 9 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 10 | }); | ||
| 11 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 12 | ] }); | ||
| 13 | |||
| 14 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller'; | ||
| 15 | |||
| 16 | |||
| 17 | sub CompleteAttachmentUpload { | ||
| 18 | my $self = shift; | ||
| 19 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::CompleteAttachmentUpload', @_); | ||
| 20 | return $self->caller->do_call($self, $call_object); | ||
| 21 | } | ||
| 22 | sub CreateParticipantConnection { | ||
| 23 | my $self = shift; | ||
| 24 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::CreateParticipantConnection', @_); | ||
| 25 | return $self->caller->do_call($self, $call_object); | ||
| 26 | } | ||
| 27 | sub DisconnectParticipant { | ||
| 28 | my $self = shift; | ||
| 29 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::DisconnectParticipant', @_); | ||
| 30 | return $self->caller->do_call($self, $call_object); | ||
| 31 | } | ||
| 32 | sub GetAttachment { | ||
| 33 | my $self = shift; | ||
| 34 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::GetAttachment', @_); | ||
| 35 | return $self->caller->do_call($self, $call_object); | ||
| 36 | } | ||
| 37 | sub GetTranscript { | ||
| 38 | my $self = shift; | ||
| 39 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::GetTranscript', @_); | ||
| 40 | return $self->caller->do_call($self, $call_object); | ||
| 41 | } | ||
| 42 | sub SendEvent { | ||
| 43 | my $self = shift; | ||
| 44 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::SendEvent', @_); | ||
| 45 | return $self->caller->do_call($self, $call_object); | ||
| 46 | } | ||
| 47 | sub SendMessage { | ||
| 48 | my $self = shift; | ||
| 49 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::SendMessage', @_); | ||
| 50 | return $self->caller->do_call($self, $call_object); | ||
| 51 | } | ||
| 52 | sub StartAttachmentUpload { | ||
| 53 | my $self = shift; | ||
| 54 | my $call_object = $self->new_with_coercions('Paws::ConnectParticipant::StartAttachmentUpload', @_); | ||
| 55 | return $self->caller->do_call($self, $call_object); | ||
| 56 | } | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | sub operations { qw/CompleteAttachmentUpload CreateParticipantConnection DisconnectParticipant GetAttachment GetTranscript SendEvent SendMessage StartAttachmentUpload / } | ||
| 61 | |||
| 62 | 1; | ||
| 63 | |||
| 64 | ### main pod documentation begin ### | ||
| 65 | |||
| 66 | =head1 NAME | ||
| 67 | |||
| 68 | Paws::ConnectParticipant - Perl Interface to AWS Amazon Connect Participant Service | ||
| 69 | |||
| 70 | =head1 SYNOPSIS | ||
| 71 | |||
| 72 | use Paws; | ||
| 73 | |||
| 74 | my $obj = Paws->service('ConnectParticipant'); | ||
| 75 | my $res = $obj->Method( | ||
| 76 | Arg1 => $val1, | ||
| 77 | Arg2 => [ 'V1', 'V2' ], | ||
| 78 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 79 | # of the arguments type | ||
| 80 | Arg3 => { Att1 => 'Val1' }, | ||
| 81 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 82 | # the constructor of the arguments type | ||
| 83 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 84 | ); | ||
| 85 | |||
| 86 | =head1 DESCRIPTION | ||
| 87 | |||
| 88 | Amazon Connect is a cloud-based contact center solution that makes it | ||
| 89 | easy to set up and manage a customer contact center and provide | ||
| 90 | reliable customer engagement at any scale. | ||
| 91 | |||
| 92 | Amazon Connect enables customer contacts through voice or chat. | ||
| 93 | |||
| 94 | The APIs described here are used by chat participants, such as agents | ||
| 95 | and customers. | ||
| 96 | |||
| 97 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/participant.connect-2018-09-07> | ||
| 98 | |||
| 99 | |||
| 100 | =head1 METHODS | ||
| 101 | |||
| 102 | =head2 CompleteAttachmentUpload | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item AttachmentIds => ArrayRef[Str|Undef] | ||
| 107 | |||
| 108 | =item ClientToken => Str | ||
| 109 | |||
| 110 | =item ConnectionToken => Str | ||
| 111 | |||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | Each argument is described in detail in: L<Paws::ConnectParticipant::CompleteAttachmentUpload> | ||
| 116 | |||
| 117 | Returns: a L<Paws::ConnectParticipant::CompleteAttachmentUploadResponse> instance | ||
| 118 | |||
| 119 | Allows you to confirm that the attachment has been uploaded using the | ||
| 120 | pre-signed URL provided in StartAttachmentUpload API. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 CreateParticipantConnection | ||
| 124 | |||
| 125 | =over | ||
| 126 | |||
| 127 | =item ParticipantToken => Str | ||
| 128 | |||
| 129 | =item Type => ArrayRef[Str|Undef] | ||
| 130 | |||
| 131 | |||
| 132 | =back | ||
| 133 | |||
| 134 | Each argument is described in detail in: L<Paws::ConnectParticipant::CreateParticipantConnection> | ||
| 135 | |||
| 136 | Returns: a L<Paws::ConnectParticipant::CreateParticipantConnectionResponse> instance | ||
| 137 | |||
| 138 | Creates the participant's connection. Note that ParticipantToken is | ||
| 139 | used for invoking this API instead of ConnectionToken. | ||
| 140 | |||
| 141 | The participant token is valid for the lifetime of the participant | ||
| 142 | E<ndash> until they are part of a contact. | ||
| 143 | |||
| 144 | The response URL for C<WEBSOCKET> Type has a connect expiry timeout of | ||
| 145 | 100s. Clients must manually connect to the returned websocket URL and | ||
| 146 | subscribe to the desired topic. | ||
| 147 | |||
| 148 | For chat, you need to publish the following on the established | ||
| 149 | websocket connection: | ||
| 150 | |||
| 151 | C<{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}> | ||
| 152 | |||
| 153 | Upon websocket URL expiry, as specified in the response | ||
| 154 | ConnectionExpiry parameter, clients need to call this API again to | ||
| 155 | obtain a new websocket URL and perform the same steps as before. | ||
| 156 | |||
| 157 | The Amazon Connect Participant Service APIs do not use Signature | ||
| 158 | Version 4 authentication | ||
| 159 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 160 | |||
| 161 | |||
| 162 | =head2 DisconnectParticipant | ||
| 163 | |||
| 164 | =over | ||
| 165 | |||
| 166 | =item ConnectionToken => Str | ||
| 167 | |||
| 168 | =item [ClientToken => Str] | ||
| 169 | |||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | Each argument is described in detail in: L<Paws::ConnectParticipant::DisconnectParticipant> | ||
| 174 | |||
| 175 | Returns: a L<Paws::ConnectParticipant::DisconnectParticipantResponse> instance | ||
| 176 | |||
| 177 | Disconnects a participant. Note that ConnectionToken is used for | ||
| 178 | invoking this API instead of ParticipantToken. | ||
| 179 | |||
| 180 | The Amazon Connect Participant Service APIs do not use Signature | ||
| 181 | Version 4 authentication | ||
| 182 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 183 | |||
| 184 | |||
| 185 | =head2 GetAttachment | ||
| 186 | |||
| 187 | =over | ||
| 188 | |||
| 189 | =item AttachmentId => Str | ||
| 190 | |||
| 191 | =item ConnectionToken => Str | ||
| 192 | |||
| 193 | |||
| 194 | =back | ||
| 195 | |||
| 196 | Each argument is described in detail in: L<Paws::ConnectParticipant::GetAttachment> | ||
| 197 | |||
| 198 | Returns: a L<Paws::ConnectParticipant::GetAttachmentResponse> instance | ||
| 199 | |||
| 200 | Provides a pre-signed URL for download of a completed attachment. This | ||
| 201 | is an asynchronous API for use with active contacts. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 GetTranscript | ||
| 205 | |||
| 206 | =over | ||
| 207 | |||
| 208 | =item ConnectionToken => Str | ||
| 209 | |||
| 210 | =item [ContactId => Str] | ||
| 211 | |||
| 212 | =item [MaxResults => Int] | ||
| 213 | |||
| 214 | =item [NextToken => Str] | ||
| 215 | |||
| 216 | =item [ScanDirection => Str] | ||
| 217 | |||
| 218 | =item [SortOrder => Str] | ||
| 219 | |||
| 220 | =item [StartPosition => L<Paws::ConnectParticipant::StartPosition>] | ||
| 221 | |||
| 222 | |||
| 223 | =back | ||
| 224 | |||
| 225 | Each argument is described in detail in: L<Paws::ConnectParticipant::GetTranscript> | ||
| 226 | |||
| 227 | Returns: a L<Paws::ConnectParticipant::GetTranscriptResponse> instance | ||
| 228 | |||
| 229 | Retrieves a transcript of the session, including details about any | ||
| 230 | attachments. Note that ConnectionToken is used for invoking this API | ||
| 231 | instead of ParticipantToken. | ||
| 232 | |||
| 233 | The Amazon Connect Participant Service APIs do not use Signature | ||
| 234 | Version 4 authentication | ||
| 235 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 236 | |||
| 237 | |||
| 238 | =head2 SendEvent | ||
| 239 | |||
| 240 | =over | ||
| 241 | |||
| 242 | =item ConnectionToken => Str | ||
| 243 | |||
| 244 | =item ContentType => Str | ||
| 245 | |||
| 246 | =item [ClientToken => Str] | ||
| 247 | |||
| 248 | =item [Content => Str] | ||
| 249 | |||
| 250 | |||
| 251 | =back | ||
| 252 | |||
| 253 | Each argument is described in detail in: L<Paws::ConnectParticipant::SendEvent> | ||
| 254 | |||
| 255 | Returns: a L<Paws::ConnectParticipant::SendEventResponse> instance | ||
| 256 | |||
| 257 | Sends an event. Note that ConnectionToken is used for invoking this API | ||
| 258 | instead of ParticipantToken. | ||
| 259 | |||
| 260 | The Amazon Connect Participant Service APIs do not use Signature | ||
| 261 | Version 4 authentication | ||
| 262 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 263 | |||
| 264 | |||
| 265 | =head2 SendMessage | ||
| 266 | |||
| 267 | =over | ||
| 268 | |||
| 269 | =item ConnectionToken => Str | ||
| 270 | |||
| 271 | =item Content => Str | ||
| 272 | |||
| 273 | =item ContentType => Str | ||
| 274 | |||
| 275 | =item [ClientToken => Str] | ||
| 276 | |||
| 277 | |||
| 278 | =back | ||
| 279 | |||
| 280 | Each argument is described in detail in: L<Paws::ConnectParticipant::SendMessage> | ||
| 281 | |||
| 282 | Returns: a L<Paws::ConnectParticipant::SendMessageResponse> instance | ||
| 283 | |||
| 284 | Sends a message. Note that ConnectionToken is used for invoking this | ||
| 285 | API instead of ParticipantToken. | ||
| 286 | |||
| 287 | The Amazon Connect Participant Service APIs do not use Signature | ||
| 288 | Version 4 authentication | ||
| 289 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 290 | |||
| 291 | |||
| 292 | =head2 StartAttachmentUpload | ||
| 293 | |||
| 294 | =over | ||
| 295 | |||
| 296 | =item AttachmentName => Str | ||
| 297 | |||
| 298 | =item AttachmentSizeInBytes => Int | ||
| 299 | |||
| 300 | =item ClientToken => Str | ||
| 301 | |||
| 302 | =item ConnectionToken => Str | ||
| 303 | |||
| 304 | =item ContentType => Str | ||
| 305 | |||
| 306 | |||
| 307 | =back | ||
| 308 | |||
| 309 | Each argument is described in detail in: L<Paws::ConnectParticipant::StartAttachmentUpload> | ||
| 310 | |||
| 311 | Returns: a L<Paws::ConnectParticipant::StartAttachmentUploadResponse> instance | ||
| 312 | |||
| 313 | Provides a pre-signed Amazon S3 URL in response for uploading the file | ||
| 314 | directly to S3. | ||
| 315 | |||
| 316 | |||
| 317 | |||
| 318 | |||
| 319 | =head1 PAGINATORS | ||
| 320 | |||
| 321 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 322 | |||
| 323 | |||
| 324 | |||
| 325 | |||
| 326 | =head1 SEE ALSO | ||
| 327 | |||
| 328 | This service class forms part of L<Paws> | ||
| 329 | |||
| 330 | =head1 BUGS and CONTRIBUTIONS | ||
| 331 | |||
| 332 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 333 | |||
| 334 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 335 | |||
| 336 | =cut | ||
| 337 |