

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

# DescribeLocationSmb
<a name="API_DescribeLocationSmb"></a>

Server Message Block (SMB) ファイルサーバーの AWS DataSync 転送場所の設定方法の詳細を提供します。

## リクエストの構文
<a name="API_DescribeLocationSmb_RequestSyntax"></a>

```
{
   "LocationArn": "string"
}
```

## リクエストパラメーター
<a name="API_DescribeLocationSmb_RequestParameters"></a>

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

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

 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) **   <a name="DataSync-DescribeLocationSmb-request-LocationArn"></a>
情報が必要な SMB の場所の 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}$`   
必須: はい

## レスポンスの構文
<a name="API_DescribeLocationSmb_ResponseSyntax"></a>

```
{
   "AgentArns": [ "string" ],
   "AuthenticationType": "string",
   "CmkSecretConfig": { 
      "KmsKeyArn": "string",
      "SecretArn": "string"
   },
   "CreationTime": number,
   "CustomSecretConfig": { 
      "SecretAccessRoleArn": "string",
      "SecretArn": "string"
   },
   "DnsIpAddresses": [ "string" ],
   "Domain": "string",
   "KerberosPrincipal": "string",
   "LocationArn": "string",
   "LocationUri": "string",
   "ManagedSecretConfig": { 
      "SecretArn": "string"
   },
   "MountOptions": { 
      "Version": "string"
   },
   "User": "string"
}
```

## レスポンス要素
<a name="API_DescribeLocationSmb_ResponseElements"></a>

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

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

 ** [AgentArns](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AgentArns"></a>
SMB ファイルサーバーに接続できる DataSync エージェントの ARN。  
タイプ: 文字列の配列  
配列メンバー: 最小数は 1 項目です。最大 8 項目。  
長さの制約: 最大長は 128 です。  
パターン: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$` 

 ** [AuthenticationType](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-AuthenticationType"></a>
DataSync が SMB ファイルサーバーへの接続に使用する認証プロトコルを指定します。  
型: 文字列  
有効な値：`NTLM | KERBEROS`

 ** [CmkSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CmkSecretConfig"></a>
DataSync が特定のストレージロケーションへのアクセスに使用する `Password`や など、`KerberosKeytab`DataSync が管理するシークレットの設定情報をカスタマー管理で記述します AWS KMS key。  
型: [CmkSecretConfig](API_CmkSecretConfig.md) オブジェクト

 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CreationTime"></a>
SMB の場所が作成された時刻。  
タイプ: タイムスタンプ

 ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-CustomSecretConfig"></a>
DataSync `KerberosKeytab`が特定のストレージロケーションにアクセスするために使用する `Password`や など、カスタマーマネージドシークレットの設定情報を、シークレットへのアクセスを提供するカスタマーマネージド AWS Identity and Access Management (IAM) ロールで記述します。  
型: [CustomSecretConfig](API_CustomSecretConfig.md) オブジェクト

 ** [DnsIpAddresses](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-DnsIpAddresses"></a>
SMB ファイルサーバーが属する DNS サーバーの IPv4 または IPv6 アドレス。この要素は、`AuthenticationType` が `KERBEROS` に設定されている場合にのみ適用されます。  
型: 文字列の配列  
配列メンバー: 最大数は 2 項目です。  
長さの制限: 最小長は 7 です。最大長は 39 です。  
パターン: `\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` 

 ** [Domain](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-Domain"></a>
SMB ファイルサーバーが属する Windows ドメインの名前。この要素は、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。  
タイプ: 文字列  
長さの制約: 最大長は 253 です。  
パターン: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 

 ** [KerberosPrincipal](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-KerberosPrincipal"></a>
SMB ファイルサーバーのファイル、フォルダ、ファイルメタデータにアクセスするためのアクセス許可を持つ Kerberos プリンシパル。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 256 です。  
パターン: `^.+$` 

 ** [LocationArn](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationArn"></a>
SMB の場所の 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](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-LocationUri"></a>
SMB の場所の URI。  
タイプ: 文字列  
長さの制約: 最大長は 4,360 です。  
パターン: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` 

 ** [ManagedSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-ManagedSecretConfig"></a>
DataSync が特定のストレージロケーションにアクセスするために使用する `Password`や など、`KerberosKeytab`DataSync が管理するシークレットの設定情報について説明します。DataSync AWSは、デフォルトマネージド KMS キーを使用してこのシークレットを暗号化します AWS Secrets Manager。  
型: [ManagedSecretConfig](API_ManagedSecretConfig.md) オブジェクト

 ** [MountOptions](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-MountOptions"></a>
DataSync が SMB ファイルサーバーにアクセスするために使用する SMB プロトコルバージョン。  
型: [SmbMountOptions](API_SmbMountOptions.md) オブジェクト

 ** [User](#API_DescribeLocationSmb_ResponseSyntax) **   <a name="DataSync-DescribeLocationSmb-response-User"></a>
SMB ファイルサーバー内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるユーザー。この要素は、`AuthenticationType` が `NTLM` に設定されている場合にのみ適用されます。  
タイプ: 文字列  
長さの制約: 最大長は 104 です。  
パターン: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 

## エラー
<a name="API_DescribeLocationSmb_Errors"></a>

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

 ** InternalException **   
この例外は、 AWS DataSync サービスでエラーが発生した場合にスローされます。  
HTTP ステータスコード: 500

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

## 例
<a name="API_DescribeLocationSmb_Examples"></a>

### 例
<a name="API_DescribeLocationSmb_Example_1"></a>

この例は、DescribeLocationSmb の使用方法を 1 つ示しています。

#### リクエスト例
<a name="API_DescribeLocationSmb_Example_1_Request"></a>

```
{
  "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"
}
```

### 例
<a name="API_DescribeLocationSmb_Example_2"></a>

この例は、DescribeLocationSmb の使用方法を 1 つ示しています。

#### レスポンス例
<a name="API_DescribeLocationSmb_Example_2_Response"></a>

```
{
   "AgentArns":[
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145",
      "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f"
   ],
   "CreationTime":"1532660733.39",
   "Domain":"AMAZON",
   "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49",
   "LocationUri":"smb://hostname.amazon.com/share",
   "MountOptions":{
      "Version":"SMB3"
   },
   "User":"user-1"
}
```

## 以下の資料も参照してください。
<a name="API_DescribeLocationSmb_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationSmb) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationSmb) 