The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::SageMaker::CreateFeatureGroup - Arguments for method CreateFeatureGroup on Paws::SageMaker

DESCRIPTION

This class represents the parameters used for calling the method CreateFeatureGroup on the Amazon SageMaker Service service. Use the attributes of this class as arguments to method CreateFeatureGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFeatureGroup.

SYNOPSIS

    my $api.sagemaker = Paws->service('SageMaker');
    my $CreateFeatureGroupResponse = $api . sagemaker->CreateFeatureGroup(
      EventTimeFeatureName => 'MyFeatureName',
      FeatureDefinitions   => [
        {
          FeatureName => 'MyFeatureName',    # min: 1, max: 64
          FeatureType =>
            'Integral',    # values: Integral, Fractional, String; OPTIONAL
        },
        ...
      ],
      FeatureGroupName            => 'MyFeatureGroupName',
      RecordIdentifierFeatureName => 'MyFeatureName',
      Description                 => 'MyDescription',        # OPTIONAL
      OfflineStoreConfig          => {
        S3StorageConfig => {
          S3Uri               => 'MyS3Uri',       # max: 1024
          KmsKeyId            => 'MyKmsKeyId',    # max: 2048; OPTIONAL
          ResolvedOutputS3Uri => 'MyS3Uri',       # max: 1024
        },
        DataCatalogConfig => {
          Catalog   => 'MyCatalog',               # min: 1, max: 255
          Database  => 'MyDatabase',              # min: 1, max: 255
          TableName => 'MyTableName',             # min: 1, max: 255

        },    # OPTIONAL
        DisableGlueTableCreation => 1,    # OPTIONAL
      },    # OPTIONAL
      OnlineStoreConfig => {
        EnableOnlineStore => 1,    # OPTIONAL
        SecurityConfig    => {
          KmsKeyId => 'MyKmsKeyId',    # max: 2048; OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      RoleArn => 'MyRoleArn',    # OPTIONAL
      Tags    => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # max: 256

        },
        ...
      ],    # OPTIONAL
    );

    # Results:
    my $FeatureGroupArn = $CreateFeatureGroupResponse->FeatureGroupArn;

    # Returns a L<Paws::SageMaker::CreateFeatureGroupResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/api.sagemaker/CreateFeatureGroup

ATTRIBUTES

Description => Str

A free-form description of a FeatureGroup.

REQUIRED EventTimeFeatureName => Str

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.

REQUIRED FeatureDefinitions => ArrayRef[Paws::SageMaker::FeatureDefinition]

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

REQUIRED FeatureGroupName => Str

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.

OfflineStoreConfig => Paws::SageMaker::OfflineStoreConfig

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 cataolgue.

  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore.

To learn more about this parameter, see OfflineStoreConfig.

OnlineStoreConfig => Paws::SageMaker::OnlineStoreConfig

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig; the default value is False.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

REQUIRED RecordIdentifierFeatureName => Str

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.

RoleArn => Str

The Amazon Resource Name (ARN) of the IAM execution role used to persist data into the OfflineStore if an OfflineStoreConfig is provided.

Tags => ArrayRef[Paws::SageMaker::Tag]

Tags used to identify Features in each FeatureGroup.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateFeatureGroup in Paws::SageMaker

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues