« blib/lib/Paws/IoTAnalytics/RunPipelineActivityResponse.pm
↑ Summary
blib/lib/Paws/IoTAnalytics/SampleChannelData.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IoTAnalytics::S3DestinationConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Bucket => (is => 'ro', isa => 'Str', request_name => 'bucket', traits => ['NameInRequest'], required => 1); | ||
| 5 | has GlueConfiguration => (is => 'ro', isa => 'Paws::IoTAnalytics::GlueConfiguration', request_name => 'glueConfiguration', traits => ['NameInRequest']); | ||
| 6 | has Key => (is => 'ro', isa => 'Str', request_name => 'key', traits => ['NameInRequest'], required => 1); | ||
| 7 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::IoTAnalytics::S3DestinationConfiguration | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::IoTAnalytics::S3DestinationConfiguration object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Bucket => $value, ..., RoleArn => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::IoTAnalytics::S3DestinationConfiguration object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Bucket | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Configuration information for delivery of dataset contents to Amazon | ||
| 40 | Simple Storage Service (Amazon S3). | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> Bucket => Str | ||
| 46 | |||
| 47 | The name of the S3 bucket to which dataset contents are delivered. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 GlueConfiguration => L<Paws::IoTAnalytics::GlueConfiguration> | ||
| 51 | |||
| 52 | Configuration information for coordination with AWS Glue, a fully | ||
| 53 | managed extract, transform and load (ETL) service. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Key => Str | ||
| 57 | |||
| 58 | The key of the dataset contents object in an S3 bucket. Each object has | ||
| 59 | a key that is a unique identifier. Each object has exactly one key. | ||
| 60 | |||
| 61 | You can create a unique key with the following options: | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | Use C<!{iotanalytics:scheduleTime}> to insert the time of a scheduled | ||
| 68 | SQL query run. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Use C<!{iotanalytics:versionId}> to insert a unique hash that | ||
| 73 | identifies a dataset content. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Use C<!{iotanalytics:creationTime}> to insert the creation time of a | ||
| 78 | dataset content. | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | The following example creates a unique key for a CSV file: | ||
| 83 | C<dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv> | ||
| 84 | |||
| 85 | If you don't use C<!{iotanalytics:versionId}> to specify the key, you | ||
| 86 | might get duplicate keys. For example, you might have two dataset | ||
| 87 | contents with the same C<scheduleTime> but different C<versionId>s. | ||
| 88 | This means that one dataset content overwrites the other. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> RoleArn => Str | ||
| 92 | |||
| 93 | The ARN of the role that grants AWS IoT Analytics permission to | ||
| 94 | interact with your Amazon S3 and AWS Glue resources. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, describing an object used in L<Paws::IoTAnalytics> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |