2023 年 12 月 7 日より、バージョン 1 DataSync のエージェントは廃止されます。 DataSync コンソールの [エージェント] ページをチェックして、影響を受けるエージェントがいないか確認してください。その場合は、データ転送やストレージ検出の中断を避けるため、その前にそれらのエージェントを交換してください。さらにサポートが必要な場合は、お問い合わせくださいAWS サポート
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeLocationS3
Amazon S3 バケットの場所に関する、バケット名などのメタデータを返します。
リクエストの構文
{
"LocationArn": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- LocationArn
-
説明する Amazon S3 バケットの場所の 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" ],
"CreationTime": number,
"LocationArn": "string",
"LocationUri": "string",
"S3Config": {
"BucketAccessRoleArn": "string"
},
"S3StorageClass": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AgentArns
-
アウトポストで使用している場合、 DataSync AWSアウトポストにデプロイされている EC2 エージェントの Amazon リソースネーム (ARN)。AWSアウトポストでエージェントを起動する方法の詳細については、「 DataSync エージェントをデプロイする」を参照してください。 DataSync AWS Outposts
型: 文字列の配列
配列メンバー: 最小数は 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
-
Amazon S3 バケットの場所が作成された時刻。
タイプ: Timestamp
- LocationArn
-
データを送信する Amazon S3 バケットまたはアクセスポイントの 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}$ - LocationUri
-
記述された Amazon S3 の場所の URL。
型: 文字列
長さの制約:最大長は 4360 です。
パターン:
^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$ - S3Config
-
Amazon S3 バケットへのアクセスに使用される AWS Identity and Access Management (IAM) ロールの Amazon リソースネーム (ARN)。
ロールの使用に関する詳細は、 AWS DataSync ユーザーガイドの「Amazon S3 の場所の作成」を参照してください。
型: S3Config オブジェクト
- S3StorageClass
-
この場所がタスクの送信先として使用されるときにファイルを保存することを選択する Amazon S3 ストレージクラス。S3 ストレージクラスの詳細については、「Amazon S3 ストレージクラス
」を参照してください。一部のストレージクラスの動作は、S3 のストレージコストに影響する場合があります。詳細については、の「S3 ストレージクラスを使用する際の考慮事項」を参照してください。 DataSync タイプ: 文字列
有効な値:
STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalException
-
この例外は、AWS DataSync サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード: 500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード: 400
例
例
次の例では、サンプルリクエストで指定された S3 の場所に関する情報を返します。
リクエスト例
{
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3"
}例
この例は DescribeLocation S3 の 1 つの使用法を示しています。
レスポンス例
{
"CreationTime": 1532660733.39,
"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3",
"LocationUri": "MyBucket.",
"S3Config": {
"BucketAccessRoleArn": "arn:aws:iam::111222333444:role/MyBucketAccessRole",
}
"S3StorageClass": "STANDARD"
}以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
