« blib/lib/Paws/SageMaker/DescribeFeatureGroup.pm
↑ Summary
blib/lib/Paws/SageMaker/DescribeFlowDefinition.pm »
| 1 | |||
| 2 | package Paws::SageMaker::DescribeFeatureGroupResponse; | ||
| 3 | use Moose; | ||
| 4 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has EventTimeFeatureName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 8 | has FeatureDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::FeatureDefinition]', required => 1); | ||
| 9 | has FeatureGroupArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has FeatureGroupName => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has FeatureGroupStatus => (is => 'ro', isa => 'Str'); | ||
| 12 | has NextToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has OfflineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OfflineStoreConfig'); | ||
| 14 | has OfflineStoreStatus => (is => 'ro', isa => 'Paws::SageMaker::OfflineStoreStatus'); | ||
| 15 | has OnlineStoreConfig => (is => 'ro', isa => 'Paws::SageMaker::OnlineStoreConfig'); | ||
| 16 | has RecordIdentifierFeatureName => (is => 'ro', isa => 'Str', required => 1); | ||
| 17 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::SageMaker::DescribeFeatureGroupResponse | ||
| 26 | |||
| 27 | =head1 ATTRIBUTES | ||
| 28 | |||
| 29 | |||
| 30 | =head2 B<REQUIRED> CreationTime => Str | ||
| 31 | |||
| 32 | A timestamp indicating when SageMaker created the C<FeatureGroup>. | ||
| 33 | |||
| 34 | |||
| 35 | =head2 Description => Str | ||
| 36 | |||
| 37 | A free form description of the feature group. | ||
| 38 | |||
| 39 | |||
| 40 | =head2 B<REQUIRED> EventTimeFeatureName => Str | ||
| 41 | |||
| 42 | The name of the feature that stores the C<EventTime> of a Record in a | ||
| 43 | C<FeatureGroup>. | ||
| 44 | |||
| 45 | An C<EventTime> is a point in time when a new event occurs that | ||
| 46 | corresponds to the creation or update of a C<Record> in a | ||
| 47 | C<FeatureGroup>. All C<Records> in the C<FeatureGroup> have a | ||
| 48 | corresponding C<EventTime>. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 FailureReason => Str | ||
| 52 | |||
| 53 | The reason that the C<FeatureGroup> failed to be replicated in the | ||
| 54 | C<OfflineStore>. This is failure can occur because: | ||
| 55 | |||
| 56 | =over | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | The C<FeatureGroup> could not be created in the C<OfflineStore>. | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | The C<FeatureGroup> could not be deleted from the C<OfflineStore>. | ||
| 65 | |||
| 66 | =back | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> FeatureDefinitions => ArrayRef[L<Paws::SageMaker::FeatureDefinition>] | ||
| 71 | |||
| 72 | A list of the C<Features> in the C<FeatureGroup>. Each feature is | ||
| 73 | defined by a C<FeatureName> and C<FeatureType>. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> FeatureGroupArn => Str | ||
| 77 | |||
| 78 | The Amazon Resource Name (ARN) of the C<FeatureGroup>. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> FeatureGroupName => Str | ||
| 82 | |||
| 83 | he name of the C<FeatureGroup>. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 FeatureGroupStatus => Str | ||
| 87 | |||
| 88 | The status of the feature group. | ||
| 89 | |||
| 90 | Valid values are: C<"Creating">, C<"Created">, C<"CreateFailed">, C<"Deleting">, C<"DeleteFailed"> | ||
| 91 | =head2 B<REQUIRED> NextToken => Str | ||
| 92 | |||
| 93 | A token to resume pagination of the list of C<Features> | ||
| 94 | (C<FeatureDefinitions>). | ||
| 95 | |||
| 96 | |||
| 97 | =head2 OfflineStoreConfig => L<Paws::SageMaker::OfflineStoreConfig> | ||
| 98 | |||
| 99 | The configuration of the C<OfflineStore>, inducing the S3 location of | ||
| 100 | the C<OfflineStore>, Amazon Web Services Glue or Amazon Web Services | ||
| 101 | Hive data catalogue configurations, and the security configuration. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 OfflineStoreStatus => L<Paws::SageMaker::OfflineStoreStatus> | ||
| 105 | |||
| 106 | The status of the C<OfflineStore>. Notifies you if replicating data | ||
| 107 | into the C<OfflineStore> has failed. Returns either: C<Active> or | ||
| 108 | C<Blocked> | ||
| 109 | |||
| 110 | |||
| 111 | =head2 OnlineStoreConfig => L<Paws::SageMaker::OnlineStoreConfig> | ||
| 112 | |||
| 113 | The configuration for the C<OnlineStore>. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RecordIdentifierFeatureName => Str | ||
| 117 | |||
| 118 | The name of the C<Feature> used for C<RecordIdentifier>, whose value | ||
| 119 | uniquely identifies a record stored in the feature store. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 RoleArn => Str | ||
| 123 | |||
| 124 | The Amazon Resource Name (ARN) of the IAM execution role used to | ||
| 125 | persist data into the C<OfflineStore> if an C<OfflineStoreConfig> is | ||
| 126 | provided. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 _request_id => Str | ||
| 130 | |||
| 131 | |||
| 132 | =cut | ||
| 133 | |||
| 134 | 1; |