DescribeLocationS3 - AWS DataSync

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeLocationS3

傳回 Amazon S3 儲存貯體位置的相關中繼資料,例如儲存貯體名稱。

請求語法

{ "LocationArn": "string" }

請求參數

如需有關所有動作共用之參數的資訊,請參閱一般參數

請求接受採用 JSON 格式的下列資料。

LocationArn

資料說明的 Amazon S3 儲存貯體 Amazon Resource Name (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 代理器的亞馬遜資源名稱(ARN)。如需在 AWS Outpost 上啟動DataSync代理程式的詳細資訊,請參閱在上AWS Outposts部署DataSync代理程式

類型:字串陣列

陣列成員:項目數下限為 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 Resource Name (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 Resource Name (ARN)。

如需有關使用此類角色的詳細資訊,請參閱 AWS DataSync User Guide (《 使用者指南》) 中的 Creating a Location for Amazon S3 (建立 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 的一種用法。

回應範例

{ "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 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: