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

CreateTheme

Cria um tema.

Um tema é conjunto de opções de configuração para cor e layout. Os temas se aplicam a análises e painéis. Para obter mais informações, consulteUsando Temas na Amazon QuickSightnoAmazônia QuickSight Guia do usuário do.

Sintaxe da solicitação

POST /accounts/AwsAccountId/themes/ThemeId HTTP/1.1
Content-type: application/json

{
   "BaseThemeId": "string",
   "Configuration": { 
      "DataColorPalette": { 
         "Colors": [ "string" ],
         "EmptyFillColor": "string",
         "MinMaxGradient": [ "string" ]
      },
      "Sheet": { 
         "Tile": { 
            "Border": { 
               "Show": boolean
            }
         },
         "TileLayout": { 
            "Gutter": { 
               "Show": boolean
            },
            "Margin": { 
               "Show": boolean
            }
         }
      },
      "UIColorPalette": { 
         "Accent": "string",
         "AccentForeground": "string",
         "Danger": "string",
         "DangerForeground": "string",
         "Dimension": "string",
         "DimensionForeground": "string",
         "Measure": "string",
         "MeasureForeground": "string",
         "PrimaryBackground": "string",
         "PrimaryForeground": "string",
         "SecondaryBackground": "string",
         "SecondaryForeground": "string",
         "Success": "string",
         "SuccessForeground": "string",
         "Warning": "string",
         "WarningForeground": "string"
      }
   },
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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 do onde deseja armazenar o novo tema.

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

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

Obri Sim

ThemeId

Uma ID para o tema que você deseja criar. O ID do tema é exclusivo porRegião da AWSem cadaAWSconta.

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.

BaseThemeId

O ID do tema do qual herda um tema personalizado. Todos os temas herdam de um dos temas iniciais definidos pela Amazon QuickSight. Para obter uma lista dos temas iniciais, useListThemesou escolhaThemes (Temas)de dentro de uma análise do.

Type: String

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

Padrão: [\w\-]+

Obri Sim

Configuration

A configuração do tema que contém as propriedades de exibição do tema.

Tipo: objeto ThemeConfiguration

Obri Sim

Name

Um nome de exibição para o tema.

Type: String

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

Obri Sim

Permissions

Um agrupamento válido de permissões de recursos para aplicar ao novo tema.

Type: matriz deResourcePermissionobjetos

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

Obri Não

Tags

Um mapa dos pares de chave-valor para a tag ou as tags do recurso que você deseja adicionar ao recurso.

Type: matriz deTagobjetos

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

Obri Não

VersionDescription

Uma descrição da primeira versão do tema que você está criando. Toda vezUpdateThemeé chamado, uma nova versão é criada. Cada versão do tema tem uma descrição da versão noVersionDescriptioncampo.

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 Status
Content-type: application/json

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

Type: String

CreationStatus

O status de criação do tema.

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

ThemeId

O ID do tema.

Type: String

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

Padrão: [\w\-]+

VersionArn

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

Type: String

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 chaves de acesso corretas.

Código de status HTTP: 401

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