« blib/lib/Paws/KinesisVideo/UpdateSignalingChannelOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/UpdateStreamOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::UpdateStream; | ||
| 3 | use Moose; | ||
| 4 | has CurrentVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DeviceName => (is => 'ro', isa => 'Str'); | ||
| 6 | has MediaType => (is => 'ro', isa => 'Str'); | ||
| 7 | has StreamARN => (is => 'ro', isa => 'Str'); | ||
| 8 | has StreamName => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateStream'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/updateStream'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::UpdateStreamOutput'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::KinesisVideo::UpdateStream - Arguments for method UpdateStream on L<Paws::KinesisVideo> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateStream on the | ||
| 27 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateStream. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateStream. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 35 | my $UpdateStreamOutput = $kinesisvideo->UpdateStream( | ||
| 36 | CurrentVersion => 'MyVersion', | ||
| 37 | DeviceName => 'MyDeviceName', # OPTIONAL | ||
| 38 | MediaType => 'MyMediaType', # OPTIONAL | ||
| 39 | StreamARN => 'MyResourceARN', # OPTIONAL | ||
| 40 | StreamName => 'MyStreamName', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/UpdateStream> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> CurrentVersion => Str | ||
| 50 | |||
| 51 | The version of the stream whose metadata you want to update. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 DeviceName => Str | ||
| 56 | |||
| 57 | The name of the device that is writing to the stream. | ||
| 58 | |||
| 59 | In the current implementation, Kinesis Video Streams does not use this | ||
| 60 | name. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MediaType => Str | ||
| 65 | |||
| 66 | The stream's media type. Use C<MediaType> to specify the type of | ||
| 67 | content that the stream contains to the consumers of the stream. For | ||
| 68 | more information about media types, see Media Types | ||
| 69 | (http://www.iana.org/assignments/media-types/media-types.xhtml). If you | ||
| 70 | choose to specify the C<MediaType>, see Naming Requirements | ||
| 71 | (https://tools.ietf.org/html/rfc6838#section-4.2). | ||
| 72 | |||
| 73 | To play video on the console, you must specify the correct video type. | ||
| 74 | For example, if the video in the stream is H.264, specify C<video/h264> | ||
| 75 | as the C<MediaType>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 StreamARN => Str | ||
| 80 | |||
| 81 | The ARN of the stream whose metadata you want to update. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 StreamName => Str | ||
| 86 | |||
| 87 | The name of the stream whose metadata you want to update. | ||
| 88 | |||
| 89 | The stream name is an identifier for the stream, and must be unique for | ||
| 90 | each account and region. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method UpdateStream in L<Paws::KinesisVideo> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |