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

UpdateDashboard

Atualiza um painel emAWSconta.

nota

A atualização de um painel cria uma nova versão do painel, mas não publica imediatamente a nova versão. Você pode atualizar a versão publicada de um painel usando UpdateDashboardPublishedVersion Operação da API

Sintaxe da solicitação

PUT /accounts/AwsAccountId/dashboards/DashboardId HTTP/1.1
Content-type: application/json

{
   "DashboardPublishOptions": { 
      "AdHocFilteringOption": { 
         "AvailabilityStatus": "string"
      },
      "ExportToCSVOption": { 
         "AvailabilityStatus": "string"
      },
      "SheetControlsOption": { 
         "VisibilityState": "string"
      }
   },
   "Name": "string",
   "Parameters": { 
      "DateTimeParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "DecimalParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "IntegerParameters": [ 
         { 
            "Name": "string",
            "Values": [ number ]
         }
      ],
      "StringParameters": [ 
         { 
            "Name": "string",
            "Values": [ "string" ]
         }
      ]
   },
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "ThemeArn": "string",
   "VersionDescription": "string"
}

Parâmetros da solicitação de URI

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

AwsAccountId

O ID daAWSconta que contém o painel que você está atualizando.

Restrições de tamanho Comprimento fixo de 12.

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

Obri Sim

DashboardId

A ID do painel.

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

Padrão: [\w\-]+

Obri Sim

Corpo da solicitação

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

Name

O nome de exibição do painel.

Type: String

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

Obri Sim

SourceEntity

A entidade que você está usando como fonte ao atualizar o painel. DentroSourceEntity, você especifica o tipo de objeto que está usando como origem. Você só pode atualizar um painel a partir de um modelo, então você usa umSourceTemplateEntidade. Se você precisar atualizar um painel a partir de uma análise, primeiro converta a análise em um modelo usando a CreateTemplate Operação da API para oSourceTemplate, especifica o nome de recurso da Amazon (ARN) do modelo de origem. OSourceTemplateO ARN pode conter qualquerAWSconta e qualquer Amazon QuickSight-suportRegião da AWS.

Usar aDataSetReferencesentidade dentroSourceTemplatepara 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 DashboardSourceEntity

Obri Sim

DashboardPublishOptions

Opções para publicar o painel ao criá-lo:

  • AvailabilityStatuspeloAdHocFilteringOption- Este status pode serENABLEDouDISABLED. Quando isso for configuradoDISABLED, Amazon QuickSight desativa o painel de filtro esquerdo no painel publicado, que pode ser usado para filtragem ad hoc (única). Esta opçãoENABLEDpor padrão

  • AvailabilityStatuspeloExportToCSVOption- Este status pode serENABLEDouDISABLED. A opção visual para exportar dados para o formato .CSV não está habilitada quando está definida comoDISABLED. Esta opçãoENABLEDpor padrão

  • VisibilityStatepeloSheetControlsOption- Esse estado de visibilidade pode serCOLLAPSEDouEXPANDED. Esta opçãoCOLLAPSEDpor padrão

Tipo: objeto DashboardPublishOptions

Obri Não

Parameters

Uma estrutura que contém os parâmetros do painel. Essas são substituições de parâmetros para um painel. Um painel pode ter qualquer tipo de parâmetro, e alguns parâmetros podem aceitar vários valores.

Tipo: objeto Parameters

Obri Não

ThemeArn

O nome de recurso da Amazon (ARN) do tema que está sendo usado para este painel. Se você adicionar um valor para este campo, ele substituirá o valor que foi originalmente associado à Entidade. O ARN do tema deve existirAWSconta na qual você cria o painel.

Type: String

Obri Não

VersionDescription

Uma descrição para a primeira versão do painel que está sendo criada.

Type: String

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

Obri Não

Sintaxe da resposta

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationStatus": "string",
   "DashboardId": "string",
   "RequestId": "string",
   "Status": number,
   "VersionArn": "string"
}

Elementos de resposta

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

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

Arn

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

Type: String

CreationStatus

O status de criação da solicitação

Type: String

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

DashboardId

A ID do painel.

Type: String

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

Padrão: [\w\-]+

RequestId

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

Type: String

Status

O status HTTP da solicitação.

Type: Inteiro

VersionArn

O ARN do painel, incluindo o número da versão.

Type: String

Erros

Para obter informações sobre os erros que são comuns a todas as ações, consulteErros 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

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

Este 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 QuickSight No momento, está disponível na Standard Edition e Enterprise 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: