UpdateTemplate - Amazon QuickSight
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á.

UpdateTemplate

Atualiza um modelo de uma Amazon existente da Amazon QuickSight análise ou outro modelo.

Sintaxe da solicitação

PUT /accounts/AwsAccountId/templates/TemplateId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "SourceEntity": { 
      "SourceAnalysis": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      },
      "SourceTemplate": { 
         "Arn": "string"
      }
   },
   "VersionDescription": "string"
}

Parâmetros da solicitação de URI

A solicitação usa os parâmetros de URI a seguir.

AwsAccountId

O ID doAWSconta que contém o modelo que você está atualizando.

Restrições de tamanho: Comprimento fixo de 12.

Padrão: ^[0-9]{12}$

Obrigatório: Sim

TemplateId

O ID do modelo.

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

Padrão: [\w\-]+

Obrigatório: Sim

Corpo da solicitação

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

SourceEntity

A entidade que você está usando como fonte ao atualizar o modelo. DentroSourceEntity, você especifica o tipo de objeto que está usando como origem:SourceTemplatepara um modelo ou de um modeloSourceAnalysispara uma análise do. Ambos exigem um nome de recurso da Amazon (ARN). para oSourceTemplate, especifique o ARN do modelo de origem. para oSourceAnalysis, especifique o ARN da análise de origem. OSourceTemplateO ARN pode conter qualquerAWSconta e qualquer Amazon QuickSight-suportadoRegião da AWS;.

Usar aDataSetReferencesentidade dentroSourceTemplateouSourceAnalysispara listar os conjuntos de dados de substituição para os espaços reservados listados no original. O esquema em cada conjunto de dados deve corresponder ao seu espaço reservado.

Tipo: objeto TemplateSourceEntity

Obrigatório: Sim

Name

O nome do modelo.

Type: String

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

Obrigatório: Não

VersionDescription

Uma descrição da versão atual do modelo que está sendo atualizada. Toda vez que você ligaUpdateTemplate, você cria uma nova versão do modelo. Cada versão do modelo mantém uma descrição da versão naVersionDescriptioncampo.

Type: String

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

Obrigatório: Não

Sintaxe da resposta

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "RequestId": "string",
   "TemplateId": "string",
   "VersionArn": "string"
}

Elementos de resposta

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

Status

O status HTTP da solicitação.

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

Arn

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

Type: String

CreationStatus

O status de criação do modelo.

Type: String

Valores válidos: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

RequestId

OAWSID de solicitação para essa operação.

Type: String

TemplateId

O ID do modelo.

Type: String

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

Padrão: [\w\-]+

VersionArn

O ARN do modelo, incluindo as informações de versão da primeira versão.

Type: String

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulte oErros comuns.

ConflictException

Atualizar ou excluir um recurso pode causar um estado inconsistente.

Código de status HTTP: 409

InternalFailureException

Ocorreu um erro interno.

Código de status HTTP: 500

InvalidParameterValueException

Um ou mais parâmetros têm um valor que não é válido.

Código de status HTTP: 400

LimitExceededException

Um limite foi excedido.

Código de status HTTP: 409

ResourceExistsException

O recurso especificado já existe.

Código de status HTTP: 409

ResourceNotFoundException

Não foi possível encontrar um ou mais recursos.

Código de status HTTP: 404

ThrottlingException

O acesso é limitado.

Código de status HTTP: 429

UnsupportedUserEditionException

Esse erro indica que você está chamando uma operação em uma Amazon QuickSightassinatura em que a edição não inclui suporte para essa operação. Amazon Amazon QuickSight atualmente está disponível na Standard Edition e Enterprise Edition Edition Edition Edition Edition Nem todas operações e recursos estão disponível em todas as edições.

Código de status HTTP: 403

Consulte também

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