DescribeWorldGenerationJob - 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á.

DescribeWorldGenerationJob

Descreve um trabalho de geração de mundos.

Sintaxe da Solicitação

POST /describeWorldGenerationJob 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 geração de mundos a ser descrito.

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",
   "clientRequestToken": "string",
   "createdAt": number,
   "failureCode": "string",
   "failureReason": "string",
   "finishedWorldsSummary": { 
      "failureSummary": { 
         "failures": [ 
            { 
               "failureCode": "string",
               "failureCount": number,
               "sampleFailureReason": "string"
            }
         ],
         "totalFailureCount": number
      },
      "finishedCount": number,
      "succeededWorlds": [ "string" ]
   },
   "status": "string",
   "tags": { 
      "string" : "string" 
   },
   "template": "string",
   "worldCount": { 
      "floorplanCount": number,
      "interiorCountPerFloorplan": number
   },
   "worldTags": { 
      "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 geração de mundos.

Tipo: string

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

Padrão: arn:.*

clientRequestToken

Identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 64.

Padrão: [a-zA-Z0-9_\-=]*

createdAt

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

Tipo: Timestamp

failureCode

O código de falha do trabalho de geração de mundos, se ele falhar:

InternalServiceError

Erro de serviço interno.

LimitExceeded

O recurso solicitado excede o número máximo permitido ou o número de solicitações de streaming simultâneas excede o número máximo permitido.

ResourceNotFound

Não foi possível encontrar o recurso especificado.

RequestThrottled

A solicitação foi acelerada.

InvalidInput

Um parâmetro de entrada na solicitação não é válido.

Tipo: strings

Valores Válidos: InternalServiceError | LimitExceeded | ResourceNotFound | RequestThrottled | InvalidInput | AllWorldGenerationFailed

failureReason

A razão pela qual o trabalho da geração de mundos falhou.

Tipo: string

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

Padrão: .*

finishedWorldsSummary

Informações resumidas sobre mundos finalizados.

Tipo: objeto FinishedWorldsSummary

status

O status do trabalho de geração de mundos:

Pendente

A solicitação de trabalho de geração de mundos está pendente.

Executando

O trabalho de geração de mundos está funcionando.

Concluído

O trabalho de geração de mundos foi concluído.

Com falha

O trabalho da geração de mundos falhou. Consulte failureCode Para mais informações.

PartialFailed

Alguns mundos não foram gerados.

Cancelado

O trabalho de geração de mundos foi cancelado.

Cancelando

O trabalho de geração de mundos está sendo cancelado.

Tipo: strings

Valores Válidos: Pending | Running | Completed | Failed | PartialFailed | Canceling | Canceled

tags

Um mapa com as chaves e os valores de tag anexados ao trabalho de geração de mundos.

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 _.\-\/+=:]*

template

O nome do recurso da Amazon (ARN) do modelo de mundo.

Tipo: string

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

Padrão: arn:.*

worldCount

Informações sobre a contagem de mundos.

Tipo: objeto WorldCount

worldTags

Um mapa com as chaves e os valores de tag anexados aos mundos gerados.

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: