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

CreateAnalysis

Cria uma análise na Amazon QuickSight.

Sintaxe da solicitação

POST /accounts/AwsAccountId/analyses/AnalysisId HTTP/1.1
Content-type: application/json

{
   "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"
}

Parâmetros da solicitação de URI

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

AnalysisId

O ID da análise que você está criando. Esse ID é exibido no URL da análise.

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

Padrão: [\w\-]+

Obrigatório: Sim

AwsAccountId

O ID doAWSconta em que você está criando uma análise.

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

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

Obrigatório: Sim

Corpo da solicitação

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

Name

Um nome descritivo para a análise que você está criando. Esse nome é exibido para a análise na Amazônia QuickSight console do .

Type: String

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

Obrigatório: Sim

SourceEntity

Uma entidade de origem a ser usada para a análise que você está criando. Essa estrutura de metadados contém detalhes que descrevem um modelo de origem e um ou mais conjuntos de dados.

Tipo: objeto AnalysisSourceEntity

Obrigatório: Sim

Parameters

Os nomes dos parâmetros e os valores de substituição que você deseja usar. Uma análise 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 descreve os principais e as permissões em nível de recurso em uma análise. Você pode usar oPermissionsestrutura para conceder permissões fornecendo uma lista deAWS Identity and Access ManagementInformações de ação (IAM) para cada entidade listada pelo Nome de recurso da Amazon (ARN).

Para especificar nenhuma permissão, omitaPermissions.

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 à análise.

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 ARN do tema a ser aplicado à análise que você está criando. Para ver o tema na Amazon QuickSight console, verifique se você tem acesso a ele.

Type: String

Obrigatório: Não

Sintaxe da resposta

HTTP/1.1 Status
Content-type: application/json

{
   "AnalysisId": "string",
   "Arn": "string",
   "CreationStatus": "string",
   "RequestId": "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.

AnalysisId

O ID da análise.

Type: String

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

Padrão: [\w\-]+

Arn

O ARN para a análise.

Type: String

CreationStatus

O status da criação da análise.

Type: String

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

RequestId

OAWSID da solicitação para essa operaçã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

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

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