« blib/lib/Paws/IoTAnalytics/CreateDatasetResponse.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/CreateDatastoreResponse.pm »
| 1 | |||
| 2 | package Paws::IoTAnalytics::CreateDatastore; | ||
| 3 | use Moose; | ||
| 4 | has DatastoreName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'datastoreName', required => 1); | ||
| 5 | has DatastorePartitions => (is => 'ro', isa => 'Paws::IoTAnalytics::DatastorePartitions', traits => ['NameInRequest'], request_name => 'datastorePartitions'); | ||
| 6 | has DatastoreStorage => (is => 'ro', isa => 'Paws::IoTAnalytics::DatastoreStorage', traits => ['NameInRequest'], request_name => 'datastoreStorage'); | ||
| 7 | has FileFormatConfiguration => (is => 'ro', isa => 'Paws::IoTAnalytics::FileFormatConfiguration', traits => ['NameInRequest'], request_name => 'fileFormatConfiguration'); | ||
| 8 | has RetentionPeriod => (is => 'ro', isa => 'Paws::IoTAnalytics::RetentionPeriod', traits => ['NameInRequest'], request_name => 'retentionPeriod'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IoTAnalytics::Tag]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDatastore'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/datastores'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTAnalytics::CreateDatastoreResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::IoTAnalytics::CreateDatastore - Arguments for method CreateDatastore on L<Paws::IoTAnalytics> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateDatastore on the | ||
| 28 | L<AWS IoT Analytics|Paws::IoTAnalytics> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateDatastore. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDatastore. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $iotanalytics = Paws->service('IoTAnalytics'); | ||
| 36 | my $CreateDatastoreResponse = $iotanalytics->CreateDatastore( | ||
| 37 | DatastoreName => 'MyDatastoreName', | ||
| 38 | DatastorePartitions => { | ||
| 39 | Partitions => [ | ||
| 40 | { | ||
| 41 | AttributePartition => { | ||
| 42 | AttributeName => 'MyPartitionAttributeName', # min: 1, max: 128 | ||
| 43 | |||
| 44 | }, # OPTIONAL | ||
| 45 | TimestampPartition => { | ||
| 46 | AttributeName => 'MyPartitionAttributeName', # min: 1, max: 128 | ||
| 47 | TimestampFormat => | ||
| 48 | 'MyTimestampFormat', # min: 1, max: 50; OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # max: 25; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | DatastoreStorage => { | ||
| 55 | CustomerManagedS3 => { | ||
| 56 | Bucket => 'MyBucketName', # min: 3, max: 255 | ||
| 57 | RoleArn => 'MyRoleArn', # min: 20, max: 2048 | ||
| 58 | KeyPrefix => 'MyS3KeyPrefix', # min: 1, max: 255; OPTIONAL | ||
| 59 | }, # OPTIONAL | ||
| 60 | ServiceManagedS3 => { | ||
| 61 | |||
| 62 | }, # OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | FileFormatConfiguration => { | ||
| 65 | JsonConfiguration => { | ||
| 66 | |||
| 67 | }, # OPTIONAL | ||
| 68 | ParquetConfiguration => { | ||
| 69 | SchemaDefinition => { | ||
| 70 | Columns => [ | ||
| 71 | { | ||
| 72 | Name => 'MyColumnName', # min: 1, max: 255 | ||
| 73 | Type => 'MyColumnDataType', # min: 1, max: 131072 | ||
| 74 | |||
| 75 | }, | ||
| 76 | ... | ||
| 77 | ], # OPTIONAL | ||
| 78 | }, # OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | }, # OPTIONAL | ||
| 81 | RetentionPeriod => { | ||
| 82 | NumberOfDays => 1, # min: 1; OPTIONAL | ||
| 83 | Unlimited => 1, # OPTIONAL | ||
| 84 | }, # OPTIONAL | ||
| 85 | Tags => [ | ||
| 86 | { | ||
| 87 | Key => 'MyTagKey', # min: 1, max: 256 | ||
| 88 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 89 | |||
| 90 | }, | ||
| 91 | ... | ||
| 92 | ], # OPTIONAL | ||
| 93 | ); | ||
| 94 | |||
| 95 | # Results: | ||
| 96 | my $DatastoreArn = $CreateDatastoreResponse->DatastoreArn; | ||
| 97 | my $DatastoreName = $CreateDatastoreResponse->DatastoreName; | ||
| 98 | my $RetentionPeriod = $CreateDatastoreResponse->RetentionPeriod; | ||
| 99 | |||
| 100 | # Returns a L<Paws::IoTAnalytics::CreateDatastoreResponse> object. | ||
| 101 | |||
| 102 | 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. | ||
| 103 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotanalytics/CreateDatastore> | ||
| 104 | |||
| 105 | =head1 ATTRIBUTES | ||
| 106 | |||
| 107 | |||
| 108 | =head2 B<REQUIRED> DatastoreName => Str | ||
| 109 | |||
| 110 | The name of the data store. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 DatastorePartitions => L<Paws::IoTAnalytics::DatastorePartitions> | ||
| 115 | |||
| 116 | Contains information about the partitions in a data store. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 DatastoreStorage => L<Paws::IoTAnalytics::DatastoreStorage> | ||
| 121 | |||
| 122 | Where data store data is stored. You can choose one of | ||
| 123 | C<serviceManagedS3> or C<customerManagedS3> storage. If not specified, | ||
| 124 | the default is C<serviceManagedS3>. You cannot change this storage | ||
| 125 | option after the data store is created. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 FileFormatConfiguration => L<Paws::IoTAnalytics::FileFormatConfiguration> | ||
| 130 | |||
| 131 | Contains the configuration information of file formats. AWS IoT | ||
| 132 | Analytics data stores support JSON and Parquet | ||
| 133 | (https://parquet.apache.org/). | ||
| 134 | |||
| 135 | The default file format is JSON. You can specify only one format. | ||
| 136 | |||
| 137 | You can't change the file format after you create the data store. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 RetentionPeriod => L<Paws::IoTAnalytics::RetentionPeriod> | ||
| 142 | |||
| 143 | How long, in days, message data is kept for the data store. When | ||
| 144 | C<customerManagedS3> storage is selected, this parameter is ignored. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 Tags => ArrayRef[L<Paws::IoTAnalytics::Tag>] | ||
| 149 | |||
| 150 | Metadata which can be used to manage the data store. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, documenting arguments for method CreateDatastore in L<Paws::IoTAnalytics> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |