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.
Calidad de los datos API
La calidad de los datos API describe los tipos de datos de calidad de los datos e incluye los API necesarios para crear, eliminar o actualizar conjuntos de reglas, ejecuciones y evaluaciones de calidad de los datos.
Tipos de datos
DataSource estructura
Una fuente de datos (una AWS Glue tabla) para la que desea obtener resultados de calidad de datos.
Campos
-
GlueTable: obligatorio: objeto GlueTable.Una AWS Glue tabla.
DataQualityRulesetListDetails estructura
Describe un conjunto de reglas de la calidad de los datos devuelto por GetDataQualityRuleset.
Campos
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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.
-
CreatedOn: marca temporal.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: un objeto DataQualityTargetTable.Objeto que representa una AWS Glue tabla.
-
RecommendationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes, que coinciden conSingle-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.
-
RuleCount: número (entero).La cantidad de reglas del conjunto de reglas.
DataQualityTargetTable estructura
Objeto que representa una AWS Glue tabla.
Campos
-
TableName— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-line string pattern.El nombre de la AWS Glue tabla.
-
DatabaseName— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes, que coincidan conSingle-line string pattern.El nombre de la base de datos en la que existe la AWS Glue tabla.
-
CatalogId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador del catálogo en el que se encuentra la AWS Glue tabla.
DataQualityRulesetEvaluationRunDescription estructura
Describe el resultado de una ejecución de evaluación del conjunto de reglas de calidad de datos.
Campos
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
Status— UTF -8 cadenas (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
StartedOn: marca temporal.La fecha y la hora en que inició la ejecución.
-
DataSource: un objeto DataSource.La fuente de datos (una AWS Glue tabla) asociada a la ejecución.
DataQualityRulesetEvaluationRunFilter estructura
Los criterios del filtro.
Campos
-
DataSource: obligatorio: objeto DataSource.Filtre en función de una fuente de datos (una AWS Glue tabla) asociada a la ejecución.
-
StartedBefore: marca temporal.Filtre los resultados por las ejecuciones que se iniciaron antes de esta hora.
-
StartedAfter: marca temporal.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
-
CloudWatchMetricsEnabled: booleano.Habilitar o no CloudWatch las métricas.
-
ResultsS3Prefix— UTF -8 cuerdas.Prefijo para que Amazon S3 almacene los resultados.
-
CompositeRuleEvaluationMethod— UTF -8 cadenas (valores válidos:COLUMN|ROW).Establezca el método de evaluación de las reglas compuestas en el conjunto de reglas en/ROWCOLUMN
DataQualityRuleRecommendationRunDescription estructura
Describe el resultado de una ejecución de recomendación de reglas de la calidad de los datos.
Campos
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
Status— UTF -8 cadenas (valores válidos:STARTING|RUNNING|STOPPING|STOPPED|SUCCEEDED|FAILED|TIMEOUT).El estado de esta ejecución.
-
StartedOn: marca temporal.La fecha y la hora en las que se inició esta ejecución.
-
DataSource: un objeto DataSource.La fuente de datos (AWS Glue tabla) asociada a la ejecución de recomendaciones.
DataQualityRuleRecommendationRunFilter estructura
Se ejecuta un filtro para enumerar las ejecuciones de recomendación de la calidad de los datos.
Campos
-
DataSource: obligatorio: objeto DataSource.Filtrar en función de una fuente de datos específica (AWS Glue tabla).
-
StartedBefore: marca temporal.Filtre en función de la hora de los resultados que se iniciaron antes de la hora indicada.
-
StartedAfter: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de perfil 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: un objeto DataSource.La tabla asociada al resultado de calidad de datos, si existe.
-
RulesetName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del conjunto de reglas asociado al resultado de calidad de datos.
-
EvaluationContext— UTF -8 cadenas.En el contexto de 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 los datos tendrán nombres. En el caso de varios nodos,
evaluationContextpuede diferenciar los nodos. -
StartedOn: marca temporal.La fecha y la hora en las que se inició esta ejecución de la calidad de los datos.
-
CompletedOn: marca temporal.La fecha y la hora en las que finalizó esta ejecución de la calidad de los datos.
-
JobName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del trabajo asociado al resultado de calidad de datos, si existe.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la ejecución del trabajo asociado al resultado de calidad de datos, si existe.
-
RulesetEvaluationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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: matriz de objetos DataQualityRuleResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityRuleResultque representan los resultados de cada regla. -
AnalyzerResults: matriz de objetos DataQualityAnalyzerResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityAnalyzerResultque representan los resultados de cada analizador. -
Observations: matriz de objetos DataQualityObservation, con 50 estructuras como máximo.Una lista de objetos
DataQualityObservationque representan la observabilidad generada después de evaluar las reglas y los analizadores.
DataQualityAnalyzerResult estructura
Describe el resultado de la evaluación del analizador de la calidad de datos.
Campos
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del analizador de la calidad de datos.
-
Description— UTF -8 cadenas, de una longitud no superior a 2048 bytes, que coinciden con. URI address multi-line string patternDescripción del analizador de la calidad de datos.
-
EvaluationMessage— UTF -8 cadenas, de una longitud no superior a 2048 bytes, que coinciden con. URI address multi-line string patternUn mensaje de evaluación.
-
EvaluatedMetrics: matriz de mapas de pares clave-valor.Cada clave es una cadena de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide con. Single-line string pattern
Cada valor es un número (doble).
Un mapa de las métricas asociadas a la evaluación del analizador.
DataQualityObservation estructura
Describe la observación generada luego de la evaluación de las reglas y los analizadores.
Campos
-
Description— UTF -8 cadenas, de no más de 2048 bytes de longitud, que coinciden con. URI address multi-line string patternUna descripción de la observación de la calidad de datos.
-
MetricBasedObservation: un objeto MetricBasedObservation.Un objeto de tipo
MetricBasedObservationque representa la observación basada en las métricas evaluadas de la calidad de datos.
MetricBasedObservation estructura
Describe la observación generada según las métricas basada en las métricas evaluadas de la calidad de datos.
Campos
-
MetricName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la métrica de calidad de datos utilizada para la generación de la observación.
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la estadística.
-
MetricValues: un objeto DataQualityMetricValues.Un objeto de tipo
DataQualityMetricValuesque representa el análisis del valor de la métrica de la calidad de datos. -
NewRules— Una matriz de UTF -8 cadenas.Una lista de reglas de calidad de datos nuevas generadas como parte de la observación basada en el valor de la métrica de la calidad de datos.
DataQualityMetricValues estructura
Describe el valor de la métrica de la calidad de datos según el análisis de los datos históricos.
Campos
-
ActualValue: número (doble).El valor real de la métrica de la calidad de datos.
-
ExpectedValue: número (doble).El valor esperado de la métrica de la calidad de datos según el análisis de los datos históricos.
-
LowerLimit: número (doble).El valor más bajo del valor de la métrica de la calidad de datos según el análisis de los datos históricos.
-
UpperLimit: número (doble).El valor más alto del valor de la métrica de la calidad de datos según el análisis de los datos históricos.
DataQualityRuleResult estructura
Describe el resultado de la evaluación de la regla de la calidad de datos.
Campos
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la regla de la calidad de datos.
-
Description— UTF -8 cadenas, de una longitud no superior a 2048 bytes, que coinciden con. URI address multi-line string patternDescripción de la regla de la calidad de datos.
-
EvaluationMessage— UTF -8 cadenas, de una longitud no superior a 2048 bytes, que coinciden con. URI address multi-line string patternUn mensaje de evaluación.
-
Result— UTF -8 cadenas (valores válidos:PASS|FAIL|ERROR).Estado de aprobación o rechazo de la regla.
-
EvaluatedMetrics: matriz de mapas de pares clave-valor.Cada clave es una cadena de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide conSingle-line string pattern.
Cada valor es un número (doble).
Un mapa de métricas asociadas a la evaluación de la regla.
-
EvaluatedRule— UTF -8 cadenas, de no más de 2048 bytes de longitud, que coinciden con. URI address multi-line string patternLa regla evaluada.
DataQualityResultDescription estructura
Describe un resultado de la calidad de los datos.
Campos
-
ResultId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador único de este resultado de la calidad de datos.
-
DataSource: un objeto DataSource.El nombre de la tabla asociada al resultado de la calidad de datos.
-
JobName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del trabajo asociado al resultado de la calidad de datos.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de la ejecución del trabajo asociado al resultado de la calidad de datos.
-
StartedOn: marca temporal.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: un objeto DataSource.Filtre los resultados por el origen de datos especificado. Por ejemplo, recuperar todos los resultados de una AWS Glue tabla.
-
JobName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternFiltre los resultados por el nombre de trabajo indicado.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Filtre los resultados por el identificador de la ejecución de trabajo indicado.
-
StartedAfter: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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.
-
CreatedAfter: marca temporal.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: un objeto DataQualityTargetTable.El nombre de la base de datos y el nombre de la tabla de destino.
StatisticAnnotation estructura
Una anotación estadística.
Campos
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID del perfil.
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la estadística.
-
StatisticRecordedOn: marca temporal.La marca temporal en la que se registró la estadística anotada.
-
InclusionAnnotation: un objeto TimestampedInclusionAnnotation.La anotación de inclusión aplicada a la estadística.
TimestampedInclusionAnnotation estructura
Una anotación de inclusión con fecha y hora.
Campos
-
Value— UTF -8 cadenas (valores válidos: |).INCLUDEEXCLUDEEl valor de la anotación de inclusión.
-
LastModifiedOn: marca temporal.La marca temporal en la que se modificó por última vez la anotación de inclusión.
AnnotationError estructura
Una anotación fallida.
Campos
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID de perfil de la anotación fallida.
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl identificador de estadística de la anotación fallida.
-
FailureReason: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.El motivo por el que se produjo un error en la anotación.
DatapointInclusionAnnotation estructura
Una anotación de inclusión.
Campos
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID del perfil de calidad de los datos al que pertenece la estadística.
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID de la estadística.
-
InclusionAnnotation— UTF -8 cadenas (valores válidos:INCLUDE|EXCLUDE).El valor de la anotación de inclusión que se va a aplicar a la estadística.
StatisticSummaryList lista
Lista de StatisticSummary.
Una matriz de objetos StatisticSummary.
Lista de StatisticSummary.
StatisticSummary estructura
Información resumida sobre una estadística.
Campos
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID de la estadística.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID del perfil.
-
RunIdentifier: un objeto RunIdentifier.El identificador de ejecución
-
StatisticName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conCustom string pattern #32.El nombre de la estadística.
-
DoubleValue: número (doble).El valor de la estadística.
-
EvaluationLevel— UTF -8 cadenas (valores válidos:Dataset="DATASET"|Column="COLUMN"|Multicolumn="MULTICOLUMN").El nivel de evaluación de la estadística. Valores posibles:
Dataset,Column,Multicolumn. -
ColumnsReferenced— Un conjunto de UTF -8 cadenas.La lista de columnas a las que hace referencia la estadística.
-
ReferencedDatasets— Un conjunto de UTF -8 cadenas.La lista de conjuntos de datos a los que hace referencia la estadística.
-
StatisticProperties: matriz de mapas de pares clave-valor.Cada clave es una cadena de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide con. Single-line string pattern
Cada valor es una cadena Description (Descripción), con 2048 bytes de largo como máximo, que coincide con URI address multi-line string pattern.
A
StatisticPropertiesMap, que contiene unaNameStringyDescriptionString -
RecordedOn: marca temporal.La marca de tiempo en que se registró la estadística.
-
InclusionAnnotation: un objeto TimestampedInclusionAnnotation.La anotación de inclusión de la estadística.
RunIdentifier estructura
Un identificador de ejecución.
Campos
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de ejecución.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de Job Run.
StatisticModelResult estructura
El resultado del modelo estadístico.
Campos
-
LowerBound: número (doble).El límite inferior.
-
UpperBound: número (doble).El límite superior.
-
PredictedValue: número (doble).El valor previsto.
-
ActualValue: número (doble).El valor real.
-
Date: marca temporal.La fecha.
-
InclusionAnnotation— UTF -8 cadenas (valores válidos:INCLUDE|EXCLUDE).La anotación de inclusión.
Operaciones
StartDataQualityRulesetEvaluationRun acción (Python: start_data_quality_ruleset_evaluation_run)
CancelDataQualityRulesetEvaluationRun acción (Python: cancel_data_quality_ruleset_evaluation_run)
GetDataQualityRulesetEvaluationRun acción (Python: get_data_quality_ruleset_evaluation_run)
ListDataQualityRulesetEvaluationRuns acción (Python: list_data_quality_ruleset_evaluation_runs)
StartDataQualityRuleRecommendationRun acción (Python: start_data_quality_rule_recommendation_run)
CancelDataQualityRuleRecommendationRun acción (Python: cancel_data_quality_rule_recommendation_run)
GetDataQualityRuleRecommendationRun acción (Python: get_data_quality_rule_recommendation_run)
ListDataQualityRuleRecommendationRuns acción (Python: list_data_quality_rule_recommendation_runs)
GetDataQualityResult acción (Python: get_data_quality_result)
BatchGetDataQualityResult acción (Python: batch_get_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)
ListDataQualityStatistics acción (Python: list_data_quality_statistics)
BatchPutDataQualityStatisticAnnotation acción (Python: batch_put_data_quality_statistic_annotation)
GetDataQualityModelResult acción (Python: get_data_quality_model_result)
ListDataQualityStatisticAnnotations acción (Python: list_data_quality_statistic_annotations)
PutDataQualityProfileAnnotation acción (Python: put_data_quality_profile_annotation)
StartDataQualityRulesetEvaluationRun acción (Python: start_data_quality_ruleset_evaluation_run)
Una vez que tenga una definición de conjunto de reglas (recomendada o propia), llame a esta operación para evaluar el conjunto de reglas con respecto a una fuente de datos (tabla).AWS Glue La evaluación calcula los resultados que puede recuperar con. GetDataQualityResult API
Solicitud
-
DataSource: obligatorio: objeto DataSource.La fuente de datos (AWS Glue tabla) asociada a esta ejecución.
-
Role— Necesario: UTF -8 cadenas.Se proporciona una IAM función 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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternSe usa para la idempotencia y se recomienda configurarlo con un identificador aleatorio (como aUUID) para evitar crear o iniciar varias instancias del mismo recurso.
-
AdditionalRunOptions: un objeto DataQualityEvaluationRunAdditionalRunOptions.Opciones de ejecución adicionales que puede especificar para una ejecución de evaluación.
-
RulesetNames— Obligatorio: una matriz de UTF -8 cadenas, no menos de 1 ni más de 10 cadenas.Lista de nombres de conjuntos de reglas.
-
AdditionalDataSources: matriz de mapas de pares clave-valor.Cada clave es una cadena de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide conSingle-line string pattern.
Cada valor es un objeto A DataSource.
Un mapa de cadenas de referencia a orígenes de datos adicionales que puede especificar para una ejecución de evaluación.
Respuesta
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
Errores
InvalidInputExceptionEntityNotFoundExceptionOperationTimeoutExceptionInternalServiceExceptionConflictException
CancelDataQualityRulesetEvaluationRun acción (Python: cancel_data_quality_ruleset_evaluation_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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl 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_ruleset_evaluation_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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl identificador de ejecución único asociado a esta ejecución.
Respuesta
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
DataSource: un objeto DataSource.La fuente de datos (una AWS Glue tabla) asociada a esta ejecución de evaluación.
-
Role— UTF -8 cadenas.Un IAM rol proporcionado 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: un objeto DataQualityEvaluationRunAdditionalRunOptions.Opciones de ejecución adicionales que puede especificar para una ejecución de evaluación.
-
Status— UTF -8 cadenas (valores válidos:STARTING| |RUNNING|STOPPING|STOPPED|SUCCEEDEDFAILED|TIMEOUT).El estado de esta ejecución.
-
ErrorString— UTF -8 cadenas.Las cadenas de error asociadas a la ejecución.
-
StartedOn: marca temporal.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.
-
CompletedOn: marca temporal.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— Un conjunto de UTF -8 cadenas, no menos de 1 ni más de 10 cadenas.Lista de los nombres de los conjuntos de reglas para la ejecución. Actualmente, este parámetro solo puede tener un nombre para el conjunto de reglas.
-
ResultIds— Una matriz de UTF -8 cadenas, no menos de 1 ni más de 10 cadenas.Una lista de los resultados IDs de calidad de los datos de la ejecución.
-
AdditionalDataSources: matriz de mapas de pares clave-valor.Cada clave es una cadena de UTF -8 caracteres, de no menos de 1 ni más de 255 bytes de longitud, que coincide conSingle-line string pattern.
Cada valor es un objeto A DataSource.
Un mapa de cadenas de referencia a orígenes de datos adicionales que puede especificar para una ejecución de evaluación.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRulesetEvaluationRuns acción (Python: list_data_quality_ruleset_evaluation_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: un objeto DataQualityRulesetEvaluationRunFilter.Los criterios del filtro.
-
NextTokenUTF— -8 cadenas.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. -
NextToken— UTF -8 cuerdas.Un token de paginación, si hay disponibles más resultados.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceException
StartDataQualityRuleRecommendationRun acción (Python: start_data_quality_rule_recommendation_run)
Inicia una serie de recomendaciones que se utiliza para generar reglas cuando no se sabe qué reglas escribir. AWS Glue Data Quality 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.
Las ejecuciones de recomendaciones se eliminan automáticamente después de 90 días.
Solicitud
La solicitud de recomendación de la regla de calidad de los datos.
-
DataSource: obligatorio: objeto DataSource.La fuente de datos (AWS Glue tabla) asociada a esta ejecución.
-
Role— Necesario: UTF -8 cadenas.Se proporciona una IAM función 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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternUn nombre para el conjunto de reglas.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
-
ClientToken— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Se usa para la idempotencia y se recomienda configurarlo con un identificador aleatorio (como aUUID) para evitar crear o iniciar varias instancias del mismo recurso.
Respuesta
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl identificador de ejecución único asociado a esta ejecución.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionConflictException
CancelDataQualityRuleRecommendationRun acción (Python: cancel_data_quality_rule_recommendation_run)
Cancela la ejecución de recomendación especificada que se utilizó para generar las reglas.
Solicitud
-
RunId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl 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_rule_recommendation_run)
Obtiene la ejecución de recomendación especificada que se utilizó para generar las reglas.
Solicitud
-
RunId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl identificador de ejecución único asociado a esta ejecución.
Respuesta
Se ejecutó la respuesta a la recomendación de la regla de calidad de los datos.
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
DataSource: un objeto DataSource.La fuente de datos (una AWS Glue tabla) asociada a esta ejecución.
-
Role— UTF -8 cadenas.Un IAM rol proporcionado 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— UTF -8 cadenas (valores válidos:STARTING| |RUNNING|STOPPING|STOPPED|SUCCEEDEDFAILED|TIMEOUT).El estado de esta ejecución.
-
ErrorString— UTF -8 cadenas.Las cadenas de error asociadas a la ejecución.
-
StartedOn: marca temporal.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.
-
CompletedOn: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.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 Data Quality Definition Language (DQDL).
-
CreatedRulesetName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del conjunto de reglas que se creó durante la ejecución.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRuleRecommendationRuns acción (Python: list_data_quality_rule_recommendation_runs)
Muestra las ejecuciones de recomendación que cumplen los criterios del filtro.
Solicitud
-
Filter: un objeto DataQualityRuleRecommendationRunFilter.Los criterios del filtro.
-
NextTokenUTF— -8 cadenas.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. -
NextToken— UTF -8 cuerdas.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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternUn identificador de resultado único para el resultado de la calidad de los datos.
Respuesta
La respuesta al resultado de calidad de los datos.
-
ResultId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de perfil 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: un objeto DataSource.La tabla asociada al resultado de calidad de datos, si existe.
-
RulesetName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del conjunto de reglas asociado al resultado de calidad de datos.
-
EvaluationContext— UTF -8 cadenas.En el contexto de 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 los datos tendrán nombres. En el caso de varios nodos,
evaluationContextpuede diferenciar los nodos. -
StartedOn: marca temporal.La fecha y la hora en las que se inició la ejecución de este resultado de calidad de datos.
-
CompletedOn: marca temporal.La fecha y la hora en las que se completó la ejecución de este resultado de calidad de datos.
-
JobName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del trabajo asociado al resultado de calidad de datos, si existe.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la ejecución del trabajo asociado al resultado de calidad de datos, si existe.
-
RulesetEvaluationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID único de ejecución asociado a la evaluación del conjunto de reglas.
-
RuleResults: matriz de objetos DataQualityRuleResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityRuleResultque representan los resultados de cada regla. -
AnalyzerResults: matriz de objetos DataQualityAnalyzerResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityAnalyzerResultque representan los resultados de cada analizador. -
Observations: matriz de objetos DataQualityObservation, con 50 estructuras como máximo.Una lista de objetos
DataQualityObservationque representan la observabilidad generada después de evaluar las reglas y los analizadores.
Errores
InvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionEntityNotFoundException
BatchGetDataQualityResult acción (Python: batch_get_data_quality_result)
Recupera una lista de los resultados de calidad de los datos para el resultado especificado. IDs
Solicitud
-
ResultIds— Obligatorio: una matriz de UTF -8 cadenas, no menos de 1 ni más de 100 cadenas.Una lista de resultados únicos IDs para los resultados de calidad de los datos.
Respuesta
-
Results(obligatorio): una matriz de objetos DataQualityResult.Una lista de objetos
DataQualityResultque representa los resultados de calidad de datos. -
ResultsNotFound— Una matriz de UTF -8 cadenas, no menos de 1 ni más de 100 cadenas.Lista de resultados IDs para los que no se han encontrado 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: un objeto DataQualityResultFilterCriteria.Los criterios del filtro.
-
NextTokenUTF— -8 cadenas.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. -
NextToken— UTF -8 cuerdas.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 calidad de datos con reglas aplicadas a una tabla específica. DQDL AWS Glue
El conjunto de reglas se crea mediante el lenguaje de definición de calidad de datos (). DQDL Para obtener más información, consulta la guía para AWS Glue desarrolladores.
Solicitud
Una solicitud para crear un conjunto de reglas de calidad de datos.
-
Name— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternNombre ú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: UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena de UTF 8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.
Cada valor es una cadena de UTF -8, con una longitud máxima de 256 bytes.
Una lista de etiquetas aplicadas al conjunto de reglas de calidad de datos.
-
TargetTable: un objeto DataQualityTargetTable.Una tabla de destino asociada al conjunto de reglas de calidad de datos.
-
RecommendationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Un identificador único de ejecución para la ejecución de recomendación.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
-
ClientToken— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Se usa para la idempotencia y se recomienda configurarlo con un identificador aleatorio (como aUUID) para evitar crear o iniciar varias instancias del mismo recurso.
Respuesta
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternNombre ú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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternUn 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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl nombre del conjunto de reglas.
Respuesta
Devuelve la respuesta del conjunto de reglas de calidad de los datos.
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl 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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
-
TargetTable: un objeto DataQualityTargetTable.El nombre de la base de datos y el nombre de la tabla de destino.
-
CreatedOn: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityRulesets acción (Python: list_data_quality_rulesets)
Devuelve una lista paginada de conjuntos de reglas para la lista de tablas especificada. AWS Glue
Solicitud
-
NextToken— -8 cadenasUTF.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: un 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 de UTF -8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.
Cada valor es una cadena de UTF -8, con una longitud máxima de 256 bytes.
Una lista de etiquetas de par clave-valor.
Respuesta
-
Rulesets: matriz de objetos DataQualityRulesetListDetails.Una lista paginada de conjuntos de reglas para la lista de tablas especificada. AWS Glue
-
NextToken— -8 cadenasUTF.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: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl 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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
Respuesta
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
Errores
EntityNotFoundExceptionAlreadyExistsExceptionIdempotentParameterMismatchExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionResourceNumberLimitExceededException
ListDataQualityStatistics acción (Python: list_data_quality_statistics)
Recupera una lista de estadísticas de calidad de datos.
Solicitud
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID de la estadística.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID del perfil.
-
TimestampFilter: un objeto TimestampFilter.Un filtro de fecha y hora.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que se devuelven en esta solicitud.
-
NextToken— UTF -8 cuerdas.Un token de paginación para solicitar la siguiente página de resultados.
Respuesta
-
Statistics: matriz de objetos StatisticSummary.Una
StatisticSummaryList. -
NextToken— UTF -8 cadenas.Un token de paginación para solicitar la siguiente página de resultados.
Errores
EntityNotFoundExceptionInvalidInputExceptionInternalServiceException
TimestampFilter estructura
Un filtro de fecha y hora.
Campos
-
RecordedBefore: marca temporal.La marca de tiempo antes de la cual se deben incluir las estadísticas en los resultados.
-
RecordedAfter: marca temporal.La marca temporal después de la cual se deben incluir las estadísticas en los resultados.
CreateDataQualityRulesetRequest estructura
Una solicitud para crear un conjunto de reglas de calidad de datos.
Campos
-
Name— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternNombre ú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: UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
-
Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.Cada clave es una cadena de UTF 8 caracteres, con una longitud no inferior a 1 ni superior a 128 bytes.
Cada valor es una cadena de UTF -8, con una longitud máxima de 256 bytes.
Una lista de etiquetas aplicadas al conjunto de reglas de calidad de datos.
-
TargetTable: un objeto DataQualityTargetTable.Una tabla de destino asociada al conjunto de reglas de calidad de datos.
-
RecommendationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Un identificador único de ejecución para la ejecución de recomendación.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
-
ClientToken— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Se usa para la idempotencia y se recomienda configurarlo con un identificador aleatorio (como aUUID) para evitar crear o iniciar varias instancias del mismo recurso.
GetDataQualityRulesetResponse estructura
Devuelve la respuesta del conjunto de reglas de calidad de los datos.
Campos
-
Name— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl 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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.Conjunto de reglas del lenguaje de definición de calidad de datos (DQDL). Para obtener más información, consulta la guía para AWS Glue desarrolladores.
-
TargetTable: un objeto DataQualityTargetTable.El nombre de la base de datos y el nombre de la tabla de destino.
-
CreatedOn: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-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.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
GetDataQualityResultResponse estructura
La respuesta al resultado de calidad de los datos.
Campos
-
ResultId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Un identificador de resultado único para el resultado de la calidad de los datos.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de perfil 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: un objeto DataSource.La tabla asociada al resultado de calidad de datos, si existe.
-
RulesetName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del conjunto de reglas asociado al resultado de calidad de datos.
-
EvaluationContext— UTF -8 cadenas.En el contexto de 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 los datos tendrán nombres. En el caso de varios nodos,
evaluationContextpuede diferenciar los nodos. -
StartedOn: marca temporal.La fecha y la hora en las que se inició la ejecución de este resultado de calidad de datos.
-
CompletedOn: marca temporal.La fecha y la hora en las que se completó la ejecución de este resultado de calidad de datos.
-
JobName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del trabajo asociado al resultado de calidad de datos, si existe.
-
JobRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la ejecución del trabajo asociado al resultado de calidad de datos, si existe.
-
RulesetEvaluationRunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID único de ejecución asociado a la evaluación del conjunto de reglas.
-
RuleResults: matriz de objetos DataQualityRuleResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityRuleResultque representan los resultados de cada regla. -
AnalyzerResults: matriz de objetos DataQualityAnalyzerResult, con 2000 estructuras como máximo.Una lista de objetos
DataQualityAnalyzerResultque representan los resultados de cada analizador. -
Observations: matriz de objetos DataQualityObservation, con 50 estructuras como máximo.Una lista de objetos
DataQualityObservationque representan la observabilidad generada después de evaluar las reglas y los analizadores.
StartDataQualityRuleRecommendationRunRequest estructura
La solicitud de recomendación de la norma de calidad de los datos.
Campos
-
DataSource: obligatorio: objeto DataSource.La fuente de datos (AWS Glue tabla) asociada a esta ejecución.
-
Role— Necesario: UTF -8 cadenas.Se proporciona una IAM función 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— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternUn nombre para el conjunto de reglas.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
-
ClientToken— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.Se usa para la idempotencia y se recomienda configurarlo con un identificador aleatorio (como aUUID) para evitar crear o iniciar varias instancias del mismo recurso.
GetDataQualityRuleRecommendationRunResponse estructura
Se ejecutó la respuesta a la recomendación de la regla de calidad de los datos.
Campos
-
RunId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El identificador de ejecución único asociado a esta ejecución.
-
DataSource: un objeto DataSource.La fuente de datos (una AWS Glue tabla) asociada a esta ejecución.
-
Role— UTF -8 cadenas.Un IAM rol proporcionado 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— UTF -8 cadenas (valores válidos:STARTING| |RUNNING|STOPPING|STOPPED|SUCCEEDEDFAILED|TIMEOUT).El estado de esta ejecución.
-
ErrorString— UTF -8 cadenas.Las cadenas de error asociadas a la ejecución.
-
StartedOn: marca temporal.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.
-
CompletedOn: marca temporal.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— UTF -8 cadenas, de no menos de 1 ni más de 65536 bytes de longitud.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 Data Quality Definition Language (DQDL).
-
CreatedRulesetName— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre del conjunto de reglas que se creó durante la ejecución.
-
DataQualitySecurityConfiguration— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El nombre de la configuración de seguridad que se creó con la opción de cifrado de la calidad de los datos.
BatchPutDataQualityStatisticAnnotation acción (Python: batch_put_data_quality_statistic_annotation)
Anote los puntos de datos a lo largo del tiempo para obtener una estadística de calidad de datos específica.
Solicitud
-
InclusionAnnotations(obligatorio): una matriz de objetos DatapointInclusionAnnotation.Una lista de.
DatapointInclusionAnnotation -
ClientToken— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes, que coinciden conSingle-line string pattern.Token de cliente.
Respuesta
-
FailedInclusionAnnotations: matriz de objetos AnnotationError.Una lista
AnnotationErrorde.
Errores
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionResourceNumberLimitExceededException
GetDataQualityModel acción (Python: get_data_quality_model)
Recupera el estado de entrenamiento del modelo junto con más información (,,). CompletedOn StartedOn FailureReason
Solicitud
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID de la estadística.
-
ProfileId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-line string pattern.El ID del perfil.
Respuesta
-
Status— UTF -8 cadenas (valores válidos:RUNNING|SUCCEEDED|FAILED).El estado de entrenamiento del modelo de calidad de los datos.
-
StartedOn: marca temporal.La marca temporal en la que se inició el entrenamiento del modelo de calidad de datos.
-
CompletedOn: marca temporal.La marca de tiempo en que se completó el entrenamiento del modelo de calidad de datos.
-
FailureReason— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl motivo del fracaso del entrenamiento.
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
GetDataQualityModelResult acción (Python: get_data_quality_model_result)
Recupera las predicciones de una estadística para un ID de perfil determinado.
Solicitud
-
StatisticId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl ID de la estadística.
-
ProfileId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan conSingle-line string pattern.El ID del perfil.
Respuesta
-
CompletedOn: marca temporal.La marca temporal en la que se completó el entrenamiento del modelo de calidad de datos.
-
Model: matriz de objetos StatisticModelResult.Una lista de
StatisticModelResult
Errores
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceException
ListDataQualityStatisticAnnotations acción (Python: list_data_quality_statistic_annotations)
Recupera las anotaciones de una estadística de calidad de datos.
Solicitud
-
StatisticId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden con. Single-line string patternEl ID de la estadística.
-
ProfileId— UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coinciden conSingle-line string pattern.El ID del perfil.
-
TimestampFilter: un objeto TimestampFilter.Un filtro de fecha y hora.
-
MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.El número máximo de resultados que se devuelven en esta solicitud.
-
NextToken— UTF -8 cuerdas.Un token de paginación para recuperar el siguiente conjunto de resultados.
Respuesta
-
Annotations: matriz de objetos StatisticAnnotation.Una lista de los
StatisticAnnotationaplicados a la estadística -
NextToken— UTF -8 cadenas.Un token de paginación para recuperar el siguiente conjunto de resultados.
Errores
InvalidInputExceptionInternalServiceException
PutDataQualityProfileAnnotation acción (Python: put_data_quality_profile_annotation)
Anota todos los puntos de datos de un perfil.
Solicitud
-
ProfileId— Obligatorio: UTF -8 cadenas, de no menos de 1 ni más de 255 bytes de longitud, que coincidan con. Single-line string patternEl ID del perfil de supervisión de la calidad de los datos que se va a anotar.
-
InclusionAnnotation— Obligatorio: UTF -8 cadenas (valores válidos:INCLUDE|EXCLUDE).El valor de la anotación de inclusión que se va a aplicar al perfil.
Respuesta
Sin parámetros de respuesta.
Errores
EntityNotFoundExceptionInvalidInputExceptionInternalServiceException
