DescribeDeploymentJob - AWS RoboMaker
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

DescribeDeploymentJob

此操作已弃用。

重要

不再支持该 API。有关更多信息，请参阅 Support 政策页面 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

创建部署作业的时间，用从纪元开始的毫秒数表示。

类型：时间戳

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 资源名称 (ARN)。

类型：字符串

长度限制：长度下限为 1。最大长度为 1224。

模式：arn:.*

robotDeploymentSummary

机器人部署汇总列表。

类型：RobotDeployment 对象数组

status

部署作业的状态。

类型：字符串

有效值：Pending | Preparing | InProgress | Failed | Succeeded | Canceled

tags

添加到指定部署作业的所有标签列表。

类型：字符串到字符串映射

映射条目：最低 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 的更多信息，请参阅以下内容：