ListTagsForResource - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListTagsForResource

指定した Amazon リソースネーム (ARN) に関連付けられているすべてのタグを一覧表示します。リソースは、ユーザー、サーバー、またはロールのいずれかです。

リクエストの構文

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

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

Arn

特定の Amazon リソースネーム (ARN) に関連付けられているタグをリクエストします。ARN は、AWS サーバー、ユーザー、ロールなど具体的なリソースの識別子です。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 1600 です。

Pattern: arn:\S+

必須:はい

MaxResults

ListTagsForResource クエリへのレスポンスとして返すタグの数を指定します。

型: 整数

有効範囲: 最小値 は 1 です。最大値は 1000 です。

必須: いいえ

NextToken

ListTagsForResource オペレーションからの付加的な結果をリクエストすると、出力で NextToken パラメータが返されます。以降のコマンドで NextToken パラメータを渡すことで、追加のタグを引き続き一覧表示できます。

型: 文字列

長さの制限:最小長は 1 です。最大長は 6,144 です。

必須: いいえ

レスポンスの構文

{ "Arn": "string", "NextToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

Arn

タグを一覧表示するために指定した ARN。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 1600 です。

Pattern: arn:\S+

NextToken

ListTagsForResource からさらに結果を得られる場合、出力で NextToken パラメータが返されます。以降のコマンドで NextToken パラメータを渡すことで、追加のタグを引き続き一覧表示できます。

型: 文字列

長さの制限:最小長は 1 です。最大長は 6,144 です。

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" }

この例では、 の使用方法の 1 つを示します ListTagsForResource。

レスポンス例

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

その他の参照資料

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。