« blib/lib/Paws/KinesisVideo/ChannelNameCondition.pm
↑ Summary
blib/lib/Paws/KinesisVideo/CreateSignalingChannelOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::CreateSignalingChannel; | ||
| 3 | use Moose; | ||
| 4 | has ChannelName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ChannelType => (is => 'ro', isa => 'Str'); | ||
| 6 | has SingleMasterConfiguration => (is => 'ro', isa => 'Paws::KinesisVideo::SingleMasterConfiguration'); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::KinesisVideo::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateSignalingChannel'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/createSignalingChannel'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::CreateSignalingChannelOutput'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::KinesisVideo::CreateSignalingChannel - Arguments for method CreateSignalingChannel on L<Paws::KinesisVideo> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateSignalingChannel on the | ||
| 26 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateSignalingChannel. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateSignalingChannel. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 34 | my $CreateSignalingChannelOutput = $kinesisvideo->CreateSignalingChannel( | ||
| 35 | ChannelName => 'MyChannelName', | ||
| 36 | ChannelType => 'SINGLE_MASTER', # OPTIONAL | ||
| 37 | SingleMasterConfiguration => { | ||
| 38 | MessageTtlSeconds => 1, # min: 5, max: 120; OPTIONAL | ||
| 39 | }, # OPTIONAL | ||
| 40 | Tags => [ | ||
| 41 | { | ||
| 42 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 43 | Value => 'MyTagValue', # max: 256 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ChannelARN = $CreateSignalingChannelOutput->ChannelARN; | ||
| 52 | |||
| 53 | # Returns a L<Paws::KinesisVideo::CreateSignalingChannelOutput> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/CreateSignalingChannel> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> ChannelName => Str | ||
| 62 | |||
| 63 | A name for the signaling channel that you are creating. It must be | ||
| 64 | unique for each AWS account and AWS Region. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 ChannelType => Str | ||
| 69 | |||
| 70 | A type of the signaling channel that you are creating. Currently, | ||
| 71 | C<SINGLE_MASTER> is the only supported channel type. | ||
| 72 | |||
| 73 | Valid values are: C<"SINGLE_MASTER"> | ||
| 74 | |||
| 75 | =head2 SingleMasterConfiguration => L<Paws::KinesisVideo::SingleMasterConfiguration> | ||
| 76 | |||
| 77 | A structure containing the configuration for the C<SINGLE_MASTER> | ||
| 78 | channel type. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 Tags => ArrayRef[L<Paws::KinesisVideo::Tag>] | ||
| 83 | |||
| 84 | A set of tags (key-value pairs) that you want to associate with this | ||
| 85 | channel. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method CreateSignalingChannel in L<Paws::KinesisVideo> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |