« blib/lib/Paws/ConnectParticipant/Item.pm
↑ Summary
blib/lib/Paws/ConnectParticipant/SendEventResponse.pm »
| 1 | |||
| 2 | package Paws::ConnectParticipant::SendEvent; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has ConnectionToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amz-Bearer', required => 1); | ||
| 6 | has Content => (is => 'ro', isa => 'Str'); | ||
| 7 | has ContentType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendEvent'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/participant/event'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ConnectParticipant::SendEventResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ConnectParticipant::SendEvent - Arguments for method SendEvent on L<Paws::ConnectParticipant> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method SendEvent on the | ||
| 26 | L<Amazon Connect Participant Service|Paws::ConnectParticipant> service. Use the attributes of this class | ||
| 27 | as arguments to method SendEvent. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendEvent. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $participant.connect = Paws->service('ConnectParticipant'); | ||
| 34 | my $SendEventResponse = $participant . connect->SendEvent( | ||
| 35 | ConnectionToken => 'MyParticipantToken', | ||
| 36 | ContentType => 'MyChatContentType', | ||
| 37 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 38 | Content => 'MyChatContent', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $AbsoluteTime = $SendEventResponse->AbsoluteTime; | ||
| 43 | my $Id = $SendEventResponse->Id; | ||
| 44 | |||
| 45 | # Returns a L<Paws::ConnectParticipant::SendEventResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/participant.connect/SendEvent> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ClientToken => Str | ||
| 54 | |||
| 55 | A unique, case-sensitive identifier that you provide to ensure the | ||
| 56 | idempotency of the request. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> ConnectionToken => Str | ||
| 61 | |||
| 62 | The authentication token associated with the participant's connection. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 Content => Str | ||
| 67 | |||
| 68 | The content of the event to be sent (for example, message text). This | ||
| 69 | is not yet supported. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> ContentType => Str | ||
| 74 | |||
| 75 | The content type of the request. Supported types are: | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | application/vnd.amazonaws.connect.event.typing | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | application/vnd.amazonaws.connect.event.connection.acknowledged | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, documenting arguments for method SendEvent in L<Paws::ConnectParticipant> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |