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.
API de Calidad de datos
La API de Calidad de datos describe los tipos de datos de la calidad de los datos e incluye la API para crear, eliminar o actualizar conjuntos de reglas, ejecuciones y evaluadores de la calidad de datos.
Tipos de datos
DataSource estructura
Un origen de datos (una tabla de AWS Glue) para obtener los resultados de la calidad de los datos.
Campos
-
GlueTable: obligatorio: objeto GlueTable.Una tabla de AWS Glue.
DataQualityRulesetListDetails estructura
Describe un conjunto de reglas de la calidad de los datos devuelto por GetDataQualityRuleset.
Campos
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas de calidad de datos.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del conjunto de reglas de calidad de datos.
-
La fecha y la hora en que se creó el conjunto de reglas de calidad de datos.
-
LastModifiedOn: marca temporal.La fecha y la hora de la última modificación del conjunto de reglas de calidad de datos.
-
TargetTable: objeto DataQualityTargetTable.Un objeto que representa una tabla de AWS Glue.
-
RecommendationRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Cuando se crea un conjunto de reglas a partir de una ejecución de recomendación, se genera este ID de ejecución para vincularlos ambos.
-
La cantidad de reglas del conjunto de reglas.
DataQualityTargetTable estructura
Un objeto que representa una tabla de AWS Glue.
Campos
-
TableName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre de la tabla de AWS Glue.
-
DatabaseName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre de la base de datos donde se encuentra la tabla de AWS Glue.
DataQualityRulesetEvaluationRunDescription estructura
Describe el resultado de una ejecución de evaluación del conjunto de reglas de calidad de datos.
Campos
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
Status: cadena UTF-8 (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
La fecha y la hora en que inició la ejecución.
-
DataSource: objeto DataSource.El origen de datos (una tabla de AWS Glue) asociado a la ejecución.
DataQualityRulesetEvaluationRunFilter estructura
Los criterios del filtro.
Campos
-
DataSource: obligatorio: objeto DataSource.Filtre en función de un origen de datos (una tabla de AWS Glue) asociado a la ejecución.
-
StartedBefore: marca temporal.Filtre los resultados por las ejecuciones que se iniciaron antes de esta hora.
-
Filtre los resultados por las ejecuciones que se iniciaron después de esta hora.
DataQualityEvaluationRunAdditionalRunOptions estructura
Opciones de ejecución adicionales que puede especificar para una ejecución de evaluación.
Campos
DataQualityRuleRecommendationRunDescription estructura
Describe el resultado de una ejecución de recomendación de reglas de la calidad de los datos.
Campos
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
Status: cadena UTF-8 (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
La fecha y la hora en las que se inició esta ejecución.
-
DataSource: objeto DataSource.El origen de datos (tabla de AWS Glue) asociado a la ejecución de recomendación.
DataQualityRuleRecommendationRunFilter estructura
Se ejecuta un filtro para enumerar las ejecuciones de recomendación de la calidad de los datos.
Campos
-
DataSource: obligatorio: objeto DataSource.Filtre en función de un origen de datos especificado (tabla de AWS Glue).
-
StartedBefore: marca temporal.Filtre en función de la hora de los resultados que se iniciaron antes de la hora indicada.
-
Filtre en función de la hora de los resultados que se iniciaron después de la hora indicada.
DataQualityResult estructura
Describe un resultado de la calidad de los datos.
Campos
-
ResultId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
-
Score: número (doble), 1,0 como máximo.Una puntuación agregada de la calidad de los datos. Representa la relación entre las reglas aprobadas y la cantidad total de reglas.
-
DataSource: objeto DataSource.La tabla asociada al resultado de calidad de datos, si existe.
-
RulesetName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas asociado al resultado de calidad de datos.
-
EvaluationContext: cadena UTF-8.En relación con un trabajo en AWS Glue Studio, a cada nodo del lienzo se le suele asignar algún tipo de nombre y los nodos de calidad de datos tendrán nombres. En el caso de varios nodos,
evaluationContextpuede diferenciar los nodos. -
La fecha y la hora en las que se inició esta ejecución de la calidad de los datos.
-
La fecha y la hora en las que finalizó esta ejecución de la calidad de los datos.
-
JobName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del trabajo asociado al resultado de calidad de datos, si existe.
-
JobRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución del trabajo asociado al resultado de calidad de datos, si existe.
-
RulesetEvaluationRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID único de la ejecución para la evaluación del conjunto de reglas de este resultado de calidad de datos.
-
RuleResults: una matriz de objetos DataQualityRuleResult, con 1 estructura como mínimo y 2000 estructuras como máximo.Una lista de objetos
DataQualityRuleResultque representan los resultados de cada regla.
DataQualityRuleResult estructura
Describe el resultado de la evaluación de la regla de la calidad de datos.
Campos
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre de la regla de la calidad de datos.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Descripción de la regla de la calidad de datos.
-
EvaluationMessage: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Un mensaje de evaluación.
-
Result: cadena UTF-8 (valores válidos:PASS|FAIL|ERROR).Estado de aprobación o rechazo de la regla.
DataQualityResultDescription estructura
Describe un resultado de la calidad de los datos.
Campos
-
ResultId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador único de este resultado de la calidad de datos.
-
DataSource: objeto DataSource.El nombre de la tabla asociada al resultado de la calidad de datos.
-
JobName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del trabajo asociado al resultado de la calidad de datos.
-
JobRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de la ejecución del trabajo asociado al resultado de la calidad de datos.
-
La hora a la que se inició la ejecución de este resultado de la calidad de datos.
DataQualityResultFilterCriteria estructura
Criterios utilizados para devolver los resultados de la calidad de los datos.
Campos
-
DataSource: objeto DataSource.Filtre los resultados por el origen de datos especificado. Por ejemplo, mediante la recuperación de todos los resultados de una tabla de AWS Glue.
-
JobName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Filtre los resultados por el nombre de trabajo indicado.
-
JobRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Filtre los resultados por el identificador de la ejecución de trabajo indicado.
-
Filtre los resultados por las ejecuciones que se iniciaron después de esta hora.
-
StartedBefore: marca temporal.Filtre los resultados por las ejecuciones que se iniciaron antes de esta hora.
DataQualityRulesetFilterCriteria estructura
Criterios utilizados para filtrar los conjuntos de reglas de calidad de datos.
Campos
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre de los criterios del filtro del conjunto de reglas.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.La descripción de los criterios del filtro del conjunto de reglas.
-
CreatedBefore: marca temporal.Filtre los conjuntos de reglas creados antes de esta fecha.
-
Filtre los conjuntos de reglas creados después de esta fecha.
-
LastModifiedBefore: marca temporal.Filtre los últimos conjuntos de reglas modificados antes de esta fecha.
-
LastModifiedAfter: marca temporal.Filtre los últimos conjuntos de reglas modificados después de esta fecha.
-
TargetTable: objeto DataQualityTargetTable.El nombre de la base de datos y el nombre de la tabla de destino.
Operaciones
StartDataQualityRulesetEvaluationRun Acción (Python: start_data_quality_run)
CancelDataQualityRulesetEvaluationRun Acción (Python: cancel_data_quality_run)
GetDataQualityRulesetEvaluationRun Acción (Python: get_data_quality_run)
ListDataQualityRulesetEvaluationRuns Acción (Python: list_data_quality_runs)
StartDataQualityRuleRecommendationRun Acción (Python: start_data_quality_run)
CancelDataQualityRuleRecommendationRun Acción (Python: cancel_data_quality_run)
GetDataQualityRuleRecommendationRun Acción (Python: get_data_quality_run)
ListDataQualityRuleRecommendationRuns Acción (Python: list_data_quality_runs)
GetDataQualityResult Acción (Python: get_data_quality_result)
BatchGetDataQualityResult Acción (Python: batch_data_quality_result)
ListDataQualityResults Acción (Python: list_data_quality_results)
CreateDataQualityRuleset Acción (Python: create_data_quality_ruleset)
DeleteDataQualityRuleset Acción (Python: delete_data_quality_ruleset)
GetDataQualityRuleset Acción (Python: get_data_quality_ruleset)
ListDataQualityRulesets Acción (Python: list_data_quality_rulesets)
UpdateDataQualityRuleset Acción (Python: update_data_quality_ruleset)
StartDataQualityRulesetEvaluationRun Acción (Python: start_data_quality_run)
Una vez que tenga una definición del conjunto de reglas (recomendada o propia), ejecute esta operación para evaluar el conjunto de reglas con respecto a un origen de datos (tabla de AWS Glue). La evaluación calcula los resultados que puede recuperar con la API de GetDataQualityResult.
Solicitud
-
DataSource: obligatorio: objeto DataSource.El origen de datos (tabla de AWS Glue) asociado a esta ejecución.
-
Role– Obligatorio: cadena UTF-8.Un rol de IAM que se proporciona para cifrar los resultados de la ejecución.
-
NumberOfWorkers: número (entero).La cantidad de procesos de trabajo de
G.1Xutilizados para la ejecución. El valor predeterminado es 5. -
Timeout: número (entero), como mínimo 1.El tiempo de espera durante una ejecución en minutos. Es el tiempo máximo que una ejecución puede consumir recursos antes de que se termine y cambie al estado
TIMEOUT. El valor predeterminado es 2880 minutos (48 horas). -
ClientToken: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Se usa para la idempotencia y se recomienda establecerlo en un identificador aleatorio (como un UUID) para evitar crear o iniciar varias instancias del mismo recurso.
-
AdditionalRunOptions: objeto DataQualityEvaluationRunAdditionalRunOptions.Opciones de ejecución adicionales que puede especificar para una ejecución de evaluación.
-
RulesetNames: obligatorio: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.Lista de nombres de conjuntos de reglas.
Respuesta
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Errores
InvalidInputExceptionEntityNotFoundExceptionOperationTimeoutExceptionInternalServiceExceptionConflictException
CancelDataQualityRulesetEvaluationRun Acción (Python: cancel_data_quality_run)
Cancela una ejecución en la que se evalúa un conjunto de reglas con respecto a un origen de datos.
Solicitud
-
RunId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Respuesta
Sin parámetros de respuesta.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
GetDataQualityRulesetEvaluationRun Acción (Python: get_data_quality_run)
Recupera una ejecución específica en la que se evalúa un conjunto de reglas con respecto a un origen de datos.
Solicitud
-
RunId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Respuesta
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
DataSource: objeto DataSource.El origen de datos (una tabla de AWS Glue) asociado a esta ejecución de evaluación.
-
Un rol de IAM que se proporciona para cifrar los resultados de la ejecución.
-
NumberOfWorkers: número (entero).La cantidad de procesos de trabajo de
G.1Xutilizados para la ejecución. El valor predeterminado es 5. -
Timeout: número (entero), como mínimo 1.El tiempo de espera durante una ejecución en minutos. Es el tiempo máximo que una ejecución puede consumir recursos antes de que se termine y cambie al estado
TIMEOUT. El valor predeterminado es 2880 minutos (48 horas). -
AdditionalRunOptions: objeto DataQualityEvaluationRunAdditionalRunOptions.Opciones de ejecución adicionales que puede especificar para una ejecución de evaluación.
-
Status: cadena UTF-8 (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
Las cadenas de error asociadas a la ejecución.
-
La fecha y la hora en las que se inició esta ejecución.
-
LastModifiedOn: marca temporal.Una marca temporal. El último momento dado en el que se modificó esta ejecución de recomendación de la regla de calidad de datos.
-
La fecha y la hora en las que se completó esta ejecución.
-
ExecutionTime: número (entero).El tiempo (en segundos) que la ejecución de flujo de trabajo consumió recursos.
-
RulesetNames: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.Lista de los nombres de los conjuntos de reglas para la ejecución.
-
ResultIds: matriz de cadenas UTF-8, con una cadena como mínimo y 10 cadenas como máximo.Una lista de ID de los resultados de calidad de datos de la ejecución.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRulesetEvaluationRuns Acción (Python: list_data_quality_runs)
Muestra todas las ejecuciones que cumplen los criterios del filtro, donde un conjunto de reglas se evalúa en relación con un origen de datos.
Solicitud
-
Filter: objeto DataQualityRulesetEvaluationRunFilter.Los criterios del filtro.
-
Un token paginado para compensar los resultados.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que devolver.
Respuesta
-
Runs: matriz de objetos DataQualityRulesetEvaluationRunDescription.Una lista de objetos
DataQualityRulesetEvaluationRunDescriptionque representa las ejecuciones de un conjunto de reglas de calidad de datos. -
Un token de paginación, si hay disponibles más resultados.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceException
StartDataQualityRuleRecommendationRun Acción (Python: start_data_quality_run)
Inicia una ejecución de recomendación que se utiliza para generar reglas cuando no sabe qué reglas escribir. AWS Glue Calidad de datos analiza los datos y presenta recomendaciones para un posible conjunto de reglas. A continuación, puede clasificar el conjunto de reglas y modificar el conjunto de reglas generado a su gusto.
Solicitud
-
DataSource: obligatorio: objeto DataSource.El origen de datos (tabla de AWS Glue) asociado a esta ejecución.
-
Role– Obligatorio: cadena UTF-8.Un rol de IAM que se proporciona para cifrar los resultados de la ejecución.
-
NumberOfWorkers: número (entero).La cantidad de procesos de trabajo de
G.1Xutilizados para la ejecución. El valor predeterminado es 5. -
Timeout: número (entero), como mínimo 1.El tiempo de espera durante una ejecución en minutos. Es el tiempo máximo que una ejecución puede consumir recursos antes de que se termine y cambie al estado
TIMEOUT. El valor predeterminado es 2880 minutos (48 horas). -
CreatedRulesetName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un nombre para el conjunto de reglas.
-
ClientToken: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Se usa para la idempotencia y se recomienda establecerlo en un identificador aleatorio (como un UUID) para evitar crear o iniciar varias instancias del mismo recurso.
Respuesta
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionConflictException
CancelDataQualityRuleRecommendationRun Acción (Python: cancel_data_quality_run)
Cancela la ejecución de recomendación especificada que se utilizó para generar las reglas.
Solicitud
-
RunId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Respuesta
Sin parámetros de respuesta.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
GetDataQualityRuleRecommendationRun Acción (Python: get_data_quality_run)
Obtiene la ejecución de recomendación especificada que se utilizó para generar las reglas.
Solicitud
-
RunId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Respuesta
-
RunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
DataSource: objeto DataSource.El origen de datos (una tabla de AWS Glue) asociado a esta ejecución.
-
Un rol de IAM que se proporciona para cifrar los resultados de la ejecución.
-
NumberOfWorkers: número (entero).La cantidad de procesos de trabajo de
G.1Xutilizados para la ejecución. El valor predeterminado es 5. -
Timeout: número (entero), como mínimo 1.El tiempo de espera durante una ejecución en minutos. Es el tiempo máximo que una ejecución puede consumir recursos antes de que se termine y cambie al estado
TIMEOUT. El valor predeterminado es 2880 minutos (48 horas). -
Status: cadena UTF-8 (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
Las cadenas de error asociadas a la ejecución.
-
La fecha y la hora en las que se inició esta ejecución.
-
LastModifiedOn: marca temporal.Una marca temporal. El último momento dado en el que se modificó esta ejecución de recomendación de la regla de calidad de datos.
-
La fecha y la hora en las que se completó esta ejecución.
-
ExecutionTime: número (entero).El tiempo (en segundos) que la ejecución de flujo de trabajo consumió recursos.
-
RecommendedRuleset: cadena UTF-8, con 1 byte de largo como mínimo o 65 536 como máximo.Cuando se completa una ejecución de recomendación de reglas de inicio, se crea un conjunto de reglas recomendado (un conjunto de reglas). Este miembro tiene esas reglas en formato de lenguaje de definición de calidad de datos (DQDL).
-
CreatedRulesetName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas que se creó durante la ejecución.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRuleRecommendationRuns Acción (Python: list_data_quality_runs)
Muestra las ejecuciones de recomendación que cumplen los criterios del filtro.
Solicitud
-
Filter: objeto DataQualityRuleRecommendationRunFilter.Los criterios del filtro.
-
Un token paginado para compensar los resultados.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que devolver.
Respuesta
-
Runs: matriz de objetos DataQualityRuleRecommendationRunDescription.Una lista de objetos
DataQualityRuleRecommendationRunDescription. -
Un token de paginación, si hay disponibles más resultados.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceException
GetDataQualityResult Acción (Python: get_data_quality_result)
Recupera el resultado de una evaluación de la regla de calidad de datos.
Solicitud
-
ResultId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
Respuesta
-
ResultId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
-
Score: número (doble), 1,0 como máximo.Una puntuación agregada de la calidad de los datos. Representa la relación entre las reglas aprobadas y la cantidad total de reglas.
-
DataSource: objeto DataSource.La tabla asociada al resultado de calidad de datos, si existe.
-
RulesetName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas asociado al resultado de calidad de datos.
-
EvaluationContext: cadena UTF-8.En relación con un trabajo en AWS Glue Studio, a cada nodo del lienzo se le suele asignar algún tipo de nombre y los nodos de calidad de datos tendrán nombres. En el caso de varios nodos,
evaluationContextpuede diferenciar los nodos. -
La fecha y la hora en las que se inició la ejecución de este resultado de calidad de datos.
-
La fecha y la hora en las que se completó la ejecución de este resultado de calidad de datos.
-
JobName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del trabajo asociado al resultado de calidad de datos, si existe.
-
JobRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID de la ejecución del trabajo asociado al resultado de calidad de datos, si existe.
-
RulesetEvaluationRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El ID único de ejecución asociado a la evaluación del conjunto de reglas.
-
RuleResults: una matriz de objetos DataQualityRuleResult, con 1 estructura como mínimo y 2000 estructuras como máximo.Una lista de objetos
DataQualityRuleResultque representan los resultados de cada regla.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionEntityNotFoundException
BatchGetDataQualityResult Acción (Python: batch_data_quality_result)
Recupera una lista de los resultados de calidad de datos para los ID de los resultados especificados.
Solicitud
Respuesta
-
Results(obligatorio): una matriz de objetos DataQualityResult.Una lista de objetos
DataQualityResultque representa los resultados de calidad de datos. -
ResultsNotFound: matriz de cadenas UTF-8, con una cadena como mínimo y 100 cadenas como máximo.Una lista de ID de los resultados para los que no se encontraron resultados.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityResults Acción (Python: list_data_quality_results)
Devuelve todos los resultados de la ejecución de calidad de datos de su cuenta.
Solicitud
-
Filter: objeto DataQualityResultFilterCriteria.Los criterios del filtro.
-
Un token paginado para compensar los resultados.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que devolver.
Respuesta
-
Results(obligatorio): una matriz de objetos DataQualityResultDescription.Una lista de objetos
DataQualityResultDescription. -
Un token de paginación, si hay disponibles más resultados.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceException
CreateDataQualityRuleset Acción (Python: create_data_quality_ruleset)
Crea un conjunto de reglas de la calidad de los datos con reglas de DQDL aplicadas a una tabla de AWS Glue especificada.
El conjunto de reglas se crea mediante lenguaje de definición de calidad de datos (DQDL). Para más información, consulte la Guía para desarrolladores de AWS Glue.
Solicitud
-
Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre único para el conjunto de reglas de la calidad de los datos.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del conjunto de reglas de calidad de datos.
-
Ruleset: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 65 536 como máximo.Conjunto de reglas de lenguaje de definición de calidad de datos (DQDL). Para más información, consulte la Guía para desarrolladores de AWS Glue.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Una lista de etiquetas aplicadas al conjunto de reglas de calidad de datos.
-
TargetTable: objeto DataQualityTargetTable.Una tabla de destino asociada al conjunto de reglas de calidad de datos.
-
RecommendationRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un identificador único de ejecución para la ejecución de recomendación.
-
ClientToken: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Se usa para la idempotencia y se recomienda establecerlo en un identificador aleatorio (como un UUID) para evitar crear o iniciar varias instancias del mismo recurso.
Respuesta
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Nombre único para el conjunto de reglas de la calidad de los datos.
Errores
InvalidInputExceptionAlreadyExistsExceptionOperationTimeoutExceptionInternalServiceExceptionResourceNumberLimitExceededException
DeleteDataQualityRuleset Acción (Python: delete_data_quality_ruleset)
Elimina un conjunto de reglas de la calidad de los datos.
Solicitud
-
Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Un nombre para el conjunto de reglas de calidad de datos.
Respuesta
Sin parámetros de respuesta.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
GetDataQualityRuleset Acción (Python: get_data_quality_ruleset)
Devuelve un conjunto de reglas existente por identificador o nombre.
Solicitud
-
Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas.
Respuesta
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del conjunto de reglas.
-
Ruleset: cadena UTF-8, con 1 byte de largo como mínimo o 65 536 como máximo.Conjunto de reglas de lenguaje de definición de calidad de datos (DQDL). Para más información, consulte la Guía para desarrolladores de AWS Glue.
-
TargetTable: objeto DataQualityTargetTable.El nombre de la base de datos y el nombre de la tabla de destino.
-
Una marca temporal. La fecha y la hora en las que se creó este conjunto de reglas de calidad de datos.
-
LastModifiedOn: marca temporal.Una marca temporal. El último momento dado en el que se modificó este conjunto de reglas de calidad de datos.
-
RecommendationRunId: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.Cuando se crea un conjunto de reglas a partir de una ejecución de recomendación, se genera este ID de ejecución para vincularlos ambos.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRulesets Acción (Python: list_data_quality_rulesets)
Devuelve una lista paginada de los conjuntos de reglas para la lista especificada de tablas de AWS Glue.
Solicitud
-
Un token paginado para compensar los resultados.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que devolver.
-
Filter: objeto DataQualityRulesetFilterCriteria.Los criterios del filtro.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.
Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.
Una lista de etiquetas de par clave-valor.
Respuesta
-
Rulesets: matriz de objetos DataQualityRulesetListDetails.Una lista paginada de los conjuntos de reglas para la lista especificada de tablas de AWS Glue.
-
Un token de paginación, si hay disponibles más resultados.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
UpdateDataQualityRuleset Acción (Python: update_data_quality_ruleset)
Actualiza el conjunto de reglas de calidad de datos especificado.
Solicitud
-
Name: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas de calidad de datos.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del conjunto de reglas.
-
Ruleset: cadena UTF-8, con 1 byte de largo como mínimo o 65 536 como máximo.Conjunto de reglas de lenguaje de definición de calidad de datos (DQDL). Para más información, consulte la Guía para desarrolladores de AWS Glue.
Respuesta
-
Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.El nombre del conjunto de reglas de calidad de datos.
-
Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.Una descripción del conjunto de reglas.
-
Ruleset: cadena UTF-8, con 1 byte de largo como mínimo o 65 536 como máximo.Conjunto de reglas de lenguaje de definición de calidad de datos (DQDL). Para más información, consulte la Guía para desarrolladores de AWS Glue.
Errores
EntityNotFoundExceptionAlreadyExistsExceptionIdempotentParameterMismatchExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionResourceNumberLimitExceededException
