SageMaker / Client / describe_feature_metadata

describe_feature_metadata#

SageMaker.Client.describe_feature_metadata(**kwargs)#

Shows the metadata for a feature within a feature group.

Request Syntax

response = client.describe_feature_metadata(
    FeatureGroupName='string',
    FeatureName='string'
)

Parameters:

FeatureGroupName (string) –
[REQUIRED]

The name of the feature group containing the feature.
FeatureName (string) –
[REQUIRED]

The name of the feature.

Return type:

dict

Returns:

Response Syntax

{
    'FeatureGroupArn': 'string',
    'FeatureGroupName': 'string',
    'FeatureName': 'string',
    'FeatureType': 'Integral'|'Fractional'|'String',
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'Description': 'string',
    'Parameters': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) –
- FeatureGroupArn (string) –
  
  The Amazon Resource Number (ARN) of the feature group that contains the feature.
- FeatureGroupName (string) –
  
  The name of the feature group that you’ve specified.
- FeatureName (string) –
  
  The name of the feature that you’ve specified.
- FeatureType (string) –
  
  The data type of the feature.
- CreationTime (datetime) –
  
  A timestamp indicating when the feature was created.
- LastModifiedTime (datetime) –
  
  A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you
- Description (string) –
  
  The description you added to describe the feature.
- Parameters (list) –
  
  The key-value pairs that you added to describe the feature.
  - (dict) –
    
    A key-value pair that you specify to describe the feature.
    - Key (string) –
      
      A key that must contain a value to describe the feature.
    - Value (string) –
      
      The value that belongs to a key.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound