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

CreateDashboard

Cria um painel a partir de um modelo. Para primeiro criar um modelo, consulte a operação de CreateTemplate de API.

Um painel é uma entidade na Amazon QuickSight que identifica a Amazon QuickSight relatórios, criados a partir de análises. Você pode compartilhar a Amazon QuickSight painéis. Com as permissões certas, você pode criar relatórios de e-mail programados a partir deles. Se você tiver as permissões corretas, poderá criar um painel a partir de um modelo que existe em umAWSconta.

Sintaxe da solicitação

POST /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" ]
         }
      ]
   },
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "SourceEntity": { 
      "SourceTemplate": { 
         "Arn": "string",
         "DataSetReferences": [ 
            { 
               "DataSetArn": "string",
               "DataSetPlaceholder": "string"
            }
         ]
      }
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 doAWSconta onde você deseja criar o painel.

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

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

Obrigatório: Sim

DashboardId

ID do painel, também adicionado à política do IAM.

Restrições de comprimento: 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.

Name

O nome de exibição do painel.

Type: String

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

Obrigatório: Sim

SourceEntity

A entidade que você está usando como fonte ao criar o painel. DentroSourceEntity, você especifica o tipo de objeto que está usando como origem. Você só pode criar um painel a partir de um modelo, portanto, use umSourceTemplateEntidade. Se você precisar criar 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-suportadoRegiã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

Obrigatório: Sim

DashboardPublishOptions

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

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

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

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

Tipo: objeto DashboardPublishOptions

Obrigatório: Não

Parameters

Os parâmetros para a criação do painel, que você deseja usar para substituir as configurações padrão. Um painel pode ter qualquer tipo de parâmetro, e alguns parâmetros podem aceitar vários valores.

Tipo: objeto Parameters

Obrigatório: Não

Permissions

uma estrutura que contém as permissões do painel. Você pode usar essa estrutura para conceder permissões fornecendo uma lista de informações de ação do IAM para cada ARN principal.

Para especificar nenhuma permissão, omita a lista de permissões.

Type: Matriz deResourcePermissionobjetos

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

Obrigatório: Não

Tags

Contém um mapa dos pares de chave-valor para a tag de recurso ou tags atribuídas ao painel.

Type: Matriz deTagobjetos

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

Obrigatório: Não

ThemeArn

O nome do recurso da Amazon (ARN) do tema a ser usado para este painel. Se você adicionar um valor a este campo, ele substituirá o valor que é usado na entidade de origem. O tema ARN deve existir no mesmoAWSconta na qual você cria o painel.

Type: String

Obrigatório: Não

VersionDescription

uma descrição para a primeira versão do painel que está sendo criado.

Type: String

Restrições de comprimento: 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",
   "DashboardId": "string",
   "RequestId": "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 ARN do painel.

Type: String

CreationStatus

O status da solicitação de criação do painel.

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 comprimento: Tamanho mínimo de 1. Tamanho máximo de 2048.

Padrão: [\w\-]+

RequestId

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

Type: String

VersionArn

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

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

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 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: