API do otimizador de tabelas
A API do otimizador de tabelas descreve a API do AWS Glue para habilitar a compactação a fim de melhorar a performance de leitura.
Tipos de dados
Estrutura do TableOptimizer
Contém detalhes sobre um otimizador associado a uma tabela.
Campos
-
type
– String UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas. Os valores válidos são:
-
compaction
: para gerenciar a compactação com um otimizador de tabela. -
retention
: para gerenciar a retenção de snapshots com um otimizador de tabela. -
orphan_file_deletion
: para gerenciar a exclusão de arquivos órfãos com um otimizador de tabela.
-
-
configuration
: um objeto TableOptimizerConfiguration.Um objeto
TableOptimizerConfiguration
que foi especificado ao criar ou atualizar um otimizador de tabelas. -
lastRun
: um objeto TableOptimizerRun.Um objeto
TableOptimizerRun
que representa a última execução do otimizador de tabelas.
Estrutura do TableOptimizerConfiguration
Contém detalhes sobre a configuração de um otimizador de tabelas. Você passa essa configuração ao criar ou atualizar um otimizador de tabelas.
Campos
-
roleArn
– String UTF-8, superior a 20 e inferior a 2048 bytes de comprimento, correspondente a Single-line string pattern.Uma função passada pelo chamador que concede ao serviço permissão para atualizar os recursos associados ao otimizador em nome do chamador.
-
enabled
: booleano.Se a otimização da tabela está habilitada.
-
vpcConfiguration
: um objeto TableOptimizerVpcConfiguration.Um objeto
TableOptimizerVpcConfiguration
que representa a configuração da VPC de um otimizador de tabela.Essa configuração é necessária para a execução da otimização de tabelas que estão na VPC de um cliente.
-
retentionConfiguration
: um objeto RetentionConfiguration.A configuração de um otimizador de retenção de snapshots.
-
orphanFileDeletionConfiguration
– Um objeto OrphanFileDeletionConfiguration.A configuração de um otimizador de exclusão de arquivos órfãos.
Estrutura de TableOptimizerVpcConfiguration
Um objeto que descreve a configuração da VPC de um otimizador de tabela.
Essa configuração é necessária para a execução da otimização de tabelas que estão na VPC de um cliente.
Campos
-
glueConnectionName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome da conexão do AWS Glue usada para a VPC do otimizador de tabelas.
Estrutura TableOptimizerRun
Contém detalhes para a execução de um otimizador de tabelas.
Campos
-
eventType
– String UTF-8 (valores válidos:starting="STARTING"
|completed="COMPLETED"
|failed="FAILED"
|in_progress="IN_PROGRESS"
).Um tipo de evento que representa o status da execução do otimizador de tabelas.
-
startTimestamp
– Timestamp.Representa a marca de data e hora do epoch em que o trabalho de compactação foi iniciado no Lake Formation.
-
endTimestamp
– Timestamp.Representa a marca de data e hora do epoch em que o trabalho de compactação terminou.
-
metrics
: um objeto RunMetrics.Um objeto
RunMetrics
que contém métricas para a execução do otimizador.Esse membro é obsoleto. Veja os membros individuais da métrica para compactação, retenção e exclusão de arquivos órfãos.
-
error
: string UTF-8.Um erro que ocorreu durante a execução do otimizador.
-
compactionMetrics
: um objeto CompactionMetrics.Um objeto
CompactionMetrics
que contém métricas para a execução do otimizador. -
retentionMetrics
: um objeto RetentionMetrics.Um objeto
RetentionMetrics
que contém métricas para a execução do otimizador. -
orphanFileDeletionMetrics
– Um objeto OrphanFileDeletionMetrics.Um objeto
OrphanFileDeletionMetrics
que contém métricas para a execução do otimizador.
Estrutura BatchGetTableOptimizerEntry
Representa um otimizador de tabelas a ser recuperado na operação BatchGetTableOptimizer
.
Campos
-
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 de catálogo da tabela.
-
databaseName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome do banco de dados no catálogo em que a tabela reside.
-
tableName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome da tabela.
-
type
– String UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
Estrutura BatchTableTableOptimizer
Contém detalhes de um dos otimizadores de tabela retornados pela operação BatchGetTableOptimizer
.
Campos
-
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 de catálogo da tabela.
-
databaseName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome do banco de dados no catálogo em que a tabela reside.
-
tableName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome da tabela.
-
tableOptimizer
: um objeto TableOptimizer.Um objeto
TableOptimizer
que contém detalhes da configuração e da última execução de um otimizador de tabelas.
Estrutura BatchGetTableOptimizerError
Contém detalhes sobre um dos erros na lista de erros retornada pela operação BatchGetTableOptimizer
.
Campos
-
error
– Um objeto ErrorDetail.Um objeto
ErrorDetail
que contém detalhes de código e mensagens sobre o erro. -
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 de catálogo da tabela.
-
databaseName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome do banco de dados no catálogo em que a tabela reside.
-
tableName
: string UTF-8 com pelo menos 1 byte de comprimento.O nome da tabela.
-
type
– String UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
Estrutura RetentionConfiguration
A configuração de um otimizador de retenção de snapshots.
Campos
-
icebergConfiguration
– Um objeto IcebergRetentionConfiguration.A configuração de um otimizador de retenção de snapshots do Iceberg.
Estrutura IcebergRetentionConfiguration
A configuração de um otimizador de retenção de snapshots do Iceberg.
Campos
-
snapshotRetentionPeriodInDays
– Número (íntegro).O número de dias para reter os snapshots do Iceberg. Se uma entrada não for fornecida, o campo de configuração da tabela Iceberg correspondente será usado ou, se não estiver presente, o valor padrão 5 será usado.
-
numberOfSnapshotsToRetain
– Número (íntegro).O número de snapshots do Iceberg a serem retidos no período de retenção. Se uma entrada não for fornecida, o campo de configuração da tabela Iceberg correspondente será usado ou, se não estiver presente, o valor padrão 1 será usado.
-
cleanExpiredFiles
: booleano.Se definido como false, os snapshots são excluídos somente dos metadados da tabela, e os arquivos de dados e metadados subjacentes não são excluídos.
Estrutura OrphanFileDeletionConfiguration
A configuração de um otimizador de exclusão de arquivos órfãos.
Campos
-
icebergConfiguration
– Um objeto IcebergOrphanFileDeletionConfiguration.A configuração de um otimizador de exclusão de arquivos órfãos do Iceberg.
Estrutura IcebergOrphanFileDeletionConfiguration
A configuração de um otimizador de exclusão de arquivos órfãos do Iceberg.
Campos
-
orphanFileRetentionPeriodInDays
– Número (íntegro).O número de dias que os arquivos órfãos devem ser retidos antes da exclusão do arquivo. Se uma entrada de não for fornecida, o valor padrão 3 será usado.
-
location
: string UTF-8.Especifica um diretório no qual procurar arquivos (o padrão é a localização da tabela). Você pode escolher um subdiretório em vez da localização da tabela de nível superior.
Estrutura CompactionMetrics
Uma estrutura que contém as métricas de compactação para a execução do otimizador.
Campos
-
IcebergMetrics
– Um objeto IcebergCompactionMetrics.Uma estrutura que contém as métricas de compactação do Iceberg para a execução do otimizador.
Estrutura RetentionMetrics
Uma estrutura que contém as métricas de retenção para a execução do otimizador.
Campos
-
IcebergMetrics
– Um objeto IcebergRetentionMetrics.Uma estrutura que contém as métricas de retenção do Iceberg para a execução do otimizador.
Estrutura OrphanFileDeletionMetrics
Uma estrutura que contém as métricas de exclusão de arquivos órfãos para a execução do otimizador.
Campos
-
IcebergMetrics
– Um objeto IcebergOrphanFileDeletionMetrics.Uma estrutura que contém as métricas de exclusão de arquivos órfãos do Iceberg para a execução do otimizador.
Estrutura IcebergCompactionMetrics
Métricas de compactação do Iceberg para a execução do otimizador.
Campos
-
NumberOfDpus
: número (inteiro).O número de horas de DPU consumidas pelo trabalho.
-
JobDurationInHour
– Número (duplo).A duração do trabalho, em horas.
Estrutura IcebergRetentionMetrics
Métricas de retenção de snapshots do Iceberg para a execução do otimizador.
Campos
-
NumberOfDpus
: número (inteiro).O número de horas de DPU consumidas pelo trabalho.
-
JobDurationInHour
– Número (duplo).A duração do trabalho, em horas.
Estrutura IcebergOrphanFileDeletionMetrics
Métricas de exclusão de arquivos órfãos do Iceberg para a execução do otimizador.
Campos
-
NumberOfDpus
: número (inteiro).O número de horas de DPU consumidas pelo trabalho.
-
JobDurationInHour
– Número (duplo).A duração do trabalho, em horas.
Estrutura RunMetrics
Métricas para a execução do otimizador.
Esta estrutura está obsoleta. Veja os membros individuais da métrica para compactação, retenção e exclusão de arquivos órfãos.
Campos
-
NumberOfBytesCompacted
: string UTF-8.O número de bytes removidos pela execução do trabalho de compactação.
-
NumberOfFilesCompacted
: string UTF-8.O número de arquivos removidos pela execução do trabalho de compactação.
-
NumberOfDpus
: string UTF-8.O número de horas de DPU consumidas pelo trabalho.
-
JobDurationInHour
: string UTF-8.A duração do trabalho, em horas.
Operações
Ação GetTableOptimizer (Python: get_table_optimizer)
Retorna a configuração de todos os otimizadores associados a uma tabela especificada.
Solicitação
-
CatalogId
– Obrigatório: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.O ID de catálogo da tabela.
-
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 catálogo em que 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.
-
Type
– Obrigatório: string UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
Resposta
-
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 de catálogo da tabela.
-
DatabaseName
: 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 catálogo em que a tabela reside.
-
TableName
: 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.
-
TableOptimizer
: um objeto TableOptimizer.O otimizador associado à tabela especificada.
Erros
EntityNotFoundException
InvalidInputException
AccessDeniedException
InternalServiceException
ThrottlingException
Ação BatchGetTableOptimizer (Python: batch_get_table_optimizer)
Retorna a configuração para os otimizadores de tabela especificados.
Solicitação
-
Entries
– Obrigatório: uma matriz de objetos BatchGetTableOptimizerEntry.Uma lista de objetos
BatchGetTableOptimizerEntry
que especifica os otimizadores de tabelas a serem recuperados.
Resposta
-
TableOptimizers
: um array de objetos BatchTableOptimizer.Uma lista dos objetos
BatchTableOptimizer
. -
Failures
: um array de objetos BatchGetTableOptimizerError.Uma lista de erros da operação.
Erros
EntityNotFoundException
InvalidInputException
AccessDeniedException
InternalServiceException
ThrottlingException
Ação ListTableOptimizerRuns (Python: list_table_optimizer_runs)
Lista o histórico de execuções anteriores do otimizador para uma tabela específica.
Solicitação
-
CatalogId
– Obrigatório: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.O ID de catálogo da tabela.
-
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 catálogo em que 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.
-
Type
– Obrigatório: string UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
-
MaxResults
– Número (íntegro).O número máximo de execuções do otimizador a serem retornadas em cada chamada.
-
NextToken
: string UTF-8.Um token de continuação, se esta for uma chamada de continuação.
Resposta
-
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 de catálogo da tabela.
-
DatabaseName
: 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 catálogo em que a tabela reside.
-
TableName
: 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.
-
NextToken
: string UTF-8.Um token de continuação para paginação da lista de execuções do otimizador retornada, retornado se o segmento atual da lista não for o último.
-
TableOptimizerRuns
: um array de objetos TableOptimizerRun.Uma lista das execuções de otimizador associadas a uma tabela.
Erros
EntityNotFoundException
AccessDeniedException
InvalidInputException
ValidationException
InternalServiceException
ThrottlingException
Ação CreateTableOptimizer (Python: create_table_optimizer)
Cria um novo otimizador de tabela para uma função específica.
Solicitação
-
CatalogId
– Obrigatório: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.O ID de catálogo da tabela.
-
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 catálogo em que 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.
-
Type
– Obrigatório: string UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
-
TableOptimizerConfiguration
– Obrigatório: um objeto TableOptimizerConfiguration.Um
TableOptimizerConfiguration
objeto que representa a configuração de um otimizador de tabela.
Resposta
Nenhum parâmetro de resposta.
Erros
EntityNotFoundException
ValidationException
InvalidInputException
AccessDeniedException
AlreadyExistsException
InternalServiceException
ThrottlingException
Ação DeleteTableOptimizer (Python: delete_table_optimizer)
Exclui um otimizador e todos os metadados associados de uma tabela. A otimização não será mais executada na tabela.
Solicitação
-
CatalogId
– Obrigatório: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.O ID de catálogo da tabela.
-
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 catálogo em que 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.
-
Type
– Obrigatório: string UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
Resposta
Nenhum parâmetro de resposta.
Erros
EntityNotFoundException
InvalidInputException
AccessDeniedException
InternalServiceException
ThrottlingException
Ação UpdateTableOptimizer (Python: update_table_optimizer)
Atualiza a configuração de um otimizador de tabela existente.
Solicitação
-
CatalogId
– Obrigatório: string de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.O ID de catálogo da tabela.
-
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 catálogo em que 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.
-
Type
– Obrigatório: string UTF-8 (valores válidos:compaction="COMPACTION"
|retention="RETENTION"
|orphan_file_deletion="ORPHAN_FILE_DELETION"
).O tipo de otimizador de tabelas.
-
TableOptimizerConfiguration
– Obrigatório: um objeto TableOptimizerConfiguration.Um
TableOptimizerConfiguration
objeto que representa a configuração de um otimizador de tabela.
Resposta
Nenhum parâmetro de resposta.
Erros
EntityNotFoundException
InvalidInputException
AccessDeniedException
ValidationException
InternalServiceException
ThrottlingException
ConcurrentModificationException