« blib/lib/Paws/KinesisAnalytics/AddApplicationOutputResponse.pm
↑ Summary
blib/lib/Paws/KinesisAnalytics/AddApplicationReferenceDataSourceResponse.pm »
| 1 | |||
| 2 | package Paws::KinesisAnalytics::AddApplicationReferenceDataSource; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CurrentApplicationVersionId => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has ReferenceDataSource => (is => 'ro', isa => 'Paws::KinesisAnalytics::ReferenceDataSource', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AddApplicationReferenceDataSource'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KinesisAnalytics::AddApplicationReferenceDataSourceResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::KinesisAnalytics::AddApplicationReferenceDataSource - Arguments for method AddApplicationReferenceDataSource on L<Paws::KinesisAnalytics> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method AddApplicationReferenceDataSource on the | ||
| 24 | L<Amazon Kinesis Analytics|Paws::KinesisAnalytics> service. Use the attributes of this class | ||
| 25 | as arguments to method AddApplicationReferenceDataSource. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AddApplicationReferenceDataSource. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $kinesisanalytics = Paws->service('KinesisAnalytics'); | ||
| 32 | my $AddApplicationReferenceDataSourceResponse = | ||
| 33 | $kinesisanalytics->AddApplicationReferenceDataSource( | ||
| 34 | ApplicationName => 'MyApplicationName', | ||
| 35 | CurrentApplicationVersionId => 1, | ||
| 36 | ReferenceDataSource => { | ||
| 37 | ReferenceSchema => { | ||
| 38 | RecordColumns => [ | ||
| 39 | { | ||
| 40 | Name => 'MyRecordColumnName', | ||
| 41 | SqlType => 'MyRecordColumnSqlType', # min: 1 | ||
| 42 | Mapping => 'MyRecordColumnMapping', # OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # min: 1, max: 1000 | ||
| 46 | RecordFormat => { | ||
| 47 | RecordFormatType => 'JSON', # values: JSON, CSV | ||
| 48 | MappingParameters => { | ||
| 49 | CSVMappingParameters => { | ||
| 50 | RecordColumnDelimiter => 'MyRecordColumnDelimiter', # min: 1 | ||
| 51 | RecordRowDelimiter => 'MyRecordRowDelimiter', # min: 1 | ||
| 52 | |||
| 53 | }, # OPTIONAL | ||
| 54 | JSONMappingParameters => { | ||
| 55 | RecordRowPath => 'MyRecordRowPath', # min: 1 | ||
| 56 | |||
| 57 | }, # OPTIONAL | ||
| 58 | }, # OPTIONAL | ||
| 59 | }, | ||
| 60 | RecordEncoding => 'MyRecordEncoding', # OPTIONAL | ||
| 61 | }, | ||
| 62 | TableName => 'MyInAppTableName', # min: 1, max: 32 | ||
| 63 | S3ReferenceDataSource => { | ||
| 64 | BucketARN => 'MyBucketARN', # min: 1, max: 2048 | ||
| 65 | FileKey => 'MyFileKey', # min: 1, max: 1024 | ||
| 66 | ReferenceRoleARN => 'MyRoleARN', # min: 1, max: 2048 | ||
| 67 | |||
| 68 | }, # OPTIONAL | ||
| 69 | }, | ||
| 70 | |||
| 71 | ); | ||
| 72 | |||
| 73 | 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. | ||
| 74 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics/AddApplicationReferenceDataSource> | ||
| 75 | |||
| 76 | =head1 ATTRIBUTES | ||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> ApplicationName => Str | ||
| 80 | |||
| 81 | Name of an existing application. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> CurrentApplicationVersionId => Int | ||
| 86 | |||
| 87 | Version of the application for which you are adding the reference data | ||
| 88 | source. You can use the DescribeApplication | ||
| 89 | (https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html) | ||
| 90 | operation to get the current application version. If the version | ||
| 91 | specified is not the current version, the | ||
| 92 | C<ConcurrentModificationException> is returned. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> ReferenceDataSource => L<Paws::KinesisAnalytics::ReferenceDataSource> | ||
| 97 | |||
| 98 | The reference data source can be an object in your Amazon S3 bucket. | ||
| 99 | Amazon Kinesis Analytics reads the object and copies the data into the | ||
| 100 | in-application table that is created. You provide an S3 bucket, object | ||
| 101 | key name, and the resulting in-application table that is created. You | ||
| 102 | must also provide an IAM role with the necessary permissions that | ||
| 103 | Amazon Kinesis Analytics can assume to read the object from your S3 | ||
| 104 | bucket on your behalf. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, documenting arguments for method AddApplicationReferenceDataSource in L<Paws::KinesisAnalytics> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |