« blib/lib/Paws/MachineLearning/CreateBatchPredictionOutput.pm
↑ Summary
blib/lib/Paws/MachineLearning/CreateDataSourceFromRDSOutput.pm »
| 1 | |||
| 2 | package Paws::MachineLearning::CreateDataSourceFromRDS; | ||
| 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 RDSData => (is => 'ro', isa => 'Paws::MachineLearning::RDSDataSpec', 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 => 'CreateDataSourceFromRDS'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MachineLearning::CreateDataSourceFromRDSOutput'); | ||
| 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::CreateDataSourceFromRDS - Arguments for method CreateDataSourceFromRDS on L<Paws::MachineLearning> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateDataSourceFromRDS on the | ||
| 26 | L<Amazon Machine Learning|Paws::MachineLearning> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateDataSourceFromRDS. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDataSourceFromRDS. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $machinelearning = Paws->service('MachineLearning'); | ||
| 34 | my $CreateDataSourceFromRDSOutput = | ||
| 35 | $machinelearning->CreateDataSourceFromRDS( | ||
| 36 | DataSourceId => 'MyEntityId', | ||
| 37 | RDSData => { | ||
| 38 | DatabaseCredentials => { | ||
| 39 | Password => 'MyRDSDatabasePassword', # min: 8, max: 128 | ||
| 40 | Username => 'MyRDSDatabaseUsername', # min: 1, max: 128 | ||
| 41 | |||
| 42 | }, | ||
| 43 | DatabaseInformation => { | ||
| 44 | DatabaseName => 'MyRDSDatabaseName', # min: 1, max: 64 | ||
| 45 | InstanceIdentifier => 'MyRDSInstanceIdentifier', # min: 1, max: 63 | ||
| 46 | |||
| 47 | }, | ||
| 48 | ResourceRole => 'MyEDPResourceRole', # min: 1, max: 64 | ||
| 49 | S3StagingLocation => 'MyS3Url', # max: 2048 | ||
| 50 | SecurityGroupIds => [ | ||
| 51 | 'MyEDPSecurityGroupId', ... # min: 1, max: 255 | ||
| 52 | ], | ||
| 53 | SelectSqlQuery => 'MyRDSSelectSqlQuery', # min: 1, max: 16777216 | ||
| 54 | ServiceRole => 'MyEDPServiceRole', # min: 1, max: 64 | ||
| 55 | SubnetId => 'MyEDPSubnetId', # min: 1, max: 255 | ||
| 56 | DataRearrangement => 'MyDataRearrangement', # OPTIONAL | ||
| 57 | DataSchema => 'MyDataSchema', # max: 131071; OPTIONAL | ||
| 58 | DataSchemaUri => 'MyS3Url', # max: 2048 | ||
| 59 | }, | ||
| 60 | RoleARN => 'MyRoleARN', | ||
| 61 | ComputeStatistics => 1, # OPTIONAL | ||
| 62 | DataSourceName => 'MyEntityName', # OPTIONAL | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $DataSourceId = $CreateDataSourceFromRDSOutput->DataSourceId; | ||
| 67 | |||
| 68 | # Returns a L<Paws::MachineLearning::CreateDataSourceFromRDSOutput> object. | ||
| 69 | |||
| 70 | 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. | ||
| 71 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/machinelearning/CreateDataSourceFromRDS> | ||
| 72 | |||
| 73 | =head1 ATTRIBUTES | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ComputeStatistics => Bool | ||
| 77 | |||
| 78 | The compute statistics for a C<DataSource>. The statistics are | ||
| 79 | generated from the observation data referenced by a C<DataSource>. | ||
| 80 | Amazon ML uses the statistics internally during C<MLModel> training. | ||
| 81 | This parameter must be set to C<true> if the C<DataSourceC< needs to be | ||
| 82 | used for C<MLModel> training. >> | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> DataSourceId => Str | ||
| 87 | |||
| 88 | A user-supplied ID that uniquely identifies the C<DataSource>. | ||
| 89 | Typically, an Amazon Resource Number (ARN) becomes the ID for a | ||
| 90 | C<DataSource>. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 DataSourceName => Str | ||
| 95 | |||
| 96 | A user-supplied name or description of the C<DataSource>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> RDSData => L<Paws::MachineLearning::RDSDataSpec> | ||
| 101 | |||
| 102 | The data specification of an Amazon RDS C<DataSource>: | ||
| 103 | |||
| 104 | =over | ||
| 105 | |||
| 106 | =item * | ||
| 107 | |||
| 108 | DatabaseInformation - | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<DatabaseName> - The name of the Amazon RDS database. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<InstanceIdentifier > - A unique identifier for the Amazon RDS | ||
| 119 | database instance. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | DatabaseCredentials - AWS Identity and Access Management (IAM) | ||
| 126 | credentials that are used to connect to the Amazon RDS database. | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an | ||
| 131 | EC2 instance to carry out the copy task from Amazon RDS to Amazon | ||
| 132 | Simple Storage Service (Amazon S3). For more information, see Role | ||
| 133 | templates | ||
| 134 | (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) | ||
| 135 | for data pipelines. | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data | ||
| 140 | Pipeline service to monitor the progress of the copy task from Amazon | ||
| 141 | RDS to Amazon S3. For more information, see Role templates | ||
| 142 | (https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html) | ||
| 143 | for data pipelines. | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | SecurityInfo - The security information to use to access an RDS DB | ||
| 148 | instance. You need to set up appropriate ingress rules for the security | ||
| 149 | entity IDs provided to allow access to the Amazon RDS instance. Specify | ||
| 150 | a [C<SubnetId>, C<SecurityGroupIds>] pair for a VPC-based RDS DB | ||
| 151 | instance. | ||
| 152 | |||
| 153 | =item * | ||
| 154 | |||
| 155 | SelectSqlQuery - A query that is used to retrieve the observation data | ||
| 156 | for the C<Datasource>. | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. | ||
| 161 | The data retrieved from Amazon RDS using C<SelectSqlQuery> is stored in | ||
| 162 | this location. | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | DataSchemaUri - The Amazon S3 location of the C<DataSchema>. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | DataSchema - A JSON string representing the schema. This is not | ||
| 171 | required if C<DataSchemaUri> is specified. | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | DataRearrangement - A JSON string that represents the splitting and | ||
| 176 | rearrangement requirements for the C<Datasource>. | ||
| 177 | |||
| 178 | Sample - C< "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"> | ||
| 179 | |||
| 180 | =back | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 B<REQUIRED> RoleARN => Str | ||
| 186 | |||
| 187 | The role that Amazon ML assumes on behalf of the user to create and | ||
| 188 | activate a data pipeline in the user's account and copy data using the | ||
| 189 | C<SelectSqlQuery> query from Amazon RDS to Amazon S3. | ||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head1 SEE ALSO | ||
| 195 | |||
| 196 | This class forms part of L<Paws>, documenting arguments for method CreateDataSourceFromRDS in L<Paws::MachineLearning> | ||
| 197 | |||
| 198 | =head1 BUGS and CONTRIBUTIONS | ||
| 199 | |||
| 200 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 201 | |||
| 202 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 203 | |||
| 204 | =cut | ||
| 205 |