UpdateFeatureMetadata - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateFeatureMetadata

Updates the description and parameters of the feature group.

Request Syntax

{ "Description": "string", "FeatureGroupName": "string", "FeatureName": "string", "ParameterAdditions": [ { "Key": "string", "Value": "string" } ], "ParameterRemovals": [ "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.

Description

A description that you can write to better describe the feature.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: .*

Required: No

FeatureGroupName

The name or Amazon Resource Name (ARN) of the feature group containing the feature that you're updating.

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 that you're updating.

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

ParameterAdditions

A list of key-value pairs that you can add to better describe the feature.

Type: Array of FeatureParameter objects

Array Members: Maximum number of 25 items.

Required: No

ParameterRemovals

A list of parameter keys that you can specify to remove parameters that describe your feature.

Type: Array of strings

Array Members: Maximum number of 25 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 Amazon SDKs, see the following: