« blib/lib/Paws/SageMaker/FeatureDefinition.pm
↑ Summary
blib/lib/Paws/SageMaker/FeatureGroupSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::FeatureGroup; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has EventTimeFeatureName => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 8 | has FeatureDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::FeatureDefinition]'); | ||
| 9 | has FeatureGroupArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has FeatureGroupName => (is => 'ro', isa => 'Str'); | ||
| 11 | has FeatureGroupStatus => (is => 'ro', isa => 'Str'); | ||
| 12 | has OfflineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OfflineStoreConfig'); | ||
| 13 | has OfflineStoreStatus => (is => 'ro', isa => 'Paws::SageMaker::OfflineStoreStatus'); | ||
| 14 | has OnlineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OnlineStoreConfig'); | ||
| 15 | has RecordIdentifierFeatureName => (is => 'ro', isa => 'Str'); | ||
| 16 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 17 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Tag]'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::SageMaker::FeatureGroup | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::SageMaker::FeatureGroup object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { CreationTime => $value, ..., Tags => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::FeatureGroup object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->CreationTime | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Amazon SageMaker Feature Store stores features in a collection called | ||
| 50 | Feature Group. A Feature Group can be visualized as a table which has | ||
| 51 | rows, with a unique identifier for each row where each column in the | ||
| 52 | table is a feature. In principle, a Feature Group is composed of | ||
| 53 | features and values per features. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 CreationTime => Str | ||
| 59 | |||
| 60 | The time a C<FeatureGroup> was created. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Description => Str | ||
| 64 | |||
| 65 | A free form description of a C<FeatureGroup>. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 EventTimeFeatureName => Str | ||
| 69 | |||
| 70 | The name of the feature that stores the C<EventTime> of a Record in a | ||
| 71 | C<FeatureGroup>. | ||
| 72 | |||
| 73 | A C<EventTime> is point in time when a new event occurs that | ||
| 74 | corresponds to the creation or update of a C<Record> in | ||
| 75 | C<FeatureGroup>. All C<Records> in the C<FeatureGroup> must have a | ||
| 76 | corresponding C<EventTime>. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 FailureReason => Str | ||
| 80 | |||
| 81 | The reason that the C<FeatureGroup> failed to be replicated in the | ||
| 82 | C<OfflineStore>. This is failure may be due to a failure to create a | ||
| 83 | C<FeatureGroup> in or delete a C<FeatureGroup> from the | ||
| 84 | C<OfflineStore>. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 FeatureDefinitions => ArrayRef[L<Paws::SageMaker::FeatureDefinition>] | ||
| 88 | |||
| 89 | A list of C<Feature>s. Each C<Feature> must include a C<FeatureName> | ||
| 90 | and a C<FeatureType>. | ||
| 91 | |||
| 92 | Valid C<FeatureType>s are C<Integral>, C<Fractional> and C<String>. | ||
| 93 | |||
| 94 | C<FeatureName>s cannot be any of the following: C<is_deleted>, | ||
| 95 | C<write_time>, C<api_invocation_time>. | ||
| 96 | |||
| 97 | You can create up to 2,500 C<FeatureDefinition>s per C<FeatureGroup>. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 FeatureGroupArn => Str | ||
| 101 | |||
| 102 | The Amazon Resource Name (ARN) of a C<FeatureGroup>. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 FeatureGroupName => Str | ||
| 106 | |||
| 107 | The name of the C<FeatureGroup>. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 FeatureGroupStatus => Str | ||
| 111 | |||
| 112 | A C<FeatureGroup> status. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 OfflineStoreConfig => L<Paws::SageMaker::OfflineStoreConfig> | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 OfflineStoreStatus => L<Paws::SageMaker::OfflineStoreStatus> | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 OnlineStoreConfig => L<Paws::SageMaker::OnlineStoreConfig> | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 RecordIdentifierFeatureName => Str | ||
| 131 | |||
| 132 | The name of the C<Feature> whose value uniquely identifies a C<Record> | ||
| 133 | defined in the C<FeatureGroup> C<FeatureDefinitions>. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 RoleArn => Str | ||
| 137 | |||
| 138 | The Amazon Resource Name (ARN) of the IAM execution role used to create | ||
| 139 | the feature group. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 Tags => ArrayRef[L<Paws::SageMaker::Tag>] | ||
| 143 | |||
| 144 | Tags used to define a C<FeatureGroup>. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |