CreateLocationSmb - AWS DataSync

2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support

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

CreateLocationSmb

AWS DataSyncデータ転送に使用できるサーバーメッセージブロック (SMB) ファイルサーバーのエンドポイントを作成します。

始める前に、が SMB DataSync ファイルサーバーにアクセスする方法を理解していることを確認してください

リクエストの構文

{ "AgentArns": [ "string" ], "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" }

リクエストパラメータ

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

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

AgentArns

SMB DataSync ファイルサーバーに接続するエージェント (1 つまたは複数) を指定します。Amazon リソースネーム (ARN) を使用してエージェントを指定します。

型: 文字列の配列

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

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

パターン: ^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}$

必須: はい

Domain

SMB ファイルサーバーが属する Windows ドメイン名を指定します。

環境内に複数のドメインがある場合、このパラメータを設定することで、 DataSync 確実に適切なファイルサーバーに接続できます。

詳細については、SMB ユーザーロールに「必要なアクセス許可」を参照してください。

型: 文字列

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

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

必須: いいえ

MountOptions

SMB DataSync ファイルサーバーへのアクセスに使用する SMB プロトコルのバージョンを指定します。

型: SmbMountOptions オブジェクト

必須: いいえ

Password

SMB ファイルサーバーをマウントでき、転送に含まれるファイルやフォルダーにアクセスする権限を持つユーザーのパスワードを指定します。

詳細については、SMB ユーザーロールに「必要なアクセス許可」を参照してください。

型: 文字列

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

パターン: ^.{0,104}$

必須: はい

ServerHostname

DataSync エージェントがマウントする SMB ファイルサーバのドメインネームサービス (DNS) 名または IP アドレスを指定します。

注記

IP バージョン 6 (IPv6) アドレスは指定できません。

型: 文字列

長さの制限: 最大長は 255 です。

パターン: ^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$

必須: はい

Subdirectory

SMB ファイルサーバーによってエクスポートされ、 DataSyncデータの読み取りまたは書き込みが行われる共有の名前を指定します。共有パスにはサブディレクトリ (例:) を含めることができます。/path/to/subdirectoryネットワーク内の他の SMB クライアントもこのパスをマウントできることを確認してください。

指定したサブディレクトリ内のすべてのデータをコピーするには、SMB 共有をマウントし、 DataSync そのすべてのデータにアクセスできる必要があります。詳細については、SMB ユーザーロールに「必要なアクセス許可」を参照してください。

型: 文字列

長さの制限: 最大長は 4,096 です。

パターン: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

必須: はい

Tags

AWS リソースの分類、フィルタリング、および検索に役立つラベルを指定します。少なくても場所の名前タグを作成することを推奨します。

型: TagListEntry オブジェクトの配列

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

必須: いいえ

User

SMB ファイルサーバーをマウントでき、転送に含まれるファイルとフォルダーにアクセスする権限を持つユーザー名を指定します。

転送に適したアクセスレベルを持つユーザーを選択する方法については、「SMB ロケーションに必要な権限」を参照してください。

型: 文字列

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

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

必須: はい

レスポンスの構文

{ "LocationArn": "string" }

レスポンス要素

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

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

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

エラー

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

InternalException

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

HTTP ステータスコード: 500

InvalidRequestException

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

HTTP ステータスコード: 400

リクエスト例

次の例では、SMB ファイルサーバーの場所を作成します。

{ "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" }

レスポンス例

レスポンスは、SMB ファイルサーバーのロケーション ARN を返します。

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

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

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