« blib/lib/Paws/KinesisVideoSignaling.pm
↑ Summary
blib/lib/Paws/KinesisVideoSignaling/GetIceServerConfigResponse.pm »
| 1 | |||
| 2 | package Paws::KinesisVideoSignaling::GetIceServerConfig; | ||
| 3 | use Moose; | ||
| 4 | has ChannelARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ClientId => (is => 'ro', isa => 'Str'); | ||
| 6 | has Service => (is => 'ro', isa => 'Str'); | ||
| 7 | has Username => (is => 'ro', isa => 'Str'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetIceServerConfig'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/get-ice-server-config'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideoSignaling::GetIceServerConfigResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::KinesisVideoSignaling::GetIceServerConfig - Arguments for method GetIceServerConfig on L<Paws::KinesisVideoSignaling> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetIceServerConfig on the | ||
| 26 | L<Amazon Kinesis Video Signaling Channels|Paws::KinesisVideoSignaling> service. Use the attributes of this class | ||
| 27 | as arguments to method GetIceServerConfig. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetIceServerConfig. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $kinesisvideo = Paws->service('KinesisVideoSignaling'); | ||
| 34 | my $GetIceServerConfigResponse = $kinesisvideo->GetIceServerConfig( | ||
| 35 | ChannelARN => 'MyResourceARN', | ||
| 36 | ClientId => 'MyClientId', # OPTIONAL | ||
| 37 | Service => 'TURN', # OPTIONAL | ||
| 38 | Username => 'MyUsername', # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $IceServerList = $GetIceServerConfigResponse->IceServerList; | ||
| 43 | |||
| 44 | # Returns a L<Paws::KinesisVideoSignaling::GetIceServerConfigResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/GetIceServerConfig> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> ChannelARN => Str | ||
| 53 | |||
| 54 | The ARN of the signaling channel to be used for the peer-to-peer | ||
| 55 | connection between configured peers. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | =head2 ClientId => Str | ||
| 60 | |||
| 61 | Unique identifier for the viewer. Must be unique within the signaling | ||
| 62 | channel. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 Service => Str | ||
| 67 | |||
| 68 | Specifies the desired service. Currently, C<TURN> is the only valid | ||
| 69 | value. | ||
| 70 | |||
| 71 | Valid values are: C<"TURN"> | ||
| 72 | |||
| 73 | =head2 Username => Str | ||
| 74 | |||
| 75 | An optional user ID to be associated with the credentials. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method GetIceServerConfig in L<Paws::KinesisVideoSignaling> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 |