« blib/lib/Paws/TimestreamWrite/CreateDatabaseResponse.pm
↑ Summary
blib/lib/Paws/TimestreamWrite/CreateTableResponse.pm »
| 1 | |||
| 2 | package Paws::TimestreamWrite::CreateTable; | ||
| 3 | use Moose; | ||
| 4 | has DatabaseName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has RetentionProperties => (is => 'ro', isa => 'Paws::TimestreamWrite::RetentionProperties'); | ||
| 6 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::TimestreamWrite::Tag]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTable'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::TimestreamWrite::CreateTableResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::TimestreamWrite::CreateTable - Arguments for method CreateTable on L<Paws::TimestreamWrite> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreateTable on the | ||
| 25 | L<Amazon Timestream Write|Paws::TimestreamWrite> service. Use the attributes of this class | ||
| 26 | as arguments to method CreateTable. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTable. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ingest.timestream = Paws->service('TimestreamWrite'); | ||
| 33 | my $CreateTableResponse = $ingest . timestream->CreateTable( | ||
| 34 | DatabaseName => 'MyResourceName', | ||
| 35 | TableName => 'MyResourceName', | ||
| 36 | RetentionProperties => { | ||
| 37 | MagneticStoreRetentionPeriodInDays => 1, # min: 1, max: 73000 | ||
| 38 | MemoryStoreRetentionPeriodInHours => 1, # min: 1, max: 8766 | ||
| 39 | |||
| 40 | }, # OPTIONAL | ||
| 41 | Tags => [ | ||
| 42 | { | ||
| 43 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 44 | Value => 'MyTagValue', # max: 256 | ||
| 45 | |||
| 46 | }, | ||
| 47 | ... | ||
| 48 | ], # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $Table = $CreateTableResponse->Table; | ||
| 53 | |||
| 54 | # Returns a L<Paws::TimestreamWrite::CreateTableResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ingest.timestream/CreateTable> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> DatabaseName => Str | ||
| 63 | |||
| 64 | The name of the Timestream database. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 RetentionProperties => L<Paws::TimestreamWrite::RetentionProperties> | ||
| 69 | |||
| 70 | The duration for which your time series data must be stored in the | ||
| 71 | memory store and the magnetic store. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> TableName => Str | ||
| 76 | |||
| 77 | The name of the Timestream table. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Tags => ArrayRef[L<Paws::TimestreamWrite::Tag>] | ||
| 82 | |||
| 83 | A list of key-value pairs to label the table. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method CreateTable in L<Paws::TimestreamWrite> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |