DescribeAccess - AWS Transfer Family

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

DescribeAccess

特定のファイル転送プロトコル対応サーバー(その ServerId プロパティとその ExternalId で識別) に割り当てられたアクセス権について説明します。

この呼び出しからのレスポンスは、指定した ServerId に関連付けられたアクセス権のプロパティを返します。

リクエストの構文

{ "ExternalId": "string", "ServerId": "string" }

リクエストパラメータ

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

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

ExternalId

ディレクトリ内の特定のグループを識別するために必要な一意の識別子。関連付けするグループのユーザーは、AWS Transfer Family を使用して、有効なプロトコル経由で Amazon S3 または Amazon EFS リソースにアクセスできます。グループ名がわかっている場合は、Windows を使用して次のコマンドを実行することで SID 値を表示できます PowerShell。

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

そのコマンドで、 を Active Directory グループの名前YourGroupNameに置き換えます。

このパラメータの検証に使用される正規表現は、スペースを含まない大文字と小文字の英数字からなる文字列です。下線文字 (_) や =,.@:/- の文字を含めることもできます。

型: 文字列

長さの制限:最小長は 1 です。最大長は 256 です。

パターン:S-1-[\d-]+

必須:はい

ServerId

このアクセス権が割り当てられたサーバーにシステムで割り当てられた一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

Pattern: s-([0-9a-f]{17})

必須:はい

レスポンスの構文

{ "Access": { "ExternalId": "string", "HomeDirectory": "string", "HomeDirectoryMappings": [ { "Entry": "string", "Target": "string", "Type": "string" } ], "HomeDirectoryType": "string", "Policy": "string", "PosixProfile": { "Gid": number, "SecondaryGids": [ number ], "Uid": number }, "Role": "string" }, "ServerId": "string" }

レスポンス要素

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

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

Access

アクセスが接続されているサーバーの外部識別子。

型: DescribedAccess オブジェクト

ServerId

このアクセス権が割り当てられたサーバーにシステムで割り当てられた一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

パターン:s-([0-9a-f]{17})

エラー

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

InternalServiceError

この例外は、AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード:500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード:400

ResourceNotFoundException

この例外は、AWS Transfer Family サービスでリソースが見つからない場合にスローされます。

HTTP ステータスコード:400

ServiceUnavailableException

AWS Transfer Family サービスを利用できないためリクエストは失敗しました。

HTTP ステータスコード:500

その他の参照資料

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