CreateAnalysis -

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

CreateAnalysis

Crea un análisis en Amazon QuickSight.

Sintaxis de la solicitud

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 de solicitud URI

La solicitud utiliza los siguientes parámetros URI.

AnalysisId

El ID del análisis que está creando. Este ID se muestra en la dirección URL del análisis.

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+

: obligatorio Sí

AwsAccountId

El ID de la cuenta de AWS en la que está creando un análisis.

Restricciones de longitud: Longitud fija de 12.

Patrón: ^[0-9]{12}$

: obligatorio Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Nombre

Nombre descriptivo para el análisis que está creando. Este nombre se muestra para el análisis en la consola de QuickSight.

Tipo: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

: obligatorio Sí

SourceEntity

Entidad de origen que se va a utilizar para el análisis que se está creando. Esta estructura de metadatos contiene detalles que describen una plantilla de origen y uno o más datasets.

Tipo: objeto AnalysisSourceEntity

: obligatorio Sí

Parámetros

Los nombres de parámetros y valores de sustitución que desea utilizar. Un análisis puede tener cualquier tipo de parámetro y algunos parámetros pueden aceptar varios valores.

Tipo: objeto Parameters

: obligatorio No

Permisos

Estructura que describe las entidades principales y los permisos de nivel de recursos de un análisis. Puede utilizarPermissionsPara conceder permisos, proporcionando una lista de información de AWS Identity and Access Management (IAM) para cada uno de los principales que figuran por Nombre de recurso de Amazon (ARN).

Para especificar ningún permiso, omitaPermissions.

Tipo: Array deResourcePermissionobjects

Miembros de matrices Número mínimo de 1 elemento. Número máximo de 64 elementos.

: obligatorio No

Etiquetas

Contiene un mapa de los pares clave-valor para la etiqueta o etiquetas de recurso asignadas al análisis.

Tipo: Array deTagobjects

Miembros de matrices Número mínimo de 1 elemento. Número máximo de 200 elementos.

: obligatorio No

ThemeArn

El ARN para que el tema se aplique al análisis que está creando. Para ver el tema en la consola de QuickSight, asegúrese de tener acceso a él.

Tipo: Cadena

: obligatorio No

Sintaxis de la respuesta

HTTP/1.1 Status Content-type: application/json { "AnalysisId": "string", "Arn": "string", "CreationStatus": "string", "RequestId": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la respuesta siguiente HTTP.

Estado

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

AnalysisId

El ID del análisis.

Tipo: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: [\w\-]+

Arn

El ARN para el análisis.

Tipo: Cadena

Estado de creación

El estado de la creación del análisis.

Tipo: Cadena

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

RequestId

ID de solicitud de AWS de esta operación.

Tipo: Cadena

Errors

Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.

ConflictExcepción

La actualización o eliminación de un recurso puede provocar un estado incoherente.

Código de estado HTTP: 409

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

ResourceNotFoundException

No se encontraron uno o varios recursos.

Código de estado HTTP: 404

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

UnsupportedUserEditionException

Este error indica que está llamando a una operación en una suscripción de Amazon QuickSight en la que la edición no admite esa operación. Las ediciones actuales de Amazon QuickSight son Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.

Código de estado HTTP: 403

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: