翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeLocationFsxWindows
Amazon FSx for Windows File Server ファイルシステムの AWS DataSync 転送場所の設定方法の詳細を提供します。
リクエストの構文
{
"LocationArn": "string"
}リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下のデータを JSON 形式で受け入れます。
- LocationArn
-
FSx for Windows File Server の場所の Amazon リソースネーム (ARN) を指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$必須: はい
レスポンスの構文
{
"CmkSecretConfig": {
"KmsKeyArn": "string",
"SecretArn": "string"
},
"CreationTime": number,
"CustomSecretConfig": {
"SecretAccessRoleArn": "string",
"SecretArn": "string"
},
"Domain": "string",
"LocationArn": "string",
"LocationUri": "string",
"ManagedSecretConfig": {
"SecretArn": "string"
},
"SecurityGroupArns": [ "string" ],
"User": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CmkSecretConfig
-
DataSync が特定のストレージロケーションへのアクセスに使用する など、
PasswordDataSync が管理するシークレットの設定情報をカスタマー管理で記述します AWS KMS key。型: CmkSecretConfig オブジェクト
- CreationTime
-
FSx for Windows File Server の場所が作成された時刻。
タイプ: タイムスタンプ
- CustomSecretConfig
-
DataSync
Passwordが特定のストレージロケーションにアクセスするために使用する など、カスタマーマネージドシークレットの設定情報を、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールで記述します。型: CustomSecretConfig オブジェクト
- Domain
-
FSx for Windows File Server ファイルシステムが属する Microsoft Active Directory ドメインの名前。
タイプ: 文字列
長さの制約: 最大長は 253 です。
パターン:
^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$ - LocationArn
-
FSx for Windows File Server の場所の ARN。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$ - LocationUri
-
FSx for Windows File Server の場所の統一資源識別子 (URI) 。
タイプ: 文字列
長さの制約: 最大長は 4,360 です。
パターン:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ - ManagedSecretConfig
-
DataSync が特定のストレージロケーションにアクセスするために使用する など、
PasswordDataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。型: ManagedSecretConfig オブジェクト
- SecurityGroupArns
-
ファイルシステムの優先サブネットへのアクセスを提供する Amazon EC2 セキュリティグループの ARN。
ファイルシステムアクセスのセキュリティグループの設定については、「Amazon FSx for Windows File Server ユーザーガイド」を参照してください。
タイプ: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 5 項目です。
長さの制約: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$ - User
-
FSx for Windows File Server ファイルシステムをマウントし、アクセスするためのアクセス許可を持つユーザー。
タイプ: 文字列
長さの制約: 最大長は 104 です。
パターン:
^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
