View a markdown version of this page

Implantação de automações - Amazon Quick

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Implantação de automações

Depois de criar e testar suas automações no Amazon Quick Automate, a próxima etapa é implantá-las para que possam ser executadas regularmente em um gatilho. A implantação torna a automação operacional e pronta para execução. Você pode adicionar um gatilho a uma automação implantada para executá-la em um cronograma predefinido. A implantação envolve a definição das configurações de tempo de execução, a atribuição de usuários para tarefas humanas no circuito, a verificação de credenciais e integrações.

Esta seção explica cada etapa do processo de implantação e como configurar sua automação para obter confiabilidade, segurança e desempenho ideal.

Pré-requisitos

Antes de implantar sua automação, certifique-se de que as seguintes etapas estejam concluídas:

  • A automação é testada minuciosamente - valide sua automação por meio de testes de ponta a ponta para confirmar se todas as lógicas, ações e interações do agente funcionam conforme o esperado.

  • Versão confirmada para implantação - Somente versões de automação comprometidas podem ser implantadas. Revise suas alterações, finalize a versão e confirme-a antes de continuar.

  • Integrações configuradas - Se sua automação interage com aplicativos externos, como Salesforce ou Jira, por meio de APIs, certifique-se de que todas as integrações necessárias estejam configuradas.

    • Navegue até Conexões → Integrações no painel esquerdo para criar novas integrações.

    • Atualmente, somente integrações disponíveis na guia Ações são suportadas no Amazon Quick Automate.

    • Depois que uma ação de integração for criada, associe-a ao Grupo de Automação onde ela será usada.

    • As ações associadas aparecerão então na tela. Durante a implantação, você pode selecionar a conexão apropriada para ser usada pela automação implantada.

  • Credenciais configuradas - Verifique se todas as credenciais exigidas pela sua automação estão configuradas corretamente.

Implantando uma automação

Você pode implantar uma automação diretamente do Canvas clicando em Implantar ou navegando até a guia Implantação na página inicial da automação. Depois de iniciar a implantação, o sistema o guiará por uma série de etapas para concluir o processo de configuração e lançamento.

Detalhes do lançamento

Na página Detalhes da versão, selecione a versão da automação que você deseja implantar. Somente versões confirmadas estão disponíveis para implantação e aparecerão na lista suspensa.

Configurações adicionais

As configurações adicionais incluem:

  • Configuração de tempo de execução

  • Tarefas (para atribuições de HITL)

  • Acesso

Configuração de runtime

As configurações de tempo de execução são parâmetros que podem diferir entre ambientes, como desenvolvimento, teste e produção.

Por exemplo, uma etapa de automação que envia um e-mail pode usar seu endereço de e-mail pessoal durante o teste, mas deve mudar para um endereço de equipe compartilhado na produção. Esses valores dependentes do ambiente podem ser definidos como configurações de tempo de execução ao criar a automação.

No momento da implantação, você pode revisar e substituir essas configurações para garantir que a automação seja executada corretamente no ambiente pretendido. Os parâmetros de tempo de execução podem incluir:

  • Endereços de e-mail ou destinatários de notificações

  • Caminhos de arquivo ou URLs específicos para o ambiente

Essa flexibilidade ajuda a manter uma única definição de automação em todos os ambientes, ao mesmo tempo em que adapta os principais parâmetros conforme necessário.

Tarefas

Selecione os usuários ou grupos de usuários do resolvedor para cada uma das tarefas que exigem human-in-the-loop.

Acesso (credenciais e conexões)

As automações geralmente precisam se conectar a sistemas, bancos de dados ou serviços externos. O Amazon Quick Automate fornece métodos seguros para gerenciar credenciais e conexões sem incorporar informações confidenciais em sua lógica de automação.

Os dados de conexão e credencial são armazenados e criptografados com segurança e disponibilizados para fluxos de trabalho em tempo de execução sem serem expostos aos autores ou usuários finais. Esse design garante uma forte separação dos segredos das definições de automação, melhorando a segurança e a capacidade de manutenção.

Você pode armazenar e usar dois tipos principais de credenciais:

  • Credenciais do site - Usadas para etapas de automação da interface do usuário que exigem logins no site (nome de usuário e senha).

  • Credenciais de ação (integrações) - usadas para conectar AWS serviços (por exemplo, S3) ou sistemas externos por meio de integrações configuradas (por exemplo, Salesforce, Jira).

Na implantação, certifique-se de que as credenciais e conexões corretas sejam selecionadas para que a automação possa acessar todos os sistemas necessários com segurança e sucesso.

Configurando gatilhos

Os gatilhos determinam quando e como suas automações são executadas. Você pode configurar as automações para começar com base em um cronograma predefinido ou invocá-las programaticamente por meio da API da Amazon. QuickSight

Programações

Você pode configurar as automações para serem iniciadas com base em um cronograma predefinido. Para configurar um gatilho:

  • Na página de implantação, clique em “Criar gatilho” e configure as regras.

  • Selecione a frequência

  • Selecione a data e a hora de início (observe que a execução real será iniciada dentro de 15 minutos da hora de início selecionada)

  • Selecione a data e a hora de término

  • Selecione o fuso horário

  • O Amazon Quick Automate forneceu escalabilidade integrada. Selecione o número de execuções paralelas da automação (você pode selecionar no máximo 10 execuções paralelas por gatilho e 50 em todas as automações em uma conta). Por favor, entre em contato com AWS)

  • Para necessidades complexas de agendamento, você pode usar expressões cron para definir padrões de execução precisos. Por exemplo, para executar uma automação às 2h30 todas as segundas, quartas e sextas-feiras, você usaria a expressão cron:. 30 2 * * 1,3,5

Acionadores de API

As APIs do Automation Job permitem que você inicie e monitore programaticamente trabalhos de automação a partir de aplicativos externos. Você pode usar essas APIs para invocar automações implantadas com cargas de entrada personalizadas e recuperar os resultados da execução por meio do SDK e. AWS AWS CLI

As APIs do Automation Job incluem duas operações:

  • StartAutomationJob— Inicia um novo trabalho para uma automação implantada com uma carga útil de entrada opcional.

  • DescribeAutomationJob— recupera o status, os carimbos de data/hora e as cargas opcionais de entrada e saída de um trabalho específico.

Essas APIs fazem parte do namespace de QuickSight serviços da Amazon. Você os acessa por meio do quicksight namespace no AWS SDK e. AWS CLI

Para obter mais informações sobre AWS SDKs e kits de ferramentas, consulte o AWS Getting Started Resource Center.

Pré-requisitos

Antes de chamar as APIs do Automation Job, conclua as etapas de configuração a seguir.

Encontre seus identificadores de automação

Para chamar as APIs do Automation Job, você precisa dos seguintes identificadores:

  • AWS ID da conta — Seu ID da AWS conta de 12 dígitos.

  • ID do grupo de automação — O ID exclusivo do grupo de automação que contém sua automação.

  • ID de automação — O ID exclusivo da automação que você deseja invocar.

Você pode encontrar o ID do grupo de automação e o ID de automação na seção Implantações ao abrir qualquer automação e ter uma versão implantada.

Para encontrar seus identificadores

  • Faça login no Amazon Quick Automate.

  • No painel de navegação esquerdo, escolha Automações.

  • Escolha o grupo de automação que contém sua automação.

  • Escolha o nome da automação para abrir o editor de automação.

  • Escolha a guia Grupos de implantação.

  • Escolha as Ações (✔) e Visualize os detalhes da implantação para obter a ID de automação e a ID do grupo na parte superior, logo abaixo do título Detalhes da implantação.

Configurar permissões do IAM

As APIs do Automation Job exigem permissões do IAM anexadas à sua identidade do IAM (usuário, função ou grupo). Cada operação requer uma permissão separada.

Permissão para StartAutomationJob

Anexe uma política que conceda a quicksight:StartAutomationJob ação. Defina o escopo do ARN do recurso para a automação específica que você deseja permitir.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AllowStartAutomationJob", "Effect": "Allow", "Action": [ "quicksight:StartAutomationJob" ], "Resource": [ "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID" ] } ] }

Permissão para DescribeAutomationJob

Anexe uma política que conceda a quicksight:DescribeAutomationJob ação. O ARN do recurso para essa operação inclui o segmento de ID do trabalho. Para permitir a descrição de qualquer trabalho em uma automação, use um caractere curinga (*) para o segmento de trabalho.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "AllowDescribeAutomationJob", "Effect": "Allow", "Action": [ "quicksight:DescribeAutomationJob" ], "Resource": [ "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID" ] } ] }

AWS recomenda definir o escopo de cada permissão para o ARN de recurso mais específico possível para seguir o princípio do menor privilégio. Para saber mais, consulte:

Implemente sua automação

A StartAutomationJob API tem como alvo somente automações implantadas. Você deve confirmar e implantar sua automação no console do Amazon Quick Automate antes de poder invocá-la por meio da API.

StartAutomationJob

Inicia um novo trabalho para uma automação implantada. A operação é assíncrona — o Amazon Quick Automate aceita a solicitação, coloca o trabalho em fila e retorna imediatamente. JobId A automação é executada em segundo plano. Se a automação tiver um esquema de entrada definido, o Amazon Quick Automate o valida em InputPayloadrelação ao esquema antes de aceitar o trabalho. Uma carga inválida resulta em um. InvalidParameterValueException

Sintaxe da solicitação
POST /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs HTTP/1.1 Content-type: application/json { "InputPayload": "string" }
Parâmetros de solicitação
  • AwsAccountId(Cadeia de caracteres, obrigatório) — O ID AWS da sua conta (12 dígitos).

  • AutomationGroupId(String, obrigatório) — O ID do grupo de automação (UUID).

  • AutomationId(String, required) — O ID da automação a ser executada (UUID).

  • InputPayload(String, opcional) — Entrada para o trabalho como uma string JSON.

Elementos de resposta
  • Arn (String) — ARN do trabalho de automação.

  • JobId(String) — ID do trabalho iniciado. Use isso com DescribeAutomationJob para rastrear o status.

  • Status (Integer) — Código de status HTTP da resposta.

  • RequestId(String) — ID da AWS solicitação.

Erros
  • AccessDeniedException— Permissões insuficientes ou credenciais inválidas.

  • InvalidParameterValueException— Um ou mais parâmetros têm um valor que não é válido.

  • ResourceNotFoundException— Grupo de automação ou automação não encontrado.

  • LimitExceededException— Um limite é excedido.

  • ThrottlingException— A solicitação foi restringida.

  • InternalFailureException— Erro interno de serviço.

Para obter mais detalhes, consulte o guia de referência da API para StartAutomationJob.

DescribeAutomationJob

Recupera o status e os detalhes de um trabalho de automação especificado, incluindo registros de data e hora de execução e cargas opcionais de entrada e saída. Use essa operação para pesquisar a conclusão do trabalho após a chamada StartAutomationJob.

A resposta não inclui cargas de entrada e saída por padrão. Defina os parâmetros IncludeInputPayloade de IncludeOutputPayloadconsulta true para solicitá-los. O Amazon Quick Automate retorna a carga de saída somente quando todas as seguintes condições são atendidas:

  • IncludeOutputPayload é true.

  • JobStatus é SUCCEEDED.

  • A automação produziu valores de saída.

Sintaxe da solicitação
GET /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs/JobId?IncludeInputPayload=boolean&IncludeOutputPayload=boolean HTTP/1.1
Parâmetros de solicitação
  • AwsAccountId(Cadeia de caracteres, obrigatório) — O ID AWS da sua conta (12 dígitos).

  • AutomationGroupId(String, obrigatório) — O ID do grupo de automação (UUID).

  • AutomationId(String, obrigatório) — O ID da automação (UUID).

  • JobId(String, required) — O ID do trabalho retornado por StartAutomationJob (UUID).

  • IncludeInputPayload(Booleano, opcional) — Inclua a carga de entrada na resposta. Padrão: false.

  • IncludeOutputPayload(Booleano, opcional) — Inclua a carga de saída na resposta. Padrão: false.

Campos de resposta
  • Arn (String) — ARN do trabalho de automação.

  • CreatedAt(Timestamp) — Quando o trabalho foi criado (segundos de época).

  • StartedAt(Timestamp) — Quando o trabalho começou a ser executado (segundos de época).

  • EndedAt(Timestamp) — Quando o trabalho foi concluído (segundos de época).

  • JobStatus(Cadeia de caracteres) — QUEUED RUNNINGSUCCEEDED,FAILED,, ouSTOPPED.

  • InputPayload(String) — A carga útil de entrada. Omitido da resposta, a menos que sejaIncludeInputPayload. true

  • OutputPayload(String) — A carga útil de saída. Omitido da resposta, a menos que sejaIncludeOutputPayload. true

  • RequestId(String) — ID da AWS solicitação.

Erros
  • AccessDeniedException— Permissões insuficientes ou credenciais inválidas.

  • InvalidParameterValueException— Um ou mais parâmetros têm um valor que não é válido.

  • ResourceNotFoundException— Job, automação ou grupo de automação não encontrado.

  • ThrottlingException— A solicitação foi restringida.

  • InternalFailureException— Erro interno de serviço.

Para obter mais detalhes, consulte o guia de referência da API para DescribeAutomationJob.

Execute automações com acionadores de API usando entrada e saída

Você pode incluir valores de entrada como uma carga JSON ao iniciar um trabalho de automação por meio da API. O Amazon Quick Automate valida a carga em relação ao esquema de entrada da automação antes do início da execução e retorna valores de saída estruturados quando o trabalho é concluído.

Pré-requisitos

Antes de executar uma automação com acionadores de API, verifique se o seguinte está em vigor:

  • A automação é implantada.

  • A automação tem um esquema de entrada definido no nó Iniciar.

  • Você tem o ID do grupo de automação e o ID de automação.

Envio de valores de entrada por meio da API

Para incluir valores de entrada, transmita uma carga JSON na StartAutomationJobsolicitação usando o InputPayloadparâmetro.

Sample Request POST /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs { "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}" } Sample Response { "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "JobId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status": 200, "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012" }
nota

O InputPayload valor deve ser uma JSON-serialized string que contenha os valores do campo de entrada que correspondam ao esquema de entrada da sua automação.

Recuperando valores de saída por meio da API

Você pode recuperar os valores de saída chamando a DescribeAutomationJobAPI. Para incluir cargas de entrada e saída na resposta, defina os parâmetros de OutputPayload consulta de inclusão InputPayload e inclusão comotrue.

A resposta inclui o OutputPayloadcampo somente quando a automação é concluída com êxito.

Sample Request GET /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?includeInputPayload=true&includeOutputPayload=true Sample Response { "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "JobStatus": "SUCCEEDED", "CreatedAt": "2026-03-11T09:59:50Z", "StartedAt": "2026-03-11T10:00:00Z", "EndedAt": "2026-03-11T10:05:00Z", "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}", "OutputPayload": "{\"result\":\"success\",\"records_processed\":42,\"summary\":{\"passed\":40,\"failed\":2}}", "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012" }
nota

O OutputPayloadcampo estará disponível somente após a conclusão bem-sucedida da automação (quando JobStatusestiverSUCCEEDED). Se a automação falhar ou ainda estiver em execução, a resposta não incluirá o OutputPayloadcampo.

Implemente e execute automações com entradas e saídas

Esta seção descreve como implantar automações que usam esquemas de entrada e saída, executá-las manualmente ou em um cronograma e visualizar os resultados da execução.

Visualize as informações do esquema antes da implantação

Antes de implantar uma automação, você deve confirmá-la para criar uma versão. Para obter mais informações, consulte Manutenção de versões de automação.

Depois de confirmar uma automação com esquemas de entrada ou saída, você pode visualizar os detalhes do esquema na seção Modelo de dados da página de detalhes da versão. Esta seção exibe as definições de campo completas para entradas e saídas.

Implemente automações com esquemas de entrada e saída

Quando você implanta uma automação com esquemas de entrada ou saída definidos, a caixa de diálogo de implantação exibe as informações do esquema na seção Modelo de dados, incluindo:

  • Definições dos campos de entrada e saída (nome, tipo de dados, descrição, status obrigatório ou opcional e valores padrão).

  • Esquemas JSON copiáveis para entradas e saídas que os chamadores da API podem usar para integração.

Importante

O esquema é congelado no momento da implantação junto com o código de automação. Se você atualizar o esquema após a implantação, deverá reimplantar a automação para que as alterações entrem em vigor.

Para concluir a implantação, revise as informações do esquema e escolha Implantar.

Execute as automações implantadas manualmente

Para iniciar uma automação implantada com entradas, conclua as seguintes etapas:

  • Na página de implantação, escolha o menu Ações (✔).

  • Escolha Executar agora.

  • Na caixa de diálogo Fornecer valores de entrada, insira valores para cada campo de entrada.

  • Escolha Iniciar para iniciar a execução da automação.

O formulário de entrada é idêntico ao que você usa ao testar no Studio.

Execute automações com gatilhos programados

Para acionadores programados, você fornece valores de entrada ao criar ou editar o gatilho. Os valores armazenados são passados para a automação sempre que o gatilho é acionado.

Você pode fazer o seguinte:

  • Crie vários gatilhos com valores de entrada diferentes para a mesma automação

  • Edite os valores de entrada para um gatilho sem reimplantar a automação

Para configurar as entradas para um acionador programado, conclua as seguintes etapas:

  • Navegue até a página de implantação da sua automação.

  • Escolha Criar gatilho.

  • Na Etapa 1: Definir gatilho, configure a programação.

  • Na Etapa 2: Definir Execução, insira valores para cada campo de entrada no formulário gerado automaticamente.

  • Escolha Avançar, revise sua configuração e escolha Criar gatilho.

nota

Se você criar um gatilho com uma versão específica do esquema e depois implantar a automação com um esquema atualizado, deverá modificar o gatilho. O gatilho se torna incompatível quando a versão do esquema muda e as execuções de automação falham.

Visualizando entradas e saídas para execuções implantadas

Após a conclusão de uma execução de automação (seja iniciada manualmente ou por um gatilho programado), os valores de entrada e saída estarão disponíveis como artefatos estruturados no painel de registros na página Execuções.

Os artefatos aparecem como cartões dedicados:

  • Artefato de entrada — é exibido na parte superior do painel de registros

  • Artefato de saída — é exibido na parte inferior do painel de registros (disponível somente se a automação for concluída com êxito)

Ambas as cartas estão fechadas por padrão. Ao expandi-las, você pode:

  • Visualize o esquema completo e os valores reais

  • Baixe qualquer objeto de arquivo incluído nas entradas ou saídas

  • Copie os dados estruturados como JSON

  • Baixe a carga útil completa como um arquivo JSON