:doc:`SageMaker <../../sagemaker>` / Client / create_feature_group

********************
create_feature_group
********************



.. py:method:: SageMaker.Client.create_feature_group(**kwargs)

  

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

   

  .. warning::

     

    You must include at least one of ``OnlineStoreConfig`` and ``OfflineStoreConfig`` to create a ``FeatureGroup``.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateFeatureGroup>`_  


  **Request Syntax**
  ::

    response = client.create_feature_group(
        FeatureGroupName='string',
        RecordIdentifierFeatureName='string',
        EventTimeFeatureName='string',
        FeatureDefinitions=[
            {
                'FeatureName': 'string',
                'FeatureType': 'Integral'|'Fractional'|'String',
                'CollectionType': 'List'|'Set'|'Vector',
                'CollectionConfig': {
                    'VectorConfig': {
                        'Dimension': 123
                    }
                }
            },
        ],
        OnlineStoreConfig={
            'SecurityConfig': {
                'KmsKeyId': 'string'
            },
            'EnableOnlineStore': True|False,
            'TtlDuration': {
                'Unit': 'Seconds'|'Minutes'|'Hours'|'Days'|'Weeks',
                'Value': 123
            },
            'StorageType': 'Standard'|'InMemory'
        },
        OfflineStoreConfig={
            'S3StorageConfig': {
                'S3Uri': 'string',
                'KmsKeyId': 'string',
                'ResolvedOutputS3Uri': 'string'
            },
            'DisableGlueTableCreation': True|False,
            'DataCatalogConfig': {
                'TableName': 'string',
                'Catalog': 'string',
                'Database': 'string'
            },
            'TableFormat': 'Default'|'Glue'|'Iceberg'
        },
        ThroughputConfig={
            'ThroughputMode': 'OnDemand'|'Provisioned',
            'ProvisionedReadCapacityUnits': 123,
            'ProvisionedWriteCapacityUnits': 123
        },
        RoleArn='string',
        Description='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type FeatureGroupName: string
  :param FeatureGroupName: **[REQUIRED]** 

    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 with an alphanumeric character.
     
    * Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
    

    

  
  :type RecordIdentifierFeatureName: string
  :param RecordIdentifierFeatureName: **[REQUIRED]** 

    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 with an alphanumeric character.
     
    * Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.
    

    

  
  :type EventTimeFeatureName: string
  :param EventTimeFeatureName: **[REQUIRED]** 

    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.
    

    

  
  :type FeatureDefinitions: list
  :param FeatureDefinitions: **[REQUIRED]** 

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

    

  
    - *(dict) --* 

      A list of features. You must include ``FeatureName`` and ``FeatureType``. Valid feature ``FeatureType``s are ``Integral``, ``Fractional`` and ``String``.

      

    
      - **FeatureName** *(string) --* **[REQUIRED]** 

        The name of a feature. The type must be a string. ``FeatureName`` cannot be any of the following: ``is_deleted``, ``write_time``, ``api_invocation_time``.

         

        The name:

         

        
        * Must start with an alphanumeric character.
         
        * Can only include alphanumeric characters, underscores, and hyphens. Spaces are not allowed.
        

        

      
      - **FeatureType** *(string) --* **[REQUIRED]** 

        The value type of a feature. Valid values are Integral, Fractional, or String.

        

      
      - **CollectionType** *(string) --* 

        A grouping of elements where each element within the collection must have the same feature type ( ``String``, ``Integral``, or ``Fractional``).

         

        
        * ``List``: An ordered collection of elements.
         
        * ``Set``: An unordered collection of unique elements.
         
        * ``Vector``: A specialized list that represents a fixed-size array of elements. The vector dimension is determined by you. Must have elements with fractional feature types.
        

        

      
      - **CollectionConfig** *(dict) --* 

        Configuration for your collection.

        .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``VectorConfig``. 

      
        - **VectorConfig** *(dict) --* 

          Configuration for your vector collection type.

           

          
          * ``Dimension``: The number of elements in your vector.
          

          

        
          - **Dimension** *(integer) --* **[REQUIRED]** 

            The number of elements in your vector.

            

          
        
      
    

  :type OnlineStoreConfig: dict
  :param OnlineStoreConfig: 

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

    

  
    - **SecurityConfig** *(dict) --* 

      Use to specify KMS Key ID ( ``KMSKeyId``) for at-rest encryption of your ``OnlineStore``.

      

    
      - **KmsKeyId** *(string) --* 

        The Amazon Web Services Key Management Service (KMS) key ARN that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

         

        The caller (either user or IAM role) of ``CreateFeatureGroup`` must have below permissions to the ``OnlineStore`` ``KmsKeyId``:

         

        
        * ``"kms:Encrypt"``
         
        * ``"kms:Decrypt"``
         
        * ``"kms:DescribeKey"``
         
        * ``"kms:CreateGrant"``
         
        * ``"kms:RetireGrant"``
         
        * ``"kms:ReEncryptFrom"``
         
        * ``"kms:ReEncryptTo"``
         
        * ``"kms:GenerateDataKey"``
         
        * ``"kms:ListAliases"``
         
        * ``"kms:ListGrants"``
         
        * ``"kms:RevokeGrant"``
        

         

        The caller (either user or IAM role) to all DataPlane operations ( ``PutRecord``, ``GetRecord``, ``DeleteRecord``) must have the following permissions to the ``KmsKeyId``:

         

        
        * ``"kms:Decrypt"``
        

        

      
    
    - **EnableOnlineStore** *(boolean) --* 

      Turn ``OnlineStore`` off by specifying ``False`` for the ``EnableOnlineStore`` flag. Turn ``OnlineStore`` on by specifying ``True`` for the ``EnableOnlineStore`` flag.

       

      The default value is ``False``.

      

    
    - **TtlDuration** *(dict) --* 

      Time to live duration, where the record is hard deleted after the expiration time is reached; ``ExpiresAt`` = ``EventTime`` + ``TtlDuration``. For information on HardDelete, see the `DeleteRecord <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html>`__ API in the Amazon SageMaker API Reference guide.

      

    
      - **Unit** *(string) --* 

        ``TtlDuration`` time unit.

        

      
      - **Value** *(integer) --* 

        ``TtlDuration`` time value.

        

      
    
    - **StorageType** *(string) --* 

      Option for different tiers of low latency storage for real-time data retrieval.

       

      
      * ``Standard``: A managed low latency data store for feature groups.
       
      * ``InMemory``: A managed data store for feature groups that supports very low latency retrieval.
      

      

    
  
  :type OfflineStoreConfig: dict
  :param 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 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>`__.

    

  
    - **S3StorageConfig** *(dict) --* **[REQUIRED]** 

      The Amazon Simple Storage (Amazon S3) location of ``OfflineStore``.

      

    
      - **S3Uri** *(string) --* **[REQUIRED]** 

        The S3 URI, or location in Amazon S3, of ``OfflineStore``.

         

        S3 URIs have a format similar to the following: ``s3://example-bucket/prefix/``.

        

      
      - **KmsKeyId** *(string) --* 

        The Amazon Web Services Key Management Service (KMS) key ARN of the key used to encrypt any objects written into the ``OfflineStore`` S3 location.

         

        The IAM ``roleARN`` that is passed as a parameter to ``CreateFeatureGroup`` must have below permissions to the ``KmsKeyId``:

         

        
        * ``"kms:GenerateDataKey"``
        

        

      
      - **ResolvedOutputS3Uri** *(string) --* 

        The S3 path where offline records are written.

        

      
    
    - **DisableGlueTableCreation** *(boolean) --* 

      Set to ``True`` to disable the automatic creation of an Amazon Web Services Glue table when configuring an ``OfflineStore``. If set to ``False``, Feature Store will name the ``OfflineStore`` Glue table following `Athena's naming recommendations <https://docs.aws.amazon.com/athena/latest/ug/tables-databases-columns-names.html>`__.

       

      The default value is ``False``.

      

    
    - **DataCatalogConfig** *(dict) --* 

      The meta data of the Glue table that is autogenerated when an ``OfflineStore`` is created.

      

    
      - **TableName** *(string) --* **[REQUIRED]** 

        The name of the Glue table.

        

      
      - **Catalog** *(string) --* **[REQUIRED]** 

        The name of the Glue table catalog.

        

      
      - **Database** *(string) --* **[REQUIRED]** 

        The name of the Glue table database.

        

      
    
    - **TableFormat** *(string) --* 

      Format for the offline store table. Supported formats are Glue (Default) and `Apache Iceberg <https://iceberg.apache.org/>`__.

      

    
  
  :type ThroughputConfig: dict
  :param ThroughputConfig: 

    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.

    

  
    - **ThroughputMode** *(string) --* **[REQUIRED]** 

      The mode used for your feature group throughput: ``ON_DEMAND`` or ``PROVISIONED``.

      

    
    - **ProvisionedReadCapacityUnits** *(integer) --* 

      For provisioned feature groups with online store enabled, this indicates the read throughput you are billed for and can consume without throttling.

       

      This field is not applicable for on-demand feature groups.

      

    
    - **ProvisionedWriteCapacityUnits** *(integer) --* 

      For provisioned feature groups, this indicates the write throughput you are billed for and can consume without throttling.

       

      This field is not applicable for on-demand feature groups.

      

    
  
  :type RoleArn: string
  :param RoleArn: 

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

    

  
  :type Description: string
  :param Description: 

    A free-form description of a ``FeatureGroup``.

    

  
  :type Tags: list
  :param Tags: 

    Tags used to identify ``Features`` in each ``FeatureGroup``.

    

  
    - *(dict) --* 

      A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.

       

      You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see `AddTags <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html>`__.

       

      For more information on adding metadata to your Amazon Web Services resources with tagging, see `Tagging Amazon Web Services resources <https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html>`__. For advice on best practices for managing Amazon Web Services resources with tagging, see `Tagging Best Practices\: Implement an Effective Amazon Web Services Resource Tagging Strategy <https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf>`__.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

        The tag key. Tag keys must be unique per resource.

        

      
      - **Value** *(string) --* **[REQUIRED]** 

        The tag value.

        

      
    

  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'FeatureGroupArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FeatureGroupArn** *(string) --* 

        The Amazon Resource Name (ARN) of the ``FeatureGroup``. This is a unique identifier for the feature group.

        
  
  **Exceptions**
  
  *   :py:class:`SageMaker.Client.exceptions.ResourceInUse`

  
  *   :py:class:`SageMaker.Client.exceptions.ResourceLimitExceeded`

  