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.
CreateDataSet
Crea un conjunto de datos. Esta operación no admite conjuntos de datos que incluyan archivos cargados como fuente.
Sintaxis de la solicitud
POST /accounts/AwsAccountId/data-sets HTTP/1.1
Content-type: application/json
{
"ColumnGroups": [
{
"GeoSpatialColumnGroup": {
"Columns": [ "string" ],
"CountryCode": "string",
"Name": "string"
}
}
],
"ColumnLevelPermissionRules": [
{
"ColumnNames": [ "string" ],
"Principals": [ "string" ]
}
],
"DataSetId": "string",
"DataSetUsageConfiguration": {
"DisableUseAsDirectQuerySource": boolean,
"DisableUseAsImportedSource": boolean
},
"FieldFolders": {
"string" : {
"columns": [ "string" ],
"description": "string"
}
},
"ImportMode": "string",
"LogicalTableMap": {
"string" : {
"Alias": "string",
"DataTransforms": [
{
"CastColumnTypeOperation": {
"ColumnName": "string",
"Format": "string",
"NewColumnType": "string"
},
"CreateColumnsOperation": {
"Columns": [
{
"ColumnId": "string",
"ColumnName": "string",
"Expression": "string"
}
]
},
"FilterOperation": {
"ConditionExpression": "string"
},
"ProjectOperation": {
"ProjectedColumns": [ "string" ]
},
"RenameColumnOperation": {
"ColumnName": "string",
"NewColumnName": "string"
},
"TagColumnOperation": {
"ColumnName": "string",
"Tags": [
{
"ColumnDescription": {
"Text": "string"
},
"ColumnGeographicRole": "string"
}
]
},
"UntagColumnOperation": {
"ColumnName": "string",
"TagNames": [ "string" ]
}
}
],
"Source": {
"DataSetArn": "string",
"JoinInstruction": {
"LeftJoinKeyProperties": {
"UniqueKey": boolean
},
"LeftOperand": "string",
"OnClause": "string",
"RightJoinKeyProperties": {
"UniqueKey": boolean
},
"RightOperand": "string",
"Type": "string"
},
"PhysicalTableId": "string"
}
}
},
"Name": "string",
"Permissions": [
{
"Actions": [ "string" ],
"Principal": "string"
}
],
"PhysicalTableMap": {
"string" : {
"CustomSql": {
"Columns": [
{
"Name": "string",
"Type": "string"
}
],
"DataSourceArn": "string",
"Name": "string",
"SqlQuery": "string"
},
"RelationalTable": {
"Catalog": "string",
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"Name": "string",
"Schema": "string"
},
"S3Source": {
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"UploadSettings": {
"ContainsHeader": boolean,
"Delimiter": "string",
"Format": "string",
"StartFromRow": number,
"TextQualifier": "string"
}
}
}
},
"RowLevelPermissionDataSet": {
"Arn": "string",
"FormatVersion": "string",
"Namespace": "string",
"PermissionPolicy": "string",
"Status": "string"
},
"RowLevelPermissionTagConfiguration": {
"Status": "string",
"TagRules": [
{
"ColumnName": "string",
"MatchAllValue": "string",
"TagKey": "string",
"TagMultiValueDelimiter": "string"
}
]
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- AwsAccountId
-
El ID de la cuenta de AWS.
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.
- DataSetId
-
ID del conjunto de datos que desea crear. Este ID es único porRegión de AWSpara cadaAWSaccount.
Type: Cadena
Obligatorio: Sí
- ImportMode
-
Indica si desea importar los datos a SPICE.
Type: Cadena
Valores válidos:
SPICE | DIRECT_QUERYObligatorio: Sí
- Name
-
El nombre para mostrar en el conjunto de datos.
Type: Cadena
Restricciones de longitud Longitud mínima de 1. La longitud máxima es de 128 caracteres.
Obligatorio: Sí
- PhysicalTableMap
-
Declara las tablas físicas que están disponibles en los orígenes de datos subyacentes.
Type: Cadena paraPhysicalTablemapa de objetos
Entradas de mapa: El número mínimo es 0 elementos. Número máximo de 32 elementos.
Restricciones de longitud de las Longitud mínima de 1. La longitud máxima es 64.
Patrón de clave:
[0-9a-zA-Z-]*Obligatorio: Sí
- ColumnGroups
-
Agrupaciones de columnas que funcionan juntas en determinadas Amazon QuickSight Características. Actualmente, solo se admite la jerarquía geoespacial.
Type: Matriz deColumnGroupobjects
Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 8 elementos.
Obligatorio: No
- ColumnLevelPermissionRules
-
Un conjunto de una o más definiciones de una
ColumnLevelPermissionRule.Type: Matriz deColumnLevelPermissionRuleobjects
Miembros de la matriz: Número mínimo de 1 elemento.
Obligatorio: No
- DataSetUsageConfiguration
-
La configuración de uso que se aplicará a los conjuntos de datos secundarios que hacen referencia a este conjunto de datos como fuente.
Tipo: objeto DataSetUsageConfiguration
Obligatorio: No
- FieldFolders
-
La carpeta que contiene campos y subcarpetas anidadas para el conjunto de datos.
Type: Cadena paraFieldFoldermapa de objetos
Restricciones de longitud de las Longitud mínima de 1. La longitud máxima es de 1000 caracteres.
Obligatorio: No
- LogicalTableMap
-
Configura la combinación y transformación de los datos de las tablas físicas.
Type: Cadena paraLogicalTablemapa de objetos
Entradas de mapa: Número máximo de 64 elementos.
Restricciones de longitud de las Longitud mínima de 1. La longitud máxima es 64.
Patrón de clave:
[0-9a-zA-Z-]*Obligatorio: No
- Permissions
-
Una lista de permisos de recursos en el conjunto de datos.
Type: Matriz deResourcePermissionobjects
Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 64 elementos.
Obligatorio: No
- RowLevelPermissionDataSet
-
La configuración de seguridad de nivel de fila para los datos que desea crear.
Tipo: objeto RowLevelPermissionDataSet
Obligatorio: No
- RowLevelPermissionTagConfiguration
-
La configuración de etiquetas en un conjunto de datos para establecer la seguridad a nivel de fila. Actualmente, las etiquetas de seguridad a nivel de fila solo se admiten para la incrustación anónima.
Tipo: objeto RowLevelPermissionTagConfiguration
Obligatorio: No
- Tags
-
Contiene un mapa de los pares clave-valor para la etiqueta o etiquetas de recursos asignadas al conjunto de datos.
Type: Matriz deTagobjects
Miembros de la matriz: Número mínimo de 1 elemento. Número máximo de 200 elementos.
Obligatorio: No
Sintaxis de la respuesta
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"DataSetId": "string",
"IngestionArn": "string",
"IngestionId": "string",
"RequestId": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.
- Status
-
El estado HTTP de la solicitud.
El servicio devuelve los datos siguientes en formato JSON.
- Arn
-
El nombre de recurso de Amazon (ARN) del conjunto de datos.
Type: Cadena
- DataSetId
-
ID del conjunto de datos que desea crear. Este ID es único porRegión de AWSpara cadaAWSaccount.
Type: Cadena
- IngestionArn
-
El ARN para la ingesta, que se activa como resultado de la creación del conjunto de datos si el modo de importación es SPICE.
Type: Cadena
- IngestionId
-
El ID de la ingesta, que se activa como resultado de la creación del conjunto de datos si el modo de importación es SPICE.
Type: Cadena
- RequestId
-
LaAWSID de solicitud de esta operación.
Type: Cadena
Errores
Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene permiso de acceso. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que sus políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.
Código de estado HTTP: 401
- ConflictException
-
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
- LimitExceededException
-
Se superó un límite.
Código de estado HTTP: 409
- 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 Amazon QuickSighten la que la edición no incluye soporte para esa operación. Amazon QuickSight tiene actualmente Standard Edition y Enterprise Edition. No todas las operaciones y funciones están disponibles en todas las ediciones.
Código de estado HTTP: 403
Ejemplos
Ejemplo
Este ejemplo ilustra un uso de CreateDataSet.
Solicitud de muestra
POST /accounts/{AwsAccountId}/data-sets HTTP/1.1
Content-type: application/jsonVé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:
