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