« blib/lib/Paws/ConnectParticipant/ConnectionCredentials.pm
↑ Summary
blib/lib/Paws/ConnectParticipant/CreateParticipantConnectionResponse.pm »
| 1 | |||
| 2 | package Paws::ConnectParticipant::CreateParticipantConnection; | ||
| 3 | use Moose; | ||
| 4 | has ParticipantToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'X-Amz-Bearer', required => 1); | ||
| 5 | has Type => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateParticipantConnection'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/participant/connection'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ConnectParticipant::CreateParticipantConnectionResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ConnectParticipant::CreateParticipantConnection - Arguments for method CreateParticipantConnection on L<Paws::ConnectParticipant> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateParticipantConnection on the | ||
| 24 | L<Amazon Connect Participant Service|Paws::ConnectParticipant> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateParticipantConnection. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateParticipantConnection. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $participant.connect = Paws->service('ConnectParticipant'); | ||
| 32 | my $CreateParticipantConnectionResponse = | ||
| 33 | $participant . connect->CreateParticipantConnection( | ||
| 34 | ParticipantToken => 'MyParticipantToken', | ||
| 35 | Type => [ | ||
| 36 | 'WEBSOCKET', ... # values: WEBSOCKET, CONNECTION_CREDENTIALS | ||
| 37 | ], | ||
| 38 | |||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $ConnectionCredentials = | ||
| 43 | $CreateParticipantConnectionResponse->ConnectionCredentials; | ||
| 44 | my $Websocket = $CreateParticipantConnectionResponse->Websocket; | ||
| 45 | |||
| 46 | # Returns a L<Paws::ConnectParticipant::CreateParticipantConnectionResponse> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/participant.connect/CreateParticipantConnection> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> ParticipantToken => Str | ||
| 55 | |||
| 56 | This is a header parameter. | ||
| 57 | |||
| 58 | The Participant Token as obtained from StartChatContact | ||
| 59 | (https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) | ||
| 60 | API response. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> Type => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | Type of connection information required. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method CreateParticipantConnection in L<Paws::ConnectParticipant> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |