2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS Support
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeLocationEfs
Amazon EFS AWS DataSync ファイルシステムの場所に関するメタデータを返します。
リクエストの構文
{
"LocationArn": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- LocationArn
-
情報が必要な Amazon EFS ファイルシステムの場所の 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}$必須: はい
レスポンスの構文
{
"AccessPointArn": "string",
"CreationTime": number,
"Ec2Config": {
"SecurityGroupArns": [ "string" ],
"SubnetArn": "string"
},
"FileSystemAccessRoleArn": "string",
"InTransitEncryption": "string",
"LocationArn": "string",
"LocationUri": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AccessPointArn
-
Amazon EFS DataSync ファイルシステムへのアクセスに使用するアクセスポイントの ARN。
型: 文字列
長さの制限: 最大長は 128 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$ - CreationTime
-
ロケーションが作成された時刻。
タイプ: Timestamp
- Ec2Config
-
AWS DataSync が Amazon EFS ファイルシステムにアクセスするために使用するサブネットとセキュリティグループ。
型: Ec2Config オブジェクト
- FileSystemAccessRoleArn
-
Amazon EFS DataSync ファイルシステムをマウントするときに引き受ける AWS Identity and Access Management (IAM) ロール。
型: 文字列
長さの制限: 最大長は 2,048 です。
パターン:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$ - InTransitEncryption
-
Amazon EFS ファイルシステムとの間でデータをコピーするときに、トランスポート層セキュリティ (TLS) DataSync 暗号化を使用するかどうかを説明します。
タイプ: 文字列
有効な値:
NONE | TLS1_2 - LocationArn
-
Amazon EFS ファイルシステムのロケーションの 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
-
Amazon EFS ファイルシステムの場所の URL。
型: 文字列
長さの制約:最大長は 4360 です。
パターン:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
リクエスト例
次の例は、特定の Amazon EFS ファイルシステムの場所に関する情報を取得する方法を示しています。
{ "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678" }
レスポンス例
次の例では、Amazon EFS ファイルシステムの場所の詳細を返します。
{ "CreationTime": 1653319021.353, "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/" }
応答例:制限付きの Amazon EFS ファイルシステムの場所の説明
次の例では、、、InTransitEncryption要素を含む、アクセスが制限されている Amazon EFS ファイルシステムの場所の詳細を返します。AccessPointArn FileSystemAccessRoleArn
{ "CreationTime": 1653319021.353, "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0", "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew", "InTransitEncryption": "TLS1_2", "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/", "Subdirectory": "/mount/path", "Tags": [{ "Key": "Name", "Value": "ElasticFileSystem-1" }] }
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
