DescribeLocationObjectStorage - AWS DataSync

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

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

DescribeLocationObjectStorage

AWS DataSyncオブジェクトストレージシステムの場所に関するメタデータを返します。

リクエストの構文

{ "LocationArn": "string" }

リクエストパラメータ

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

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

LocationArn

情報が必要なオブジェクトストレージシステムロケーションの 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}$

必須: はい

レスポンスの構文

{ "AccessKey": "string", "AgentArns": [ "string" ], "CreationTime": number, "LocationArn": "string", "LocationUri": "string", "ServerCertificate": blob, "ServerPort": number, "ServerProtocol": "string" }

レスポンス要素

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

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

AccessKey

オブジェクトストレージシステムでの認証に必要なアクセスキー (ユーザー名など)。

型: 文字列

長さの制限: 最小長は 1 です。最大長は 200 です。

Pattern: ^.+$

AgentArns

DataSync ロケーションに安全に接続できるエージェントの 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}$

CreationTime

ロケーションが作成された時刻。

タイプ: Timestamp

LocationArn

オブジェクトストレージシステムロケーションの 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

オブジェクトストレージシステムロケーションの URL。

型: 文字列

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

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

ServerCertificate

DataSync オブジェクトストレージシステムとの安全な認証に使用する自己署名証明書。

型: Base64 でエンコードされたバイナリデータオブジェクト

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

ServerPort

オブジェクトストレージサーバーがインバウンドネットワークトラフィックを受け入れるポート (ポート 443 など)。

型: 整数

有効範囲: 最小値 は 1 最大値は 65,536 です。

ServerProtocol

オブジェクトストレージシステムが通信に使用するプロトコル。

タイプ: 文字列

有効な値: HTTPS | HTTP

エラー

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

InternalException

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

HTTP ステータスコード: 500

InvalidRequestException

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

HTTP ステータスコード: 400

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

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