本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
ListTagsForResource
列出与您指定 Amazon 资源名称(ARN)关联的所有标签。该资源可能是用户、服务器或角色。
请求语法
{
"Arn": "string
",
"MaxResults": number
,
"NextToken": "string
"
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
请求接受采用 JSON 格式的以下数据。
- Arn
-
请求与特定 Amazon 资源名称(ARN)关联的标签。ARN 是特定 Amazon 资源(例如服务器、用户或角色)的标识符。
类型:字符串
长度约束:最小长度为 20。长度上限为 1600。
模式:
arn:\S+
必需:是
- MaxResults
-
指定作为对
ListTagsForResource
请求的响应而返回的标签数量。类型:整数
有效范围:最小值为 1。最大值为 1000。
必需:否
- NextToken
-
当您请求
ListTagsForResource
操作的更多结果时,将在输入中返回一个NextToken
参数。然后,您可以向NextToken
参数传入后续命令以继续列出其他标签。类型:字符串
长度限制:长度下限为 1。长度上限为 6144。
必需:否
响应语法
{
"Arn": "string",
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
错误
有关所有操作的常见错误信息,请参阅常见错误。
- InternalServiceError
-
当 Amazon Transfer Family 服务中发生错误时,会引发此异常。
HTTP 状态代码:500
- InvalidNextTokenException
-
传递的
NextToken
参数无效。HTTP 状态代码:400
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ServiceUnavailableException
-
请求失败,因为 Trans Amazon fer Family 服务不可用。
HTTP 状态代码:500
示例
示例
以下示例列出了带有您指定的 ARN 的资源的标签。
示例请求
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef"
}
示例
此示例说明了的一种用法 ListTagsForResource。
示例响应
{
"Tags": [
{
"Key": "Name",
"Value": "MyServer"
}
]
}
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: