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

CreateAccountSubscription

Cria uma Amazon QuickSight conta ou assina a Amazon QuickSight Q

ORegião da AWSpara a conta é derivada do que está configurado naAWS CLIou SDK. Esta operação não é suportada nas regiões Leste dos EUA (Ohio), América do Sul (São Paulo) ou Ásia-Pacífico (Cingapura).

Antes de usar esta operação, certifique-se de que você pode se conectar a umConta da AWS. Se você não tiver umaConta da AWS, consulteCadastro naAWSnoAmazônia QuickSight Guia do usuário do. A pessoa que se inscreve na Amazon QuickSight precisa ter o corretoAWS Identity and Access Management(IAM) permissões. Para obter mais informações, consulteExemplos de política do IAM para o Amazon QuickSightnoAmazônia QuickSight Guia do usuário do.

Se a sua política do IAM incluir osSubscribeeCreateAccountSubscriptionações, certifique-se de que ambas as ações estejam definidas comoAllow. Se uma das ações estiver definida comoDeny, oDenya ação prevalecerá e sua chamada de API falha.

Você não pode passar uma função existente do IAM para acessar outrasAWSserviços que usam essa operação de API. Para passar sua função existente do IAM para a Amazon QuickSight, consulteTransferência de funções do IAM para a Amazon QuickSightnoAmazônia QuickSight Guia do usuário do.

Você não pode definir o acesso padrão ao recurso na nova conta da Amazon QuickSightAPI. Em vez disso, adicione acesso padrão a recursos da Amazon QuickSight console do . Para obter mais informações sobre como definir o acesso a recursos padrão paraAWSserviços, consulteDefinindo o acesso padrão ao recurso paraAWSserviçosnoAmazônia QuickSightGuia do usuário do.

Sintaxe da solicitação

POST /account/AwsAccountId HTTP/1.1
Content-type: application/json

{
   "AccountName": "string",
   "ActiveDirectoryName": "string",
   "AdminGroup": [ "string" ],
   "AuthenticationMethod": "string",
   "AuthorGroup": [ "string" ],
   "ContactNumber": "string",
   "DirectoryId": "string",
   "Edition": "string",
   "EmailAddress": "string",
   "FirstName": "string",
   "LastName": "string",
   "NotificationEmail": "string",
   "ReaderGroup": [ "string" ],
   "Realm": "string"
}

Parâmetros da solicitação de URI

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

AwsAccountId

OConta da AWSID da conta usada para criar sua Amazon QuickSight conta.

Restrições de tamanho: Comprimento fixo de

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

Obrigatório: Sim

Corpo da solicitação

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

AccountName

O nome da sua Amazon QuickSight conta. Este nome é único em todosAWSe ele aparece somente quando os usuários fazem login. Não é possível alterarAccountNamevalor depois da Amazônia QuickSight conta é criada.

Type: String

Obrigatório: Sim

AuthenticationMethod

O método que você deseja que o utilize para autenticar a sua Amazon QuickSight conta. No momento, os valores válidos desse parâmetro sãoIAM_AND_QUICKSIGHT,IAM_ONLY, eACTIVE_DIRECTORY.

Se escolherACTIVE_DIRECTORY, forneça umActiveDirectoryNamee umAdminGroupassociado ao Active Directory.

Type: String

Valores válidos: IAM_AND_QUICKSIGHT | IAM_ONLY | ACTIVE_DIRECTORY

Obrigatório: Sim

Edition

A edição da Amazon QuickSight que você deseja que sua conta tenha. Atualmente, você pode escolherENTERPRISEouENTERPRISE_AND_Q.

Se escolherENTERPRISE_AND_Q, os seguintes parâmetros são obrigatórios:

  • FirstName

  • LastName

  • EmailAddress

  • ContactNumber

Type: String

Valores válidos: STANDARD | ENTERPRISE | ENTERPRISE_AND_Q

Obrigatório: Sim

NotificationEmail

O endereço de e-mail que você deseja Amazon QuickSight para enviar notificações sobre a Amazon QuickSight conta ou Amazon QuickSight assinatura.

Type: String

Obrigatório: Sim

ActiveDirectoryName

O nome do Active Directory. Esse campo será obrigatórioACTIVE_DIRECTORYé o método de autenticação selecionado da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

AdminGroup

O grupo de administradores associado ao seu Active Directory. Esse campo será obrigatórioACTIVE_DIRECTORYé o método de autenticação selecionado da nova Amazon QuickSight conta. Para obter mais informações sobre como usar o Active Directory na Amazon QuickSight, consulteUso do Active Directory com o Amazon QuickSight Edição Enterprisena Amazon QuickSightGuia do usuário do .

Type: Matriz de strings

Obrigatório: Não

AuthorGroup

O grupo de autores associado ao seu Active Directory. Para obter mais informações sobre como usar o Active Directory na Amazon QuickSight, consulteUso do Active Directory com o Amazon QuickSight Edição Enterprisena Amazon QuickSightGuia do usuário do .

Type: Matriz de strings

Obrigatório: Não

ContactNumber

Um número de telefone de 10 dígitos do autor da Amazon QuickSight conta a ser usada para comunicações future. Esse campo será obrigatórioENTERPPRISE_AND_Qé a edição selecionada da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

DirectoryId

O ID do Active Directory que é associado ao seu Amazon QuickSight conta.

Type: String

Obrigatório: Não

EmailAddress

O endereço de e-mail do autor da Amazon QuickSight conta a ser usada para comunicações future. Esse campo será obrigatórioENTERPPRISE_AND_Qé a edição selecionada da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

FirstName

O nome do autor da Amazônia QuickSight conta a ser usada para comunicações future. Esse campo será obrigatórioENTERPPRISE_AND_Qé a edição selecionada da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

LastName

O sobrenome do autor da Amazônia QuickSight conta a ser usada para comunicações future. Esse campo será obrigatórioENTERPPRISE_AND_Qé a edição selecionada da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

ReaderGroup

O grupo de leitores associado ao seu Active Directory. Para obter mais informações sobre como usar o Active Directory na Amazon QuickSight, consulteUso do Active Directory com o Amazon QuickSight Edição EnterprisenoAmazônia QuickSightGuia do usuário do.

Type: Matriz de strings

Obrigatório: Não

Realm

O domínio do Active Directory associado à sua Amazon QuickSight conta. Esse campo será obrigatórioACTIVE_DIRECTORYé o método de autenticação selecionado da nova Amazon QuickSight conta.

Type: String

Obrigatório: Não

Sintaxe da resposta

HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "SignupResponse": { 
      "accountName": "string",
      "directoryType": "string",
      "IAMUser": boolean,
      "userLoginName": "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.

RequestId

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

Type: String

SignupResponse

UMASignupResponseobjeto que retorna informações sobre uma Amazon recém-criada QuickSight conta.

Tipo: objeto SignupResponse

Erros

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

AccessDeniedException

Você não tem acesso a esse item. Não foi possível validar as credenciais fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight , se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas.

Código de status HTTP: 401

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

PreconditionNotMetException

Uma ou mais pré-condições não foram atendidas.

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

ResourceUnavailableException

Este recurso está indisponível no momento.

Código de status HTTP: 503

ThrottlingException

O acesso é limitado.

Código de status HTTP: 429

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: