ListTagsForResource - AWS Transfer Family

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

ListTagsForResource

列出與您指定的 Amazon Resource Name (ARN) 相關聯的所有標籤。資源可以是使用者、伺服器或角色。

請求語法

{ "Arn": "string", "MaxResults": number, "NextToken": "string" }

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

請求接受下列JSON格式的資料。

Arn

請求與特定 Amazon Resource Name () 相關聯的標籤ARN。ARN 是特定 AWS 資源的識別符,例如伺服器、使用者或角色。

類型:字串

長度限制︰長度下限為 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 格式傳回下列資料。

Arn

ARN 您指定列出 標籤的 。

類型:字串

長度限制︰長度下限為 20。長度上限為 1600。

模式:arn:\S+

NextToken

當您可以從ListTagsForResource呼叫取得其他結果時,輸出中會傳回 NextToken 參數。然後,您可以在後續命令中傳遞至 NextToken 參數,以繼續列出其他標籤。

類型:字串

長度限制:長度下限為 1。長度上限為 6144。

Tags

指派給資源的鍵值對,通常用於分組和搜尋項目。標籤是您定義的中繼資料。

類型:Tag 物件陣列

陣列成員:項目數下限為 1。項目數上限為 50。

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

InternalServiceError

當 AWS Transfer Family 服務發生錯誤時,就會擲回此例外狀況。

HTTP 狀態碼:500

InvalidNextTokenException

傳遞的NextToken參數無效。

HTTP 狀態碼:400

InvalidRequestException

當用戶端提交格式錯誤的請求時,就會擲回此例外狀況。

HTTP 狀態碼:400

ServiceUnavailableException

請求失敗,因為 AWS Transfer Family 服務無法使用。

HTTP 狀態碼:500

範例

範例

下列範例列出具有ARN您指定之 資源的標籤。

請求範例

{ "Arn": "arn:aws:transfer:us-east-1:176354371281:server/s-01234567890abcdef" }

範例

此範例說明 的一個用量 ListTagsForResource。

回應範例

{ "Tags": [ { "Key": "Name", "Value": "MyServer" } ] }

另請參閱

如需在其中一種語言特定 API中使用此功能的詳細資訊 AWS SDKs,請參閱下列內容: