DescribeLocationSmb - AWS DataSync

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

DescribeLocationSmb

サーバーメッセージブロック (SMB) ファイルサーバーの AWS DataSync 転送場所の設定方法の詳細を提供します。

リクエストの構文

{ "LocationArn": "string" }

リクエストパラメータ

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

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

LocationArn

情報が必要な SMB の場所の Amazon リソースネーム (ARN) を指定します。

タイプ: 文字列

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

必須: はい

レスポンスの構文

{ "AgentArns": [ "string" ], "AuthenticationType": "string", "CreationTime": number, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosPrincipal": "string", "LocationArn": "string", "LocationUri": "string", "MountOptions": { "Version": "string" }, "User": "string" }

レスポンス要素

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

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

AgentArns

SMB ファイルサーバーに接続できる DataSync エージェントの ARN。

タイプ: 文字列の配列

配列メンバー: 最小数は 1 項目です。最大数は 4 項目です。

長さの制約: 最大長は 128 です。

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$

AuthenticationType

DataSync が SMB ファイルサーバーに接続するために使用する認証プロトコル。

タイプ: 文字列

有効な値: NTLM | KERBEROS

CreationTime

SMB の場所が作成された時刻。

タイプ: タイムスタンプ

DnsIpAddresses

SMB ファイルサーバーが属する DNS サーバーの IPv4 アドレス。この要素は、 AuthenticationTypeが に設定されている場合にのみ適用されますKERBEROS

タイプ: 文字列の配列

配列メンバー: 最大数は 2 項目です。

長さの制限: 最小長は 7 です。最大長は 15 です。

パターン: \A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z

Domain

SMB ファイルサーバーが属する Windows ドメインの名前。この要素は、 AuthenticationTypeが に設定されている場合にのみ適用されますNTLM

タイプ: 文字列

長さの制約: 最大長は 253 です。

パターン: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

KerberosPrincipal

SMB ファイルサーバーのファイル、フォルダ、およびファイルメタデータにアクセスする権限を持つ Kerberos プリンシパル。

タイプ: 文字列

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

Pattern: ^.+$

LocationArn

SMB の場所の ARN。

タイプ: 文字列

長さの制約: 最大長は 128 です。

パターン: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

LocationUri

SMB の場所の URI。

タイプ: 文字列

長さの制約: 最大長は 4,360 です。

パターン: ^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$

MountOptions

DataSync が SMB ファイルサーバーにアクセスするために使用する SMB プロトコルバージョン。

型: SmbMountOptions オブジェクト

User

SMB ファイルサーバー内のファイル、フォルダ、ファイルメタデータをマウントしてアクセスできるユーザー。この要素は、 AuthenticationTypeが に設定されている場合にのみ適用されますNTLM

タイプ: 文字列

長さの制約: 最大長は 104 です。

パターン: ^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$

エラー

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

InternalException

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

HTTP ステータスコード: 500

InvalidRequestException

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

HTTP ステータスコード: 400

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

リクエスト例

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

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

レスポンス例

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

以下の資料も参照してください。

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