« blib/lib/Paws/KinesisVideo/GetDataEndpointOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/GetSignalingChannelEndpointOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::GetSignalingChannelEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has ChannelARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has SingleMasterChannelEndpointConfiguration => (is => 'ro', isa => 'Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetSignalingChannelEndpoint'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/getSignalingChannelEndpoint'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::GetSignalingChannelEndpointOutput'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::KinesisVideo::GetSignalingChannelEndpoint - Arguments for method GetSignalingChannelEndpoint on L<Paws::KinesisVideo> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetSignalingChannelEndpoint on the | ||
| 24 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 25 | as arguments to method GetSignalingChannelEndpoint. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSignalingChannelEndpoint. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 32 | my $GetSignalingChannelEndpointOutput = | ||
| 33 | $kinesisvideo->GetSignalingChannelEndpoint( | ||
| 34 | ChannelARN => 'MyResourceARN', | ||
| 35 | SingleMasterChannelEndpointConfiguration => { | ||
| 36 | Protocols => [ | ||
| 37 | 'WSS', ... # values: WSS, HTTPS | ||
| 38 | ], # min: 1, max: 5; OPTIONAL | ||
| 39 | Role => 'MASTER', # values: MASTER, VIEWER; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $ResourceEndpointList = | ||
| 45 | $GetSignalingChannelEndpointOutput->ResourceEndpointList; | ||
| 46 | |||
| 47 | # Returns a L<Paws::KinesisVideo::GetSignalingChannelEndpointOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/GetSignalingChannelEndpoint> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> ChannelARN => Str | ||
| 56 | |||
| 57 | The Amazon Resource Name (ARN) of the signalling channel for which you | ||
| 58 | want to get an endpoint. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 SingleMasterChannelEndpointConfiguration => L<Paws::KinesisVideo::SingleMasterChannelEndpointConfiguration> | ||
| 63 | |||
| 64 | A structure containing the endpoint configuration for the | ||
| 65 | C<SINGLE_MASTER> channel type. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, documenting arguments for method GetSignalingChannelEndpoint in L<Paws::KinesisVideo> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |