« blib/lib/Paws/SageMaker/CreateExperimentResponse.pm
↑ Summary
blib/lib/Paws/SageMaker/CreateFeatureGroupResponse.pm »
| 1 | |||
| 2 | package Paws::SageMaker::CreateFeatureGroup; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has EventTimeFeatureName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has FeatureDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::FeatureDefinition]', required => 1); | ||
| 7 | has FeatureGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has OfflineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OfflineStoreConfig'); | ||
| 9 | has OnlineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OnlineStoreConfig'); | ||
| 10 | has RecordIdentifierFeatureName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 12 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFeatureGroup'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SageMaker::CreateFeatureGroupResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::SageMaker::CreateFeatureGroup - Arguments for method CreateFeatureGroup on L<Paws::SageMaker> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateFeatureGroup on the | ||
| 30 | L<Amazon SageMaker Service|Paws::SageMaker> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateFeatureGroup. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFeatureGroup. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $api.sagemaker = Paws->service('SageMaker'); | ||
| 38 | my $CreateFeatureGroupResponse = $api . sagemaker->CreateFeatureGroup( | ||
| 39 | EventTimeFeatureName => 'MyFeatureName', | ||
| 40 | FeatureDefinitions => [ | ||
| 41 | { | ||
| 42 | FeatureName => 'MyFeatureName', # min: 1, max: 64 | ||
| 43 | FeatureType => | ||
| 44 | 'Integral', # values: Integral, Fractional, String; OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], | ||
| 48 | FeatureGroupName => 'MyFeatureGroupName', | ||
| 49 | RecordIdentifierFeatureName => 'MyFeatureName', | ||
| 50 | Description => 'MyDescription', # OPTIONAL | ||
| 51 | OfflineStoreConfig => { | ||
| 52 | S3StorageConfig => { | ||
| 53 | S3Uri => 'MyS3Uri', # max: 1024 | ||
| 54 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 55 | ResolvedOutputS3Uri => 'MyS3Uri', # max: 1024 | ||
| 56 | }, | ||
| 57 | DataCatalogConfig => { | ||
| 58 | Catalog => 'MyCatalog', # min: 1, max: 255 | ||
| 59 | Database => 'MyDatabase', # min: 1, max: 255 | ||
| 60 | TableName => 'MyTableName', # min: 1, max: 255 | ||
| 61 | |||
| 62 | }, # OPTIONAL | ||
| 63 | DisableGlueTableCreation => 1, # OPTIONAL | ||
| 64 | }, # OPTIONAL | ||
| 65 | OnlineStoreConfig => { | ||
| 66 | EnableOnlineStore => 1, # OPTIONAL | ||
| 67 | SecurityConfig => { | ||
| 68 | KmsKeyId => 'MyKmsKeyId', # max: 2048; OPTIONAL | ||
| 69 | }, # OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | RoleArn => 'MyRoleArn', # OPTIONAL | ||
| 72 | Tags => [ | ||
| 73 | { | ||
| 74 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 75 | Value => 'MyTagValue', # max: 256 | ||
| 76 | |||
| 77 | }, | ||
| 78 | ... | ||
| 79 | ], # OPTIONAL | ||
| 80 | ); | ||
| 81 | |||
| 82 | # Results: | ||
| 83 | my $FeatureGroupArn = $CreateFeatureGroupResponse->FeatureGroupArn; | ||
| 84 | |||
| 85 | # Returns a L<Paws::SageMaker::CreateFeatureGroupResponse> object. | ||
| 86 | |||
| 87 | 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. | ||
| 88 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateFeatureGroup> | ||
| 89 | |||
| 90 | =head1 ATTRIBUTES | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Description => Str | ||
| 94 | |||
| 95 | A free-form description of a C<FeatureGroup>. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> EventTimeFeatureName => Str | ||
| 100 | |||
| 101 | The name of the feature that stores the C<EventTime> of a C<Record> in | ||
| 102 | a C<FeatureGroup>. | ||
| 103 | |||
| 104 | An C<EventTime> is a point in time when a new event occurs that | ||
| 105 | corresponds to the creation or update of a C<Record> in a | ||
| 106 | C<FeatureGroup>. All C<Records> in the C<FeatureGroup> must have a | ||
| 107 | corresponding C<EventTime>. | ||
| 108 | |||
| 109 | An C<EventTime> can be a C<String> or C<Fractional>. | ||
| 110 | |||
| 111 | =over | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<Fractional>: C<EventTime> feature values must be a Unix timestamp in | ||
| 116 | seconds. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<String>: C<EventTime> feature values must be an ISO-8601 string in | ||
| 121 | the format. The following formats are supported | ||
| 122 | C<yyyy-MM-dd'T'HH:mm:ssZ> and C<yyyy-MM-dd'T'HH:mm:ss.SSSZ> where | ||
| 123 | C<yyyy>, C<MM>, and C<dd> represent the year, month, and day | ||
| 124 | respectively and C<HH>, C<mm>, C<ss>, and if applicable, C<SSS> | ||
| 125 | represent the hour, month, second and milliseconds respsectively. | ||
| 126 | C<'T'> and C<Z> are constants. | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> FeatureDefinitions => ArrayRef[L<Paws::SageMaker::FeatureDefinition>] | ||
| 134 | |||
| 135 | A list of C<Feature> names and types. C<Name> and C<Type> is compulsory | ||
| 136 | per C<Feature>. | ||
| 137 | |||
| 138 | Valid feature C<FeatureType>s are C<Integral>, C<Fractional> and | ||
| 139 | C<String>. | ||
| 140 | |||
| 141 | C<FeatureName>s cannot be any of the following: C<is_deleted>, | ||
| 142 | C<write_time>, C<api_invocation_time> | ||
| 143 | |||
| 144 | You can create up to 2,500 C<FeatureDefinition>s per C<FeatureGroup>. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 B<REQUIRED> FeatureGroupName => Str | ||
| 149 | |||
| 150 | The name of the C<FeatureGroup>. The name must be unique within an | ||
| 151 | Amazon Web Services Region in an Amazon Web Services account. The name: | ||
| 152 | |||
| 153 | =over | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | Must start and end with an alphanumeric character. | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | Can only contain alphanumeric character and hyphens. Spaces are not | ||
| 162 | allowed. | ||
| 163 | |||
| 164 | =back | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head2 OfflineStoreConfig => L<Paws::SageMaker::OfflineStoreConfig> | ||
| 170 | |||
| 171 | Use this to configure an C<OfflineFeatureStore>. This parameter allows | ||
| 172 | you to specify: | ||
| 173 | |||
| 174 | =over | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | The Amazon Simple Storage Service (Amazon S3) location of an | ||
| 179 | C<OfflineStore>. | ||
| 180 | |||
| 181 | =item * | ||
| 182 | |||
| 183 | A configuration for an Amazon Web Services Glue or Amazon Web Services | ||
| 184 | Hive data cataolgue. | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | An KMS encryption key to encrypt the Amazon S3 location used for | ||
| 189 | C<OfflineStore>. | ||
| 190 | |||
| 191 | =back | ||
| 192 | |||
| 193 | To learn more about this parameter, see OfflineStoreConfig. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head2 OnlineStoreConfig => L<Paws::SageMaker::OnlineStoreConfig> | ||
| 198 | |||
| 199 | You can turn the C<OnlineStore> on or off by specifying C<True> for the | ||
| 200 | C<EnableOnlineStore> flag in C<OnlineStoreConfig>; the default value is | ||
| 201 | C<False>. | ||
| 202 | |||
| 203 | You can also include an Amazon Web Services KMS key ID (C<KMSKeyId>) | ||
| 204 | for at-rest encryption of the C<OnlineStore>. | ||
| 205 | |||
| 206 | |||
| 207 | |||
| 208 | =head2 B<REQUIRED> RecordIdentifierFeatureName => Str | ||
| 209 | |||
| 210 | The name of the C<Feature> whose value uniquely identifies a C<Record> | ||
| 211 | defined in the C<FeatureStore>. Only the latest record per identifier | ||
| 212 | value will be stored in the C<OnlineStore>. | ||
| 213 | C<RecordIdentifierFeatureName> must be one of feature definitions' | ||
| 214 | names. | ||
| 215 | |||
| 216 | You use the C<RecordIdentifierFeatureName> to access data in a | ||
| 217 | C<FeatureStore>. | ||
| 218 | |||
| 219 | This name: | ||
| 220 | |||
| 221 | =over | ||
| 222 | |||
| 223 | =item * | ||
| 224 | |||
| 225 | Must start and end with an alphanumeric character. | ||
| 226 | |||
| 227 | =item * | ||
| 228 | |||
| 229 | Can only contains alphanumeric characters, hyphens, underscores. Spaces | ||
| 230 | are not allowed. | ||
| 231 | |||
| 232 | =back | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | |||
| 237 | =head2 RoleArn => Str | ||
| 238 | |||
| 239 | The Amazon Resource Name (ARN) of the IAM execution role used to | ||
| 240 | persist data into the C<OfflineStore> if an C<OfflineStoreConfig> is | ||
| 241 | provided. | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 246 | |||
| 247 | Tags used to identify C<Features> in each C<FeatureGroup>. | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | =head1 SEE ALSO | ||
| 253 | |||
| 254 | This class forms part of L<Paws>, documenting arguments for method CreateFeatureGroup in L<Paws::SageMaker> | ||
| 255 | |||
| 256 | =head1 BUGS and CONTRIBUTIONS | ||
| 257 | |||
| 258 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 259 | |||
| 260 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 261 | |||
| 262 | =cut | ||
| 263 |