本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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
-
如果您在AWS前哨基地DataSync上使用,则是在您的前哨基地上部署的 EC2 代理的亚马逊资源名称 (ARN)。有关在 AWS Outpos DataSync t 上启动代理的更多信息,请参阅在上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 存储桶位置的时间。
类型:时间戳
- 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
-
AWS Identity and Access Management(IAM)角色用于访问 Amazon S3 桶的 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 的一种用法。
示例响应
{
"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 的更多信息,请参阅以下内容: