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

CreateWorldExportJob

Cria um trabalho de exportação de mundos.

Sintaxe da Solicitação

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

{
   "clientRequestToken": "string",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "worlds": [ "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.

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_\-=]*

Obrigatório: não

iamRole

O perfil do IAM que o processo de exportação de mundos usa para acessar o bucket do Amazon S3 e colocar a exportação.

Tipo: string

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

Padrão: arn:aws:iam::\w+:role/.*

Exigido: Sim

outputLocation

O local de saída.

Tipo: objeto OutputLocation

Obrigatório: Sim

tags

Um mapa com as chaves e os valores de tag anexados ao trabalho de exportaçã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 _.\-\/+=:]*

Obrigatório: não

worlds

Uma lista dos nomes do recurso da Amazon (arns) que correspondem aos mundos para exportação.

Tipo: Matriz de strings

Membros da Matriz: Número mínimo de 1 item. Número máximo de 100 itens.

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",
   "iamRole": "string",
   "outputLocation": { 
      "s3Bucket": "string",
      "s3Prefix": "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 exportaçã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 exportação de mundos foi criado.

Tipo: Timestamp

failureCode

O código de falha do trabalho de exportaçã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.

AllWorldGenerationFailed

Todos os mundos no trabalho de geração de mundos falharam. Isso pode acontecer se seu worldCount for maior que 50 ou menor que 1.

Para obter mais informações sobre solução de problemas WorldForge, consulte Simulação de solução de problemas WorldForge.

Tipo: strings

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

iamRole

O perfil do IAM que o processo de exportação de mundos usa para acessar o bucket do Amazon S3 e colocar a exportação.

Tipo: string

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

Padrão: arn:aws:iam::\w+:role/.*

outputLocation

O local de saída.

Tipo: objeto OutputLocation

status

O status do trabalho de exportação de mundos.

Pendente

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

Executando

O trabalho de exportação de mundos está em andamento.

Concluído

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

Com falha

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

Cancelado

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

Cancelando

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

Tipo: strings

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

tags

Um mapa com as chaves e os valores de tag anexados ao trabalho de exportaçã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 _.\-\/+=:]*

Erros

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

IdempotentParameterMismatchException

A solicitação usa o mesmo token do cliente de uma solicitação anterior, mas não idêntica. Não reutilize um token do cliente com diferentes solicitações, a menos que as solicitações sejam idênticas.

Código de Status HTTP: 400

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

ServiceUnavailableException

Falha na solicitação devido a um erro temporário do servidor.

Código de status HTTP: 503

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: