DescribeProject
返回特定 DataBrew 项目的定义。
请求语法
GET /projects/name HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- name
-
要描述的项目的名称。
长度限制:长度下限为 1。最大长度为 255。
必需:是
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"CreateDate": number,
"CreatedBy": "string",
"DatasetName": "string",
"LastModifiedBy": "string",
"LastModifiedDate": number,
"Name": "string",
"OpenDate": number,
"OpenedBy": "string",
"RecipeName": "string",
"ResourceArn": "string",
"RoleArn": "string",
"Sample": {
"Size": number,
"Type": "string"
},
"SessionStatus": "string",
"Tags": {
"string" : "string"
}
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- Name
-
项目的名称。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- CreateDate
-
项目的创建日期和时间。
类型:时间戳
- CreatedBy
-
创建项目的用户的标识符(用户名)。
类型:字符串
- DatasetName
-
与项目关联的数据集。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- LastModifiedBy
-
上次修改项目的用户的标识符(用户名)。
类型:字符串
- LastModifiedDate
-
上次修改项目的日期和时间。
类型:时间戳
- OpenDate
-
打开项目的日期和时间。
类型:时间戳
- OpenedBy
-
打开项目以供使用的用户的标识符(用户名)。
类型:字符串
- RecipeName
-
与此作业关联的配方。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- ResourceArn
-
项目的 Amazon 资源名称(ARN)。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- RoleArn
-
要在 DataBrew 运行作业时担任的 AWS Identity and Access Management(IAM)角色的 ARN。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- Sample
-
表示 DataBrew 用于交互式数据分析的样本量和采样类型。
类型:Sample 对象
- SessionStatus
-
描述会话的当前状态:
-
PROVISIONING:为会话分配资源。 -
INITIALIZING:让会话为首次使用做好准备。 -
ASSIGNED:会话已准备好使用。
类型:字符串
有效值:
ASSIGNED | FAILED | INITIALIZING | PROVISIONING | READY | RECYCLING | ROTATING | TERMINATED | TERMINATING | UPDATING -
- Tags
-
与此项目关联的元数据标签。
类型:字符串到字符串映射
映射条目:最多 200 项。
密钥长度限制:最小长度为 1。最大长度为 128。
值长度限制:最大长度为 256。
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- ResourceNotFoundException
-
无法找到一个或多个资源。
HTTP 状态代码:404
- ValidationException
-
此请求的输入参数验证失败。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: