ListTags
Returns the tags for the specified SageMaker resource.
Request Syntax
{
"MaxResults": number
,
"NextToken": "string
",
"ResourceArn": "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.
- MaxResults
-
Maximum number of tags to return.
Type: Integer
Valid Range: Minimum value of 50.
Required: No
- NextToken
-
If the response to the previous
ListTags
request is truncated, SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Required: No
- ResourceArn
-
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z-]*:sagemaker:[a-z0-9-]*:[0-9]{12}:.+
Required: Yes
Response Syntax
{
"NextToken": "string",
"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.
- NextToken
-
If response is truncated, SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
- Tags
-
An array of
Tag
objects, each with a tag key and a value.Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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 Amazon SDKs, see the following: