« blib/lib/Paws/IoTAnalytics/UpdateDataset.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/UpdatePipeline.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::UpdateDatastore; | ||
| 3 | use Moose; | ||
| 4 | has DatastoreName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'datastoreName', required => 1); | ||
| 5 | has DatastoreStorage => (is => 'ro', isa => 'Paws::IoTAnalytics::DatastoreStorage', traits => ['NameInRequest'], request_name => 'datastoreStorage'); | ||
| 6 | has FileFormatConfiguration => (is => 'ro', isa => 'Paws::IoTAnalytics::FileFormatConfiguration', traits => ['NameInRequest'], request_name => 'fileFormatConfiguration'); | ||
| 7 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', traits => ['NameInRequest'], request_name => 'retentionPeriod'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDatastore'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/datastores/{datastoreName}'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::IoTAnalytics::UpdateDatastore - Arguments for method UpdateDatastore on L<Paws::IoTAnalytics> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method UpdateDatastore on the | ||
| 26 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 27 | as arguments to method UpdateDatastore. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDatastore. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 34 | $iotanalytics->UpdateDatastore( | ||
| 35 | DatastoreName => 'MyDatastoreName', | ||
| 36 | DatastoreStorage => { | ||
| 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 | FileFormatConfiguration => { | ||
| 47 | JsonConfiguration => { | ||
| 48 | |||
| 49 | }, # OPTIONAL | ||
| 50 | ParquetConfiguration => { | ||
| 51 | SchemaDefinition => { | ||
| 52 | Columns => [ | ||
| 53 | { | ||
| 54 | Name => 'MyColumnName', # min: 1, max: 255 | ||
| 55 | Type => 'MyColumnDataType', # min: 1, max: 131072 | ||
| 56 | |||
| 57 | }, | ||
| 58 | ... | ||
| 59 | ], # OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | }, # OPTIONAL | ||
| 62 | }, # OPTIONAL | ||
| 63 | RetentionPeriod => { | ||
| 64 | NumberOfDays => 1, # min: 1; OPTIONAL | ||
| 65 | Unlimited => 1, # OPTIONAL | ||
| 66 | }, # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | 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. | ||
| 70 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/UpdateDatastore> | ||
| 71 | |||
| 72 | =head1 ATTRIBUTES | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> DatastoreName => Str | ||
| 76 | |||
| 77 | The name of the data store to be updated. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 DatastoreStorage => L<Paws::IoTAnalytics::DatastoreStorage> | ||
| 82 | |||
| 83 | Where data store data is stored. You can choose one of | ||
| 84 | C<serviceManagedS3> or C<customerManagedS3> storage. If not specified, | ||
| 85 | the default isC<serviceManagedS3>. You cannot change this storage | ||
| 86 | option after the data store is created. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 FileFormatConfiguration => L<Paws::IoTAnalytics::FileFormatConfiguration> | ||
| 91 | |||
| 92 | Contains the configuration information of file formats. AWS IoT | ||
| 93 | Analytics data stores support JSON and Parquet | ||
| 94 | (https://parquet.apache.org/). | ||
| 95 | |||
| 96 | The default file format is JSON. You can specify only one format. | ||
| 97 | |||
| 98 | You can't change the file format after you create the data store. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 103 | |||
| 104 | How long, in days, message data is kept for the data store. The | ||
| 105 | retention period cannot be updated if the data store's S3 storage is | ||
| 106 | customer-managed. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method UpdateDatastore in L<Paws::IoTAnalytics> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |