« blib/lib/Paws/LookoutEquipment.pm
↑ Summary
blib/lib/Paws/LookoutEquipment/CreateDatasetResponse.pm »
| 1 | |||
| 2 | package Paws::LookoutEquipment::CreateDataset; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DatasetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DatasetSchema => (is => 'ro', isa => 'Paws::LookoutEquipment::DatasetSchema', required => 1); | ||
| 7 | has ServerSideKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::LookoutEquipment::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataset'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LookoutEquipment::CreateDatasetResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LookoutEquipment::CreateDataset - Arguments for method CreateDataset on L<Paws::LookoutEquipment> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDataset on the | ||
| 26 | L<Amazon Lookout for Equipment|Paws::LookoutEquipment> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDataset. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataset. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $lookoutequipment = Paws->service('LookoutEquipment'); | ||
| 34 | my $CreateDatasetResponse = $lookoutequipment->CreateDataset( | ||
| 35 | ClientToken => 'MyIdempotenceToken', | ||
| 36 | DatasetName => 'MyDatasetName', | ||
| 37 | DatasetSchema => { | ||
| 38 | InlineDataSchema => | ||
| 39 | 'MyInlineDataSchema', # min: 1, max: 1000000; OPTIONAL | ||
| 40 | }, | ||
| 41 | ServerSideKmsKeyId => 'MyNameOrArn', # OPTIONAL | ||
| 42 | Tags => [ | ||
| 43 | { | ||
| 44 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 45 | Value => 'MyTagValue', # max: 256 | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $DatasetArn = $CreateDatasetResponse->DatasetArn; | ||
| 54 | my $DatasetName = $CreateDatasetResponse->DatasetName; | ||
| 55 | my $Status = $CreateDatasetResponse->Status; | ||
| 56 | |||
| 57 | # Returns a L<Paws::LookoutEquipment::CreateDatasetResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment/CreateDataset> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> ClientToken => Str | ||
| 66 | |||
| 67 | A unique identifier for the request. If you do not set the client | ||
| 68 | request token, Amazon Lookout for Equipment generates one. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> DatasetName => Str | ||
| 73 | |||
| 74 | The name of the dataset being created. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> DatasetSchema => L<Paws::LookoutEquipment::DatasetSchema> | ||
| 79 | |||
| 80 | A JSON description of the data that is in each time series dataset, | ||
| 81 | including names, column names, and data types. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 ServerSideKmsKeyId => Str | ||
| 86 | |||
| 87 | Provides the identifier of the AWS KMS customer master key (CMK) used | ||
| 88 | to encrypt dataset data by Amazon Lookout for Equipment. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Tags => ArrayRef[L<Paws::LookoutEquipment::Tag>] | ||
| 93 | |||
| 94 | Any tags associated with the ingested data described in the dataset. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method CreateDataset in L<Paws::LookoutEquipment> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |