DescribeFeatureMetadata
Shows the metadata for a feature within a feature group.
Request Syntax
{
"FeatureGroupName": "string",
"FeatureName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- FeatureGroupName
-
The name or Amazon Resource Name (ARN) of the feature group containing the feature.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group\/)?([a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63})Required: Yes
- FeatureName
-
The name of the feature.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63}Required: Yes
Response Syntax
{
"CreationTime": number,
"Description": "string",
"FeatureGroupArn": "string",
"FeatureGroupName": "string",
"FeatureName": "string",
"FeatureType": "string",
"LastModifiedTime": number,
"Parameters": [
{
"Key": "string",
"Value": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
A timestamp indicating when the feature was created.
Type: Timestamp
- Description
-
The description you added to describe the feature.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
.* - FeatureGroupArn
-
The Amazon Resource Number (ARN) of the feature group that contains the feature.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:feature-group/.* - FeatureGroupName
-
The name of the feature group that you've specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([_-]*[a-zA-Z0-9]){0,63} - FeatureName
-
The name of the feature that you've specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]([-_]*[a-zA-Z0-9]){0,63} - FeatureType
-
The data type of the feature.
Type: String
Valid Values:
Integral | Fractional | String - LastModifiedTime
-
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
Type: Timestamp
- Parameters
-
The key-value pairs that you added to describe the feature.
Type: Array of FeatureParameter objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
