AddTags
Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.
Each tag consists of a key and an optional value. Tag keys must be unique per
resource. For more information about tags, see For more information, see AWS
Tagging Strategies
Tags that you add to a hyperparameter tuning job by calling this API are also
added to any training jobs that the hyperparameter tuning job launches after you
call this API, but not to training jobs that the hyperparameter tuning job launched
before you called this API. To make sure that the tags associated with a
hyperparameter tuning job are also added to all training jobs that the
hyperparameter tuning job launches, add the tags when you first create the tuning
job by specifying them in the Tags
parameter of CreateHyperParameterTuningJob
Request Syntax
{
"ResourceArn": "string
",
"Tags": [
{
"Key": "string
",
"Value": "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.
- ResourceArn
-
The Amazon Resource Name (ARN) of the resource that you want to tag.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+
Required: Yes
- Tags
-
An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
Response Syntax
{
"Tags": [
{
"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.
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: