« blib/lib/Paws/MachineLearning/CreateDataSourceFromRDSOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/CreateDataSourceFromRedshiftOutput.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::CreateDataSourceFromRedshift; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::MachineLearning> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDataSourceFromRedshift on the | ||
| 26 | L<Amazon Machine Learning|Paws::MachineLearning> 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 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $machinelearning = Paws->service('MachineLearning'); | ||
| 34 | my $CreateDataSourceFromRedshiftOutput = | ||
| 35 | $machinelearning->CreateDataSourceFromRedshift( | ||
| 36 | DataSourceId => 'MyEntityId', | ||
| 37 | DataSpec => { | ||
| 38 | DatabaseCredentials => { | ||
| 39 | Password => 'MyRedshiftDatabasePassword', # min: 8, max: 64 | ||
| 40 | Username => 'MyRedshiftDatabaseUsername', # min: 1, max: 128 | ||
| 41 | |||
| 42 | }, | ||
| 43 | DatabaseInformation => { | ||
| 44 | ClusterIdentifier => 'MyRedshiftClusterIdentifier', # min: 1, max: 63 | ||
| 45 | DatabaseName => 'MyRedshiftDatabaseName', # min: 1, max: 64 | ||
| 46 | |||
| 47 | }, | ||
| 48 | S3StagingLocation => 'MyS3Url', # max: 2048 | ||
| 49 | SelectSqlQuery => 'MyRedshiftSelectSqlQuery', # min: 1, max: 16777216 | ||
| 50 | DataRearrangement => 'MyDataRearrangement', # OPTIONAL | ||
| 51 | DataSchema => 'MyDataSchema', # max: 131071; OPTIONAL | ||
| 52 | DataSchemaUri => 'MyS3Url', # max: 2048 | ||
| 53 | }, | ||
| 54 | RoleARN => 'MyRoleARN', | ||
| 55 | ComputeStatistics => 1, # OPTIONAL | ||
| 56 | DataSourceName => 'MyEntityName', # OPTIONAL | ||
| 57 | ); | ||
| 58 | |||
| 59 | # Results: | ||
| 60 | my $DataSourceId = $CreateDataSourceFromRedshiftOutput->DataSourceId; | ||
| 61 | |||
| 62 | # Returns a L<Paws::MachineLearning::CreateDataSourceFromRedshiftOutput> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning/CreateDataSourceFromRedshift> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 ComputeStatistics => Bool | ||
| 71 | |||
| 72 | The compute statistics for a C<DataSource>. The statistics are | ||
| 73 | generated from the observation data referenced by a C<DataSource>. | ||
| 74 | Amazon ML uses the statistics internally during C<MLModel> training. | ||
| 75 | This parameter must be set to C<true> if the C<DataSource> needs to be | ||
| 76 | used for C<MLModel> training. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> DataSourceId => Str | ||
| 81 | |||
| 82 | A user-supplied ID that uniquely identifies the C<DataSource>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 DataSourceName => Str | ||
| 87 | |||
| 88 | A user-supplied name or description of the C<DataSource>. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> DataSpec => L<Paws::MachineLearning::RedshiftDataSpec> | ||
| 93 | |||
| 94 | The data specification of an Amazon Redshift C<DataSource>: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | DatabaseInformation - | ||
| 101 | |||
| 102 | =over | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<DatabaseName> - The name of the Amazon Redshift database. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<ClusterIdentifier> - The unique ID for the Amazon Redshift cluster. | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | DatabaseCredentials - The AWS Identity and Access Management (IAM) | ||
| 117 | credentials that are used to connect to the Amazon Redshift database. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | SelectSqlQuery - The query that is used to retrieve the observation | ||
| 122 | data for the C<Datasource>. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) | ||
| 127 | location for staging Amazon Redshift data. The data retrieved from | ||
| 128 | Amazon Redshift using the C<SelectSqlQuery> query is stored in this | ||
| 129 | location. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | DataSchemaUri - The Amazon S3 location of the C<DataSchema>. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | DataSchema - A JSON string representing the schema. This is not | ||
| 138 | required if C<DataSchemaUri> is specified. | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | DataRearrangement - A JSON string that represents the splitting and | ||
| 143 | rearrangement requirements for the C<DataSource>. | ||
| 144 | |||
| 145 | Sample - C< "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"> | ||
| 146 | |||
| 147 | =back | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 B<REQUIRED> RoleARN => Str | ||
| 153 | |||
| 154 | A fully specified role Amazon Resource Name (ARN). Amazon ML assumes | ||
| 155 | the role on behalf of the user to create the following: | ||
| 156 | |||
| 157 | =over | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | A security group to allow Amazon ML to execute the C<SelectSqlQuery> | ||
| 162 | query on an Amazon Redshift cluster | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | An Amazon S3 bucket policy to grant Amazon ML read/write permissions on | ||
| 167 | the C<S3StagingLocation> | ||
| 168 | |||
| 169 | =back | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, documenting arguments for method CreateDataSourceFromRedshift in L<Paws::MachineLearning> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |