« blib/lib/Paws/IoTAnalytics/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/UpdateDataset.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::UpdateChannel; | ||
| 3 | use Moose; | ||
| 4 | has ChannelName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'channelName', required => 1); | ||
| 5 | has ChannelStorage => (is => 'ro', isa => 'Paws::IoTAnalytics::ChannelStorage', traits => ['NameInRequest'], request_name => 'channelStorage'); | ||
| 6 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', traits => ['NameInRequest'], request_name => 'retentionPeriod'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateChannel'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels/{channelName}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::IoTAnalytics::UpdateChannel - Arguments for method UpdateChannel on L<Paws::IoTAnalytics> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateChannel on the | ||
| 25 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateChannel. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateChannel. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 33 | $iotanalytics->UpdateChannel( | ||
| 34 | ChannelName => 'MyChannelName', | ||
| 35 | ChannelStorage => { | ||
| 36 | CustomerManagedS3 => { | ||
| 37 | Bucket => 'MyBucketName', # min: 3, max: 255 | ||
| 38 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 39 | KeyPrefix => 'MyS3KeyPrefix', # min: 1, max: 255; OPTIONAL | ||
| 40 | }, # OPTIONAL | ||
| 41 | ServiceManagedS3 => { | ||
| 42 | |||
| 43 | }, # OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | RetentionPeriod => { | ||
| 46 | NumberOfDays => 1, # min: 1; OPTIONAL | ||
| 47 | Unlimited => 1, # OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/UpdateChannel> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> ChannelName => Str | ||
| 58 | |||
| 59 | The name of the channel to be updated. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 ChannelStorage => L<Paws::IoTAnalytics::ChannelStorage> | ||
| 64 | |||
| 65 | Where channel data is stored. You can choose one of C<serviceManagedS3> | ||
| 66 | or C<customerManagedS3> storage. If not specified, the default is | ||
| 67 | C<serviceManagedS3>. You cannot change this storage option after the | ||
| 68 | channel is created. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 73 | |||
| 74 | How long, in days, message data is kept for the channel. The retention | ||
| 75 | period cannot be updated if the channel's S3 storage is | ||
| 76 | customer-managed. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method UpdateChannel in L<Paws::IoTAnalytics> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |