Acionadores

A API de acionadores descreve os tipos de dados e a API relacionada à criação, atualização ou exclusão, e início e interrupção, de acionadores de trabalho no AWS Glue.

Tipos de dados

• Estrutura de acionador

• Estrutura TriggerUpdate

• Estrutura Predicate

• Estrutura Condition

• Estrutura Action

• Estrutura EventBatchingCondition

Estrutura de acionador

As informações sobre um determinado gatilho.

Campos

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

  O nome do gatilho.

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

  O nome do fluxo de trabalho associado ao gatilho.

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

  Reservado para uso futuro.

• Type – String UTF-8 (valores válidos: SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

  O tipo de gatilho.

• State – String UTF-8 (valores válidos: CREATING | CREATED | ACTIVATING | ACTIVATED | DEACTIVATING | DEACTIVATED | DELETING | UPDATING).

  O estado atual do gatilho do trabalho.

• Description – String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.

  Uma descrição desse gatilho.

• Schedule – String UTF-8.

  Uma expressão cron usada para especificar a programação (consulte Programações baseadas em hora para tarefas e crawlers. Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: cron(15 12 * * ? *).

• Actions – Uma matriz de objetos Ação.

  As ações iniciadas por esse gatilho.

• Predicate – Um objeto Predicado.

  O predicado deste gatilho, que define quando ele disparará.

• EventBatchingCondition – Um objeto EventBatchingCondition.

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

Estrutura TriggerUpdate

Uma estrutura usada para fornecer as informações necessárias para atualizar um gatilho. Este objeto atualiza a definição do gatilho anterior, substituindo-a completamente.

Campos

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

  Reservado para uso futuro.

• Description – String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.

  Uma descrição desse gatilho.

• Schedule – String UTF-8.

  Uma expressão cron usada para especificar a programação (consulte Programações baseadas em hora para tarefas e crawlers. Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: cron(15 12 * * ? *).

• Actions – Uma matriz de objetos Ação.

  As ações iniciadas por esse gatilho.

• Predicate – Um objeto Predicado.

  O predicado deste gatilho, que define quando ele disparará.

• EventBatchingCondition – Um objeto EventBatchingCondition.

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

Estrutura Predicate

Define o predicado do gatilho, que determina quando ele é acionado.

Campos

• Logical: string UTF-8 (valores válidos: AND | ANY).

  Um campo opcional se apenas uma condição estiver listada. Se várias condições estiverem listadas, esse campo será obrigatório.

• Conditions – Uma matriz de objetos Condição.

  Uma lista das condições que determinam quando o gatilho será acionado.

Estrutura Condition

Define em que condição um gatilho será acionado.

Campos

• LogicalOperator – String UTF-8 (valores válidos: EQUALS).

  Um operador lógico.

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

  O nome do trabalho cujo JobRuns essa condição se aplica e na qual esse gatilho aguardará.

• State: string UTF-8 (valores válidos: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT | ERROR | WAITING | EXPIRED).

  O estado da condição. No momento, os únicos estados de trabalho que um trigger pode escutar são SUCCEEDED, STOPPED, FAILED e TIMEOUT. Os únicos estados de crawler que um trigger pode escutar são SUCCEEDED, FAILED e CANCELLED.

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

  O nome do crawler ao qual essa condição se aplica.

• CrawlState – String UTF-8 (valores válidos: RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR).

  O estado do crawler ao qual essa condição se aplica.

Estrutura Action

Define uma ação a ser iniciada por um gatilho.

Campos

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

  O nome de um trabalho a ser executado.

• Arguments – Um array de mapa dos pares de valor-chave.

  Cada chave é uma sequência de caracteres UTF-8.

  Cada valor é uma sequência de caracteres UTF-8.

  Os argumentos de tarefa usados ao acionar esse trigger. Para essa execução de tarefa, eles substituem os argumentos padrão definidos na própria definição de tarefa.

  Aqui, você pode especificar os argumentos que seu próprio script de execução de trabalho consome, além dos argumentos que o AWS Glue consome.

  Para obter informações sobre como especificar e consumir seus próprios argumentos de trabalho, consulte o tópico Chamar APIs do AWS Glue em Python no guia do desenvolvedor.

  Para obter informações sobre os pares de chave-valor que o AWS Glue consome para configurar o trabalho, consulte o tópico Parâmetros especiais usados ​​pelo AWS Glue no guia do desenvolvedor.

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

  O tempo limite de JobRun em minutos. Este é o tempo máximo durante o qual uma execução de trabalho pode consumir recursos antes de ser encerrada e entrar no status TIMEOUT. O padrão é 2.880 minutos (48 horas). Isso substitui o valor de tempo limite definido no trabalho principal.

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

  O nome da estrutura de SecurityConfiguration a ser usada com essa ação.

• NotificationProperty – Um objeto NotificationProperty.

  Especifica propriedades de configuração de uma notificação de execução de trabalho.

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

  O nome do crawler que será usado com essa ação.

Estrutura EventBatchingCondition

Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

Campos

• BatchSize: obrigatório: número (inteiro), não menos do que 1 ou superior a 100.

  Número de eventos que devem ser recebidos do Amazon EventBridge antes que o acionador do evento do EventBridge dispare.

• BatchWindow: número (inteiro), não menos do que 1 ou superior a 900.

  Janela de tempo em segundos após a qual o acionador do evento do EventBridge dispara. A janela é iniciada quando o primeiro evento é recebido.

Operações

• Ação CreateTrigger (Python: create_trigger)

• Ação StartTrigger (Python: start_trigger)

• Ação GetTrigger (Python: get_trigger)

• Ação GetTriggers (Python: get_triggers)

• Ação UpdateTrigger (Python: update_trigger)

• Ação StopTrigger (Python: stop_trigger)

• Ação DeleteTrigger (Python: delete_trigger)

• Ação ListTriggers (Python: list_triggers)

• Ação BatchGetTriggers (Python: batch_get_triggers)

Ação CreateTrigger (Python: create_trigger)

Cria um novo gatilho.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho.

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

  O nome do fluxo de trabalho associado ao gatilho.

• Type: obrigatório: string UTF-8 (valores válidos: SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

  O tipo do novo gatilho.

• Schedule – String UTF-8.

  Uma expressão cron usada para especificar a programação (consulte Programações baseadas em hora para tarefas e crawlers. Por exemplo, para executar algo todos os dias às 12h15 UTC, especifique: cron(15 12 * * ? *).

  Esse campo é obrigatório quando o tipo do gatilho é SCHEDULED.

• Predicate – Um objeto Predicado.

  Um predicado para especificar quando o novo gatilho será disparado.

  Esse campo é obrigatório quando o tipo do gatilho é CONDITIONAL.

• Actions – Obrigatório: uma matriz de objetos Ação.

  As ações iniciadas por esse gatilho quando ele é disparado.

• Description – String de descrição, inferior a 2048 bytes de comprimento, correspondente a URI address multi-line string pattern.

  Uma descrição do novo gatilho.

• StartOnCreation – Booleano.

  Defina como true para iniciar os gatilhos SCHEDULED e CONDITIONAL na criação. True (Verdadeiro) não é compatível com gatilhos ON_DEMAND.

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

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.

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

  As tags a serem usadas com esse trigger. Você pode usar tags para limitar o acesso ao trigger. Para obter mais informações sobre tags no AWS Glue, consulte Tags da AWS no AWS Glue no guia do desenvolvedor.

• EventBatchingCondition – Um objeto EventBatchingCondition.

  Condição de lote que deve ser atendida (número especificado de eventos recebidos ou janela de tempo de lote expirada) antes que o acionador do evento do EventBridge dispare.

Resposta

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

  O nome do gatilho.

Erros

• AlreadyExistsException

• EntityNotFoundException

• InvalidInputException

• IdempotentParameterMismatchException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

Ação StartTrigger (Python: start_trigger)

Inicia um gatilho existente. Consulte Acionar tarefas para obter informações sobre como diferentes tipos de gatilho são acionados.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho a ser iniciado.

Resposta

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

  O nome do gatilho iniciado.

Erros

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentRunsExceededException

Ação GetTrigger (Python: get_trigger)

Recupera a definição de um gatilho.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho a ser recuperado.

Resposta

• Trigger – Um objeto Trigger.

  A definição de gatilho solicitada.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Ação GetTriggers (Python: get_triggers)

Obtém todos os gatilhos associados a um trabalho.

Solicitação

• NextToken – String UTF-8.

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

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

  O nome do trabalho para o qual recuperar gatilhos. O gatilho que pode iniciar esse trabalho será retornado e, se ele não existir, todos os gatilhos serão retornados.

• MaxResults: número (inteiro) não inferior a 1 nem superior a 200.

  O tamanho máximo da resposta.

Resposta

• Triggers – Uma matriz de objetos Trigger.

  Uma lista de gatilhos para o trabalho especificado.

• NextToken – String UTF-8.

  Um token de continuação, se todos os gatilhos solicitados ainda não tiverem sido retornados.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Ação UpdateTrigger (Python: update_trigger)

Atualiza uma definição do gatilho.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho a ser atualizado.

• TriggerUpdate – Obrigatório: um objeto TriggerUpdate.

  Os novos valores para atualização do gatilho.

Resposta

• Trigger – Um objeto Trigger.

  A definição de gatilho resultante.

Erros

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ConcurrentModificationException

Ação StopTrigger (Python: stop_trigger)

Interrompe um gatilho especificado.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho a ser interrompido.

Resposta

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

  O nome do gatilho interrompido.

Erros

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ConcurrentModificationException

Ação DeleteTrigger (Python: delete_trigger)

Exclui um gatilho especificado. Se o gatilho não for encontrado, nenhuma exceção será lançada.

Solicitação

• Name – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do gatilho a ser excluído.

Resposta

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

  O nome do gatilho excluído.

Erros

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

Ação ListTriggers (Python: list_triggers)

Recupera os nomes de todos os recursos de acionador nessa conta da AWS ou os recursos com a tag especificada. Essa operação permite que você veja quais recursos estão disponíveis em sua conta e seus nomes.

Essa operação aceita o campo Tags opcional, que pode ser usado como um filtro na resposta, para que recursos com tags possam ser recuperados como um grupo. Se você optar por usar a filtragem por tags, apenas os recursos com a tag serão recuperados.

Solicitação

• NextToken – String UTF-8.

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

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

  O nome do trabalho para o qual recuperar gatilhos. O gatilho que pode iniciar esse trabalho é retornado. Se esse gatilho não existir, todos os gatilhos serão retornados.

• MaxResults: número (inteiro) não inferior a 1 nem superior a 200.

  O tamanho máximo de uma lista a ser retornada.

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

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.

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

  Especifica apenas o retorno desses recursos com tags.

Resposta

• TriggerNames – Uma matriz de strings UTF-8.

  Os nomes de todos os gatilhos na conta ou os gatilhos com as tags especificadas.

• NextToken – String UTF-8.

  Um token de continuação, se a lista retornada não contiver a métrica mais recente disponível.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Ação BatchGetTriggers (Python: batch_get_triggers)

Retorna uma lista de metadados de recurso para uma lista de nomes de gatilho. Depois de chamar a operação ListTriggers, você pode chamar essa operação para acessar os dados aos quais você recebeu permissões. Essa operação oferece suporte a todas as permissões do IAM, incluindo condições de permissão que usam tags.

Solicitação

• TriggerNames: obrigatório: uma matriz de strings UTF-8.

  Uma lista de nomes de gatilho, que podem ser os nomes retornados pela operação ListTriggers.

Resposta

• Triggers – Uma matriz de objetos Trigger.

  Uma lista das definições de gatilho.

• TriggersNotFound – Uma matriz de strings UTF-8.

  Uma lista de nomes de gatilhos não encontrados.

Erros

• InternalServiceException

• OperationTimeoutException

• InvalidInputException