1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package sagemaker
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Create a new FeatureGroup . A FeatureGroup is a group of Features defined in
// the FeatureStore to describe a Record . The FeatureGroup defines the schema and
// features contained in the FeatureGroup . A FeatureGroup definition is composed
// of a list of Features , a RecordIdentifierFeatureName , an EventTimeFeatureName
// and configurations for its OnlineStore and OfflineStore . Check Amazon Web
// Services service quotas (https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
// to see the FeatureGroup s quota for your Amazon Web Services account. Note that
// it can take approximately 10-15 minutes to provision an OnlineStore FeatureGroup
// with the InMemory StorageType . You must include at least one of
// OnlineStoreConfig and OfflineStoreConfig to create a FeatureGroup .
func (c *Client) CreateFeatureGroup(ctx context.Context, params *CreateFeatureGroupInput, optFns ...func(*Options)) (*CreateFeatureGroupOutput, error) {
if params == nil {
params = &CreateFeatureGroupInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateFeatureGroup", params, optFns, c.addOperationCreateFeatureGroupMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateFeatureGroupOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateFeatureGroupInput struct {
// The name of the feature that stores the EventTime of a Record in a FeatureGroup
// . An EventTime is a point in time when a new event occurs that corresponds to
// the creation or update of a Record in a FeatureGroup . All Records in the
// FeatureGroup must have a corresponding EventTime . An EventTime can be a String
// or Fractional .
// - Fractional : EventTime feature values must be a Unix timestamp in seconds.
// - String : EventTime feature values must be an ISO-8601 string in the format.
// The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and
// yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy , MM , and dd represent the year, month,
// and day respectively and HH , mm , ss , and if applicable, SSS represent the
// hour, month, second and milliseconds respsectively. 'T' and Z are constants.
//
// This member is required.
EventTimeFeatureName *string
// A list of Feature names and types. Name and Type is compulsory per Feature .
// Valid feature FeatureType s are Integral , Fractional and String . FeatureName s
// cannot be any of the following: is_deleted , write_time , api_invocation_time
// You can create up to 2,500 FeatureDefinition s per FeatureGroup .
//
// This member is required.
FeatureDefinitions []types.FeatureDefinition
// The name of the FeatureGroup . The name must be unique within an Amazon Web
// Services Region in an Amazon Web Services account. The name:
// - Must start and end with an alphanumeric character.
// - Can only contain alphanumeric character and hyphens. Spaces are not
// allowed.
//
// This member is required.
FeatureGroupName *string
// The name of the Feature whose value uniquely identifies a Record defined in the
// FeatureStore . Only the latest record per identifier value will be stored in the
// OnlineStore . RecordIdentifierFeatureName must be one of feature definitions'
// names. You use the RecordIdentifierFeatureName to access data in a FeatureStore
// . This name:
// - Must start and end with an alphanumeric character.
// - Can only contains alphanumeric characters, hyphens, underscores. Spaces are
// not allowed.
//
// This member is required.
RecordIdentifierFeatureName *string
// A free-form description of a FeatureGroup .
Description *string
// Use this to configure an OfflineFeatureStore . This parameter allows you to
// specify:
// - The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore .
// - A configuration for an Amazon Web Services Glue or Amazon Web Services Hive
// data catalog.
// - An KMS encryption key to encrypt the Amazon S3 location used for
// OfflineStore . If KMS encryption key is not specified, by default we encrypt
// all data at rest using Amazon Web Services KMS key. By defining your
// bucket-level key (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html)
// for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99
// percent.
// - Format for the offline store table. Supported formats are Glue (Default)
// and Apache Iceberg (https://iceberg.apache.org/) .
// To learn more about this parameter, see OfflineStoreConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html)
// .
OfflineStoreConfig *types.OfflineStoreConfig
// You can turn the OnlineStore on or off by specifying True for the
// EnableOnlineStore flag in OnlineStoreConfig . You can also include an Amazon Web
// Services KMS key ID ( KMSKeyId ) for at-rest encryption of the OnlineStore . The
// default value is False .
OnlineStoreConfig *types.OnlineStoreConfig
// The Amazon Resource Name (ARN) of the IAM execution role used to persist data
// into the OfflineStore if an OfflineStoreConfig is provided.
RoleArn *string
// Tags used to identify Features in each FeatureGroup .
Tags []types.Tag
// Used to set feature group throughput configuration. There are two modes:
// ON_DEMAND and PROVISIONED . With on-demand mode, you are charged for data reads
// and writes that your application performs on your feature group. You do not need
// to specify read and write throughput because Feature Store accommodates your
// workloads as they ramp up and down. You can switch a feature group to on-demand
// only once in a 24 hour period. With provisioned throughput mode, you specify the
// read and write capacity per second that you expect your application to require,
// and you are billed based on those limits. Exceeding provisioned throughput will
// result in your requests being throttled. Note: PROVISIONED throughput mode is
// supported only for feature groups that are offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType)
// tier online store.
ThroughputConfig *types.ThroughputConfig
noSmithyDocumentSerde
}
type CreateFeatureGroupOutput struct {
// The Amazon Resource Name (ARN) of the FeatureGroup . This is a unique identifier
// for the feature group.
//
// This member is required.
FeatureGroupArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateFeatureGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateFeatureGroup{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateFeatureGroup{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateFeatureGroup"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateFeatureGroupValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateFeatureGroup(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateFeatureGroup(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateFeatureGroup",
}
}
|