File Coverage

blib/lib/Paws/MachineLearning/CreateDataSourceFromRedshift.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::MachineLearning::CreateDataSourceFromRedshift;
3 1     1   576 use Moose;
  1         4  
  1         16  
4             has ComputeStatistics => (is => 'ro', isa => 'Bool');
5             has DataSourceId => (is => 'ro', isa => 'Str', required => 1);
6             has DataSourceName => (is => 'ro', isa => 'Str');
7             has DataSpec => (is => 'ro', isa => 'Paws::MachineLearning::RedshiftDataSpec', required => 1);
8             has RoleARN => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   11119 use MooseX::ClassAttribute;
  1         4  
  1         26  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDataSourceFromRedshift');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::CreateDataSourceFromRedshiftOutput');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::MachineLearning::CreateDataSourceFromRedshift - Arguments for method CreateDataSourceFromRedshift on Paws::MachineLearning
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method CreateDataSourceFromRedshift on the
26             Amazon Machine Learning service. Use the attributes of this class
27             as arguments to method CreateDataSourceFromRedshift.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSourceFromRedshift.
30              
31             As an example:
32              
33             $service_obj->CreateDataSourceFromRedshift(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 ComputeStatistics => Bool
41              
42             The compute statistics for a C<DataSource>. The statistics are
43             generated from the observation data referenced by a C<DataSource>.
44             Amazon ML uses the statistics internally during C<MLModel> training.
45             This parameter must be set to C<true> if the C<DataSource> needs to be
46             used for C<MLModel> training.
47              
48              
49              
50             =head2 B<REQUIRED> DataSourceId => Str
51              
52             A user-supplied ID that uniquely identifies the C<DataSource>.
53              
54              
55              
56             =head2 DataSourceName => Str
57              
58             A user-supplied name or description of the C<DataSource>.
59              
60              
61              
62             =head2 B<REQUIRED> DataSpec => L<Paws::MachineLearning::RedshiftDataSpec>
63              
64             The data specification of an Amazon Redshift C<DataSource>:
65              
66             =over
67              
68             =item *
69              
70             DatabaseInformation -
71              
72             =over
73              
74             =item * C<DatabaseName> - The name of the Amazon Redshift database.
75              
76             =item * C< ClusterIdentifier> - The unique ID for the Amazon Redshift
77             cluster.
78              
79             =back
80              
81             =item *
82              
83             DatabaseCredentials - The AWS Identity and Access Management (IAM)
84             credentials that are used to connect to the Amazon Redshift database.
85              
86             =item *
87              
88             SelectSqlQuery - The query that is used to retrieve the observation
89             data for the C<Datasource>.
90              
91             =item *
92              
93             S3StagingLocation - The Amazon Simple Storage Service (Amazon S3)
94             location for staging Amazon Redshift data. The data retrieved from
95             Amazon Redshift using the C<SelectSqlQuery> query is stored in this
96             location.
97              
98             =item *
99              
100             DataSchemaUri - The Amazon S3 location of the C<DataSchema>.
101              
102             =item *
103              
104             DataSchema - A JSON string representing the schema. This is not
105             required if C<DataSchemaUri> is specified.
106              
107             =item *
108              
109             DataRearrangement - A JSON string that represents the splitting and
110             rearrangement requirements for the C<DataSource>.
111              
112             Sample - C< "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}">
113              
114             =back
115              
116              
117              
118              
119             =head2 B<REQUIRED> RoleARN => Str
120              
121             A fully specified role Amazon Resource Name (ARN). Amazon ML assumes
122             the role on behalf of the user to create the following:
123              
124             =over
125              
126             =item *
127              
128             A security group to allow Amazon ML to execute the C<SelectSqlQuery>
129             query on an Amazon Redshift cluster
130              
131             =item *
132              
133             An Amazon S3 bucket policy to grant Amazon ML read/write permissions on
134             the C<S3StagingLocation>
135              
136             =back
137              
138              
139              
140              
141              
142             =head1 SEE ALSO
143              
144             This class forms part of L<Paws>, documenting arguments for method CreateDataSourceFromRedshift in L<Paws::MachineLearning>
145              
146             =head1 BUGS and CONTRIBUTIONS
147              
148             The source code is located here: https://github.com/pplu/aws-sdk-perl
149              
150             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
151              
152             =cut
153