DescribeDeploymentJob - AWS RoboMaker
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DescribeDeploymentJob

Essa ação está defasada.

Importante

Essa API não é mais compatível. Para obter mais informações, consulte a atualização de 2 de maio de 2022 na página da política de suporte.

Descreve um trabalho de implantação.

Sintaxe da Solicitação

POST /describeDeploymentJob HTTP/1.1
Content-type: application/json

{
   "job": "string"
}

Parâmetros da solicitação de URI

A solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

job

O nome do recurso da Amazon (ARN) do trabalho de implantação.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.224.

Padrão: arn:.*

Exigido: Sim

Sintaxe da Resposta

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" 
   }
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

arn

O nome do recurso da Amazon (ARN) do trabalho de implantação.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.224.

Padrão: arn:.*

createdAt

O tempo, em milissegundos, desde o período em que o trabalho de implantação foi criado.

Tipo: Timestamp

deploymentApplicationConfigs

A configuração do aplicativo de implantação.

Tipo: matriz de objetos DeploymentApplicationConfig

Membros da matriz: número fixo de 1 item.

deploymentConfig

A configuração de implantação.

Tipo: objeto DeploymentConfig

failureCode

O código de falha do trabalho de implantação.

Tipo: strings

Valores Válidos: 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

Uma breve descrição do motivo pelo qual o trabalho de implantação falhou.

Tipo: string

Restrições de tamanho: tamanho mínimo 0. Tamanho máximo de 1.024.

Padrão: .*

fleet

O nome do recurso da Amazon (ARN) da frota.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 1.224.

Padrão: arn:.*

robotDeploymentSummary

Uma lista de resumos de implantação de robôs.

Tipo: matriz de objetos RobotDeployment

status

O status do trabalho de implantação.

Tipo: strings

Valores Válidos: Pending | Preparing | InProgress | Failed | Succeeded | Canceled

tags

A lista de todas as tags adicionadas ao trabalho de implantação especificado.

Tipo: mapa de string para string

Entradas do mapa: número mínimo de 0 itens. Número máximo de 50 itens.

Restrições de Tamanho de Chave: Tamanho mínimo de 1. O tamanho máximo é 128.

Padrão da chave: [a-zA-Z0-9 _.\-\/+=:]*

Restrições de tamanho do valor: tamanho mínimo de 0. O tamanho máximo é 256.

Padrão de valor: [a-zA-Z0-9 _.\-\/+=:]*

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

InternalServerException

A AWS RoboMaker enfrentou um problema de serviço. Tente fazer a chamada novamente.

Código de Status HTTP: 500

InvalidParameterException

Um parâmetro especificado em uma solicitação é inválido, não tem suporte ou não pode ser usado. A mensagem retornada fornece uma explicação do valor do erro.

Código de Status HTTP: 400

ResourceNotFoundException

O recurso especificado não existe.

Código de Status HTTP: 400

ThrottlingException

RoboMaker A AWS está temporariamente impossibilitada de processar a solicitação. Tente fazer a chamada novamente.

Código de Status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: