View a markdown version of this page

API de visualização materializada - AWS Glue

API de visualização materializada

A API de visualização materializada descreve os tipos de dados e as operações do AWS Glue para iniciar, interromper e monitorar as execuções da tarefa de atualização da visualização materializada.

Tipos de dados

Estrutura MaterializedViewRefreshTaskRun

O objeto que mostra os detalhes da execução da tarefa de atualização da visualização materializada.

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

    O ID da conta da AWS.

  • MaterializedViewRefreshTaskRunId – String UTF-8 correspondente a Custom string pattern #48.

    O identificador da execução da tarefa de atualização da visualização materializada.

  • DatabaseName – String UTF-8.

    O banco de dados em que a tabela reside.

  • TableName – String UTF-8.

    O nome da visualização materializada.

  • 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 será usado por padrão.

  • Role – String UTF-8.

    O perfil do IAM que o serviço assume para executar a tarefa de atualização da visualização materializada.

  • 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 (duplo).

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

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

    O tipo da execução da tarefa de atualização. FULL ou INCREMENTAL.

  • ProcessedBytes – Número (extenso).

    O número de bytes que a execução da tarefa de atualização verificou para atualizar a visualização materializada.

Operações

Ação StartMaterializedViewRefreshTaskRun (Python: start_materialized_view_refresh_task_run)

Inicia a execução da tarefa de atualização de uma visualização materializada para uma visualização materializada especificada.

Solicitação
  • CatalogId: 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 ID do catálogo de dados no qual a tabela reside. Se nenhum valor for fornecido, o ID da conta da será usado por padrã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 visualização materializada na qual a tarefa de atualização será executada.

  • FullRefresh – Booleano.

    Especifica se essa será uma atualização completa da execução da tarefa.

Resposta
  • MaterializedViewRefreshTaskRunId – String UTF-8 correspondente a Custom string pattern #48.

    O identificador da execução da tarefa de atualização da visualização materializada.

Erros
  • AccessDeniedException

  • EntityNotFoundException

  • MaterializedViewRefreshTaskRunningException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • InvalidInputException

Ação StopMaterializedViewRefreshTaskRun (Python: stop_materialized_view_refresh_task_run)

Interrompe a execução da tarefa de atualização de uma visualização materializada para uma visualização materializada especificada.

Solicitação
  • CatalogId: 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 ID do catálogo de dados no qual a tabela reside. Se nenhum valor for fornecido, o ID da conta da será usado por padrã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 visualização materializada.

Resposta
  • Nenhum parâmetro de resposta.

Erros
  • AccessDeniedException

  • MaterializedViewRefreshTaskNotRunningException

  • MaterializedViewRefreshTaskStoppingException

  • InvalidInputException

  • OperationTimeoutException

Ação GetMaterializedViewRefreshTaskRun (Python: get_materialized_view_refresh_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
  • CatalogId: 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 ID do catálogo de dados no qual reside a tabela. Se nenhum valor for fornecido, o ID da conta da será usado por padrão.

  • MaterializedViewRefreshTaskRunIdObrigatório: string UTF-8, correspondente a Custom string pattern #48.

    O identificador da execução da tarefa de atualização da visualização materializada específica.

Resposta
  • MaterializedViewRefreshTaskRun – Um objeto MaterializedViewRefreshTaskRun.

    Um objeto MaterializedViewRefreshTaskRun que representa os detalhes da execução da tarefa.

Erros
  • AccessDeniedException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

Ação ListMaterializedViewRefreshTaskRuns (Python: list_materialized_view_refresh_task_runs)

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

Solicitação
  • CatalogId: 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 ID do catálogo de dados no qual reside a tabela. Se nenhum valor for fornecido, o ID da conta da será usado por padrão.

  • DatabaseName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

    O banco de dados em que a tabela reside.

  • TableName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

    O nome da visualização materializada.

  • 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
  • MaterializedViewRefreshTaskRuns: um array de objetos MaterializedViewRefreshTaskRun.

    Os resultados da ação ListMaterializedViewRefreshTaskRuns.

  • 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
  • AccessDeniedException

  • InvalidInputException

  • OperationTimeoutException

Exceções

Estrutura MaterializedViewRefreshTaskRunningException

Exceção gerada quando uma tarefa já está em estado de execução.

Campos
  • Message – String UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura MaterializedViewRefreshTaskNotRunningException

Exceção gerada quando uma tarefa não está em estado de execução.

Campos
  • Message – String UTF-8.

    Uma mensagem descrevendo o problema.

Estrutura MaterializedViewRefreshTaskStoppingException

Exceção gerada quando uma tarefa já está em estado de interrupção.

Campos
  • Message – String UTF-8.

    Uma mensagem descrevendo o problema.