blib/lib/Paws/KinesisVideo/CreateStream.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::KinesisVideo::CreateStream;
3 use Moose;
4 has DataRetentionInHours => (is => 'ro', isa => 'Int');
5 has DeviceName => (is => 'ro', isa => 'Str');
6 has KmsKeyId => (is => 'ro', isa => 'Str');
7 has MediaType => (is => 'ro', isa => 'Str');
8 has StreamName => (is => 'ro', isa => 'Str', required => 1);
9 has Tags => (is => 'ro', isa => 'Paws::KinesisVideo::ResourceTags');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateStream');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/createStream');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::CreateStreamOutput');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::KinesisVideo::CreateStream - Arguments for method CreateStream on L<Paws::KinesisVideo>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method CreateStream on the
28 L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class
29 as arguments to method CreateStream.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStream.
32  
33 =head1 SYNOPSIS
34  
35 my $kinesisvideo = Paws->service('KinesisVideo');
36 my $CreateStreamOutput = $kinesisvideo->CreateStream(
37 StreamName => 'MyStreamName',
38 DataRetentionInHours => 1, # OPTIONAL
39 DeviceName => 'MyDeviceName', # OPTIONAL
40 KmsKeyId => 'MyKmsKeyId', # OPTIONAL
41 MediaType => 'MyMediaType', # OPTIONAL
42 Tags => {
43 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
44 }, # OPTIONAL
45 );
46  
47 # Results:
48 my $StreamARN = $CreateStreamOutput->StreamARN;
49  
50 # Returns a L<Paws::KinesisVideo::CreateStreamOutput> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/CreateStream>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 DataRetentionInHours => Int
59  
60 The number of hours that you want to retain the data in the stream.
61 Kinesis Video Streams retains the data in a data store that is
62 associated with the stream.
63  
64 The default value is 0, indicating that the stream does not persist
65 data.
66  
67 When the C<DataRetentionInHours> value is 0, consumers can still
68 consume the fragments that remain in the service host buffer, which has
69 a retention time limit of 5 minutes and a retention memory limit of 200
70 MB. Fragments are removed from the buffer when either limit is reached.
71  
72  
73  
74 =head2 DeviceName => Str
75  
76 The name of the device that is writing to the stream.
77  
78 In the current implementation, Kinesis Video Streams does not use this
79 name.
80  
81  
82  
83 =head2 KmsKeyId => Str
84  
85 The ID of the AWS Key Management Service (AWS KMS) key that you want
86 Kinesis Video Streams to use to encrypt stream data.
87  
88 If no key ID is specified, the default, Kinesis Video-managed key
89 (C<aws/kinesisvideo>) is used.
90  
91 For more information, see DescribeKey
92 (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters).
93  
94  
95  
96 =head2 MediaType => Str
97  
98 The media type of the stream. Consumers of the stream can use this
99 information when processing the stream. For more information about
100 media types, see Media Types
101 (http://www.iana.org/assignments/media-types/media-types.xhtml). If you
102 choose to specify the C<MediaType>, see Naming Requirements
103 (https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines.
104  
105 Example valid values include "video/h264" and "video/h264,audio/aac".
106  
107 This parameter is optional; the default value is C<null> (or empty in
108 JSON).
109  
110  
111  
112 =head2 B<REQUIRED> StreamName => Str
113  
114 A name for the stream that you are creating.
115  
116 The stream name is an identifier for the stream, and must be unique for
117 each account and region.
118  
119  
120  
121 =head2 Tags => L<Paws::KinesisVideo::ResourceTags>
122  
123 A list of tags to associate with the specified stream. Each tag is a
124 key-value pair (the value is optional).
125  
126  
127  
128  
129 =head1 SEE ALSO
130  
131 This class forms part of L<Paws>, documenting arguments for method CreateStream in L<Paws::KinesisVideo>
132  
133 =head1 BUGS and CONTRIBUTIONS
134  
135 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
136  
137 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
138  
139 =cut
140