本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeDeploymentJob
此動作已被取代。
重要
此 API 已不再受支援。如需詳細資訊,請參閱 Sup port 政策頁面中的 2022 年 5 月 2 日更新。
描述部署工作。
請求語法
POST /describeDeploymentJob HTTP/1.1
Content-type: application/json
{
"job": "string
"
}
URI 請求參數
請求不會使用任何 URI 參數。
請求主體
請求接受採用 JSON 格式的下列資料。
- job
-
部署任務的 Amazon 資源名稱 (ARN)。
類型:字串
長度限制:長度下限為 1。最大長度為 1224。
模式:
arn:.*
必要:是
回應語法
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": number,
"deploymentApplicationConfigs": [
{
"application": "string",
"applicationVersion": "string",
"launchConfig": {
"environmentVariables": {
"string" : "string"
},
"launchFile": "string",
"packageName": "string",
"postLaunchFile": "string",
"preLaunchFile": "string"
}
}
],
"deploymentConfig": {
"concurrentDeploymentPercentage": number,
"downloadConditionFile": {
"bucket": "string",
"etag": "string",
"key": "string"
},
"failureThresholdPercentage": number,
"robotDeploymentTimeoutInSeconds": number
},
"failureCode": "string",
"failureReason": "string",
"fleet": "string",
"robotDeploymentSummary": [
{
"arn": "string",
"deploymentFinishTime": number,
"deploymentStartTime": number,
"failureCode": "string",
"failureReason": "string",
"progressDetail": {
"currentProgress": "string",
"estimatedTimeRemainingSeconds": number,
"percentDone": number,
"targetResource": "string"
},
"status": "string"
}
],
"status": "string",
"tags": {
"string" : "string"
}
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- arn
-
部署任務的 Amazon 資源名稱 (ARN)。
類型:字串
長度限制:長度下限為 1。最大長度為 1224。
模式:
arn:.*
- createdAt
-
建立部署工作之後的時間 (以毫秒為單位)。
類型:Timestamp
- deploymentApplicationConfigs
-
部署應用程式組態。
類型:DeploymentApplicationConfig 物件陣列
陣列成員:固定項目數為 1。
- deploymentConfig
-
部署組態。
類型:DeploymentConfig 物件
- failureCode
-
部署工作失敗代碼。
類型:字串
有效值:
ResourceNotFound | EnvironmentSetupError | EtagMismatch | FailureThresholdBreached | RobotDeploymentAborted | RobotDeploymentNoResponse | RobotAgentConnectionTimeout | GreengrassDeploymentFailed | InvalidGreengrassGroup | MissingRobotArchitecture | MissingRobotApplicationArchitecture | MissingRobotDeploymentResource | GreengrassGroupVersionDoesNotExist | LambdaDeleted | ExtractingBundleFailure | PreLaunchFileFailure | PostLaunchFileFailure | BadPermissionError | DownloadConditionFailed | BadLambdaAssociated | InternalServerError | RobotApplicationDoesNotExist | DeploymentFleetDoesNotExist | FleetDeploymentTimeout
- failureReason
-
部署工作失敗原因的簡短說明。
類型:字串
長度限制:長度下限為 0。長度上限為 1024。
模式:
.*
- fleet
-
機群的 Amazon Resource Name (ARN)。
類型:字串
長度限制:長度下限為 1。最大長度為 1224。
模式:
arn:.*
- robotDeploymentSummary
-
機器人部署摘要的清單。
類型:RobotDeployment 物件陣列
- status
-
部署工作的狀態。
類型:字串
有效值:
Pending | Preparing | InProgress | Failed | Succeeded | Canceled
-
新增至指定部署工作的所有標籤清單。
類型:字串到字串映射
地圖項目:0 個項目的最小數目。項目數上限為 50。
索引鍵長度限制:長度下限為 1。長度上限為 128。
金鑰模式:
[a-zA-Z0-9 _.\-\/+=:]*
值長度限制:最小長度為 0。長度上限為 256。
值模式:
[a-zA-Z0-9 _.\-\/+=:]*
錯誤
如需所有動作常見錯誤的資訊,請參閱常見錯誤。
- InternalServerException
-
AWS RoboMaker 遇到服務問題。請再次嘗試呼叫。
HTTP 狀態碼:500
- InvalidParameterException
-
在請求中指定的一個參數無效、未支援或無法使用。傳回之訊息會提供錯誤值的說明。
HTTP 狀態碼:400
- ResourceNotFoundException
-
指定的資源不存在。
HTTP 狀態碼:400
- ThrottlingException
-
AWS 暫 RoboMaker 時無法處理請求。請再次嘗試呼叫。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: