« blib/lib/Paws/Firehose/ColumnToJsonKeyMappings.pm
↑ Summary
blib/lib/Paws/Firehose/CreateDeliveryStream.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::CopyCommand; | ||
| 3 | use Moose; | ||
| 4 | has CopyOptions => (is => 'ro', isa => 'Str'); | ||
| 5 | has DataTableColumns => (is => 'ro', isa => 'Str'); | ||
| 6 | has DataTableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Firehose::CopyCommand | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Firehose::CopyCommand object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { CopyOptions => $value, ..., DataTableName => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::CopyCommand object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->CopyOptions | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes a C<COPY> command for Amazon Redshift. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 CopyOptions => Str | ||
| 44 | |||
| 45 | Optional parameters to use with the Amazon Redshift C<COPY> command. | ||
| 46 | For more information, see the "Optional Parameters" section of Amazon | ||
| 47 | Redshift COPY command | ||
| 48 | (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html). Some | ||
| 49 | possible examples that would apply to Kinesis Data Firehose are as | ||
| 50 | follows: | ||
| 51 | |||
| 52 | C<delimiter '\t' lzop;> - fields are delimited with "\t" (TAB | ||
| 53 | character) and compressed using lzop. | ||
| 54 | |||
| 55 | C<delimiter '|'> - fields are delimited with "|" (this is the default | ||
| 56 | delimiter). | ||
| 57 | |||
| 58 | C<delimiter '|' escape> - the delimiter should be escaped. | ||
| 59 | |||
| 60 | C<fixedwidth | ||
| 61 | 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'> - | ||
| 62 | fields are fixed width in the source, with each width specified after | ||
| 63 | every column in the table. | ||
| 64 | |||
| 65 | C<JSON 's3://mybucket/jsonpaths.txt'> - data is in JSON format, and the | ||
| 66 | path specified is the format of the data. | ||
| 67 | |||
| 68 | For more examples, see Amazon Redshift COPY command examples | ||
| 69 | (https://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html). | ||
| 70 | |||
| 71 | |||
| 72 | =head2 DataTableColumns => Str | ||
| 73 | |||
| 74 | A comma-separated list of column names. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> DataTableName => Str | ||
| 78 | |||
| 79 | The name of the target table. The table must already exist in the | ||
| 80 | database. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |