« blib/lib/Paws/KinesisVideo/UntagStreamOutput.pm
↑ Summary
blib/lib/Paws/KinesisVideo/UpdateDataRetentionOutput.pm »
| 1 | |||
| 2 | package Paws::KinesisVideo::UpdateDataRetention; | ||
| 3 | use Moose; | ||
| 4 | has CurrentVersion => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DataRetentionChangeInHours => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has Operation => (is => 'ro', isa => 'Str', required => 1); | ||
| 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 => 'UpdateDataRetention'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/updateDataRetention'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisVideo::UpdateDataRetentionOutput'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::KinesisVideo::UpdateDataRetention - Arguments for method UpdateDataRetention on L<Paws::KinesisVideo> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateDataRetention on the | ||
| 27 | L<Amazon Kinesis Video Streams|Paws::KinesisVideo> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateDataRetention. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDataRetention. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $kinesisvideo = Paws->service('KinesisVideo'); | ||
| 35 | my $UpdateDataRetentionOutput = $kinesisvideo->UpdateDataRetention( | ||
| 36 | CurrentVersion => 'MyVersion', | ||
| 37 | DataRetentionChangeInHours => 1, | ||
| 38 | Operation => 'INCREASE_DATA_RETENTION', | ||
| 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/UpdateDataRetention> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> CurrentVersion => Str | ||
| 50 | |||
| 51 | The version of the stream whose retention period you want to change. To | ||
| 52 | get the version, call either the C<DescribeStream> or the | ||
| 53 | C<ListStreams> API. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> DataRetentionChangeInHours => Int | ||
| 58 | |||
| 59 | The retention period, in hours. The value you specify replaces the | ||
| 60 | current value. The maximum value for this parameter is 87600 (ten | ||
| 61 | years). | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> Operation => Str | ||
| 66 | |||
| 67 | Indicates whether you want to increase or decrease the retention | ||
| 68 | period. | ||
| 69 | |||
| 70 | Valid values are: C<"INCREASE_DATA_RETENTION">, C<"DECREASE_DATA_RETENTION"> | ||
| 71 | |||
| 72 | =head2 StreamARN => Str | ||
| 73 | |||
| 74 | The Amazon Resource Name (ARN) of the stream whose retention period you | ||
| 75 | want to change. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 StreamName => Str | ||
| 80 | |||
| 81 | The name of the stream whose retention period you want to change. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method UpdateDataRetention in L<Paws::KinesisVideo> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |