API de estatísticas de colunas - AWS Glue

API de estatísticas de colunas

A API de estatísticas de colunas descreve as APIs do AWS Glue para retornar estatísticas em colunas em uma tabela.

Tipos de dados

Estrutura ColumnStatisticsTaskRun

O objeto que mostra os detalhes da execução das estatísticas da coluna.

Campos
  • CustomerId – String UTF-8, não mais de 12 bytes.

    O ID da conta da AWS.

  • ColumnStatisticsTaskRunId: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O identificador para a execução da tarefa de estatísticas de coluna específica.

  • DatabaseName: string UTF-8.

    O banco de dados em que a tabela reside.

  • TableName: string UTF-8.

    O nome da tabela para a qual as estatísticas da coluna são geradas.

  • ColumnNameList – Uma matriz de strings UTF-8.

    Uma lista de nomes de coluna. Se nenhum valor for fornecido, todos os nomes de colunas da tabela serão usados por padrão.

  • CatalogID: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O ID do catálogo de dados no qual reside a tabela. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.

  • Role: string UTF-8.

    O perfil do IAM assumido pelo serviço para gerar estatísticas.

  • SampleSize: número (double), no máximo 100.

    O percentual de linhas usadas para gerar estatísticas. Se nenhum valor for fornecido, a tabela inteira será usada para gerar estatísticas.

  • SecurityConfiguration – String UTF-8 com comprimento não superior a 128 bytes.

    Nome da configuração de segurança usada para criptografar os logs do CloudWatch para a execução da tarefa de estatísticas da coluna.

  • NumberOfWorkers – Número (inteiro), pelo menos 1.

    O número de operadores usados para gerar estatísticas de coluna. O trabalho é pré-configurado para escalar automaticamente para até 25 instâncias.

  • WorkerType: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O tipo dos operadores usados para gerar estatísticas. O padrão é g.1x.

  • ComputationType: string UTF-8 (valores válidos: FULL | INCREMENTAL).

    O tipo de cálculo de estatísticas de coluna.

  • Status – String UTF-8 (valores válidos: STARTING | RUNNING | SUCCEEDED | FAILED | STOPPED).

    O status da execução da tarefa.

  • CreationTime – Timestamp.

    O horário em que a tarefa foi criada.

  • LastUpdated – Timestamp.

    O momento em que a tarefa foi modificada pela última vez.

  • StartTime – Timestamp.

    A hora de início da tarefa.

  • EndTime – Timestamp.

    A hora de término da tarefa.

  • ErrorMessage: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a URI address multi-line string pattern.

    A mensagem de erro para o trabalho.

  • DPUSeconds – Número (dobro), não mais do que None (Nenhum).

    O uso calculado da DPU em segundos para todos os operadores com escalonamento automático.

Estrutura ColumnStatisticsTaskSettings

As configurações para uma tarefa de estatísticas de coluna.

Campos
  • DatabaseName: string UTF-8.

    O nome do banco de dados no qual a tabela reside.

  • TableName: string UTF-8.

    O nome da tabela para a qual as estatísticas de coluna serão geradas.

  • Schedule: um objeto Schedule.

    Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.

  • ColumnNameList – Uma matriz de strings UTF-8.

    Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.

  • CatalogID: string de ID de catálogo com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O ID do catálogo de dados em que o banco de dados reside.

  • Role: string UTF-8.

    O perfil usado para executar as estatísticas de coluna.

  • SampleSize: número (double), no máximo 100.

    O percentual de dados para amostrar.

  • SecurityConfiguration – String UTF-8 com comprimento não superior a 128 bytes.

    Nome da configuração de segurança usada para criptografar os logs do CloudWatch.

  • ScheduleType: string UTF-8 (valores válidos: CRON | AUTO).

    O tipo de programação para uma tarefa de estatísticas de coluna. Os valores possíveis podem ser CRON ou AUTO.

  • SettingSource: string UTF-8 (valores válidos: CATALOG | TABLE).

    A fonte de configuração da tarefa de estatísticas de coluna. Os valores possíveis podem ser CATALOG ou TABLE.

  • LastExecutionAttempt – Um objeto ExecutionAttempt.

    A última ExecutionAttempt da execução da tarefa de estatísticas de coluna.

Estrutura ExecutionAttempt

Uma tentativa de execução de uma tarefa de estatísticas de coluna.

Campos
  • Status: string UTF-8 (valores válidos: FAILED | STARTED).

    O status da última execução da tarefa de estatísticas de coluna.

  • ColumnStatisticsTaskRunId: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    Um ID de execução de tarefa para a última execução da tarefa de estatísticas de coluna.

  • ExecutionTimestamp – Timestamp.

    Um timestamp em que a última execução da tarefa de estatísticas de coluna ocorreu.

  • ErrorMessage: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a URI address multi-line string pattern.

    Uma mensagem de erro associada à última execução da tarefa de estatísticas de coluna.

Operações

Ação StartColumnStatisticsTaskRun (Python: start_column_statistics_task_run)

Inicia a execução de uma tarefa de estatísticas de colunas para uma tabela e colunas especificadas.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para gerar estatísticas.

  • ColumnNameList – Uma matriz de strings UTF-8.

    Uma lista de nomes de colunas para gerar estatísticas. Se nenhum valor for fornecido, todos os nomes de colunas da tabela serão usados por padrão.

  • Role: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O perfil do IAM assumido pelo serviço para gerar estatísticas.

  • SampleSize: número (double), no máximo 100.

    O percentual de linhas usadas para gerar estatísticas. Se nenhum valor for fornecido, a tabela inteira será usada para gerar estatísticas.

  • CatalogID: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O ID do catálogo de dados no qual a tabela reside. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.

  • SecurityConfiguration: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    Nome da configuração de segurança usada para criptografar os logs do CloudWatch para a execução da tarefa de estatísticas da coluna.

Resposta
  • ColumnStatisticsTaskRunId: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O identificador para a execução da tarefa de estatísticas de colunas.

Erros
  • AccessDeniedException

  • EntityNotFoundException

  • ColumnStatisticsTaskRunningException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • InvalidInputException

Ação GetColumnStatisticsTaskRun (Python: get_column_statistics_task_run)

Obtenha os metadados/informações associados para a execução de uma tarefa com um ID de execução de tarefa específico.

Solicitação
  • ColumnStatisticsTaskRunId: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O identificador para a execução da tarefa de estatísticas de coluna específica.

Resposta
  • ColumnStatisticsTaskRun: um objeto ColumnStatisticsTaskRun.

    Um ColumnStatisticsTaskRun objeto que representa os detalhes da execução de estatísticas de colunas.

Erros
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

Ação GetColumnStatisticsTaskRuns (Python: get_column_statistics_task_runs)

Recupera informações sobre todas as execuções associadas à tabela especificada.

Solicitação
  • DatabaseNameObrigatório: string UTF-8.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela.

  • MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

    O tamanho máximo da resposta.

  • NextToken: string UTF-8.

    Um token de continuação, se esta for uma chamada de continuação.

Resposta
  • ColumnStatisticsTaskRuns: um array de objetos ColumnStatisticsTaskRun.

    Uma lista de execuções de tarefas de estatísticas de colunas.

  • NextToken: string UTF-8.

    Um token de continuação, se todas as execuções de tarefas ainda não tiverem sido retornadas.

Erros
  • OperationTimeoutException

Ação ListColumnStatisticsTaskRuns (Python: list_column_statistics_task_runs)

Liste todas as execuções tarefas para uma conta específica.

Solicitação
  • MaxResults – Número (inteiro), superior a 1 ou mais que 1000.

    O tamanho máximo da resposta.

  • NextToken: string UTF-8.

    Um token de continuação, se esta for uma chamada de continuação.

Resposta
  • ColumnStatisticsTaskRunIds – Uma matriz de strings UTF-8, no máximo 100 strings.

    Uma lista IDs de execuções de tarefas de estatísticas de colunas.

  • NextToken: string UTF-8.

    Um token de continuação, se todos os IDs de execução de tarefas ainda não tiverem sido retornados.

Erros
  • OperationTimeoutException

Ação StopColumnStatisticsTaskRun (Python: stop_column_statistics_task_run)

Interrompe a execução de uma tarefa para a tabela especificada.

Solicitação
  • DatabaseNameObrigatório: string UTF-8.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • EntityNotFoundException

  • ColumnStatisticsTaskNotRunningException

  • ColumnStatisticsTaskStoppingException

  • OperationTimeoutException

Ação CreateColumnStatisticsTaskSettings (Python: create_column_statistics_task_settings)

Cria configurações para uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual as estatísticas de coluna serão geradas.

  • Role: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O perfil usado para executar as estatísticas de coluna.

  • Schedule: string UTF-8.

    Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.

  • ColumnNameList – Uma matriz de strings UTF-8.

    Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.

  • SampleSize: número (double), no máximo 100.

    O percentual de dados para amostrar.

  • CatalogID: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O ID do catálogo de dados em que o banco de dados reside.

  • SecurityConfiguration: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    Nome da configuração de segurança usada para criptografar os logs do CloudWatch.

  • Tags: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.

    Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

    Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.

    Um mapa de tags.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • AlreadyExistsException

  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ColumnStatisticsTaskRunningException

Ação UpdateColumnStatisticsTaskSettings (Python: update_column_statistics_task_settings)

Atualiza as configurações para uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual as estatísticas de coluna serão geradas.

  • Role: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O perfil usado para executar as estatísticas de coluna.

  • Schedule: string UTF-8.

    Uma programação para executar as estatísticas de coluna especificada na sintaxe CRON.

  • ColumnNameList – Uma matriz de strings UTF-8.

    Uma lista de nomes de colunas para as quais estatísticas devem ser executadas.

  • SampleSize: número (double), no máximo 100.

    O percentual de dados para amostrar.

  • CatalogID: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O ID do catálogo de dados em que o banco de dados reside.

  • SecurityConfiguration: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    Nome da configuração de segurança usada para criptografar os logs do CloudWatch.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • VersionMismatchException

  • OperationTimeoutException

Ação GetColumnStatisticsTaskSettings (Python: get_column_statistics_task_settings)

Obtém configurações para uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual as estatísticas de coluna serão recuperadas.

Resposta
  • ColumnStatisticsTaskSettings: um objeto ColumnStatisticsTaskSettings.

    Um objeto ColumnStatisticsTaskSettings que representa as configurações da tarefa de estatísticas de coluna.

Erros
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

Ação DeleteColumnStatisticsTaskSettings (Python: delete_column_statistics_task_settings)

Exclui configurações para uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual as estatísticas de coluna serão excluídas.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

Ação StartColumnStatisticsTaskRunSchedule (Python: start_column_statistics_task_run_schedule)

Inicia a programação de execução de uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual a programação de execução de uma tarefa de estatísticas de coluna será iniciada.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

Ação StopColumnStatisticsTaskRunSchedule (Python: stop_column_statistics_task_run_schedule)

Interrompe uma programação de execução de uma tarefa de estatísticas de coluna.

Solicitação
  • DatabaseName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome do banco de dados no qual a tabela reside.

  • TableName: obrigatório: string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a Single-line string pattern.

    O nome da tabela para a qual a programação de execução de uma tarefa de estatísticas de coluna será interrompida.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

Exceções

Estrutura ColumnStatisticsTaskRunningException

Uma exceção lançada quando você tenta iniciar outro trabalho enquanto executa um trabalho de geração de estatísticas de coluna.

Campos
  • Message: string UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura ColumnStatisticsTaskNotRunningException

Uma exceção lançada quando você tenta interromper a execução de uma tarefa quando não há nenhuma tarefa em execução.

Campos
  • Message: string UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura ColumnStatisticsTaskStoppingException

Uma exceção lançada quando você tenta interromper a execução de uma tarefa.

Campos
  • Message: string UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura ColumnStatisticsTaskAutoConcurrencyLimitException

Uma exceção lançada quando você já atingiu o limite de trabalhos simultâneos de estatísticas automáticas.

Campos
  • Message: string UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura InvalidCatalogSettingException

Uma exceção lançada quando há um problema com as configurações do catálogo.

Campos
  • Message: string UTF-8.

    Uma mensagem descrevendo o problema.