Ir para o conteúdo

Atividade Amazon SQS Obter Mensagens

Introdução

Uma atividade Amazon SQS Obter Mensagens, utilizando sua conexão Amazon SQS, recupera todas as mensagens Amazon SQS disponíveis em uma fila específica e é destinada a ser usada como uma fonte em uma operação.

Esta atividade utiliza a ação ReceiveMessage da API Amazon SQS.

Pré-requisitos

Para usar esta atividade com sucesso, você deve ter as seguintes permissões de conta AWS IAM:

  • sqs:GetQueueUrl
  • sqs:ListQueues
  • sqs:ReceiveMessage

Permissões entre contas não se aplicam a esta ação. Para mais informações, consulte Exemplos Básicos de Políticas do Amazon SQS no Guia do Desenvolvedor do Amazon SQS.

Criar uma atividade Amazon SQS Obter Mensagens

Uma instância de uma atividade Amazon SQS Obter Mensagens é criada a partir de uma conexão Amazon SQS usando seu tipo de atividade Obter Mensagens.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade Amazon SQS Obter Mensagens existente pode ser editada a partir destes locais:

Configurar uma atividade de Obter Mensagens do Amazon SQS

Siga estas etapas para configurar uma atividade de Obter Mensagens do Amazon SQS:

Etapa 1: Insira um nome, selecione uma fila e especifique as configurações

Nesta etapa, forneça um nome para a atividade, selecione uma fila e especifique as configurações para receber mensagens.

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir um menu com as variáveis existentes para escolher.

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Obter Mensagens do Amazon SQS e não deve conter barras (/) ou dois pontos (:).

  • Selecionar uma Fila: Esta seção exibe as filas disponíveis no endpoint do Amazon SQS. Ao reabrir a configuração de uma atividade existente, apenas a fila selecionada é exibida em vez de recarregar toda a lista de filas.

    • Fila Selecionada: Após uma fila ser selecionada, ela é listada aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de filas. A pesquisa não diferencia maiúsculas de minúsculas. Se as filas já estiverem exibidas na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar filas do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar as filas do endpoint Amazon SQS. Isso pode ser útil se filas foram adicionadas ao Amazon SQS. Esta ação atualiza todos os metadados usados para construir a tabela de filas exibida na configuração.

    • Selecionando uma Fila: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar uma fila. Apenas uma fila pode ser selecionada. As informações disponíveis para cada fila são obtidas do endpoint Amazon SQS:

      • Nome: O nome da fila do Amazon SQS.

      • Descrição: A descrição da fila do Amazon SQS.

    Dica

    Se a tabela não for preenchida com filas disponíveis, a conexão com o Amazon SQS pode não ter sido bem-sucedida. Certifique-se de que você está conectado reabrindo a conexão e retestando as credenciais.

  • ID da Tentativa de Recebimento: Insira o ID da tentativa de recebimento. É um token usado para deduplicação de mensagens.

  • Tempo de Visibilidade: Insira a duração de tempo que uma mensagem recebida de uma fila (por um consumidor) não ficará visível para os outros consumidores de mensagens. Isso pode variar de 0 a 43.200 segundos. Para mais informações, consulte Tempo de Visibilidade do Amazon SQS.

  • Segundos de Tempo de Espera: Insira a quantidade máxima de tempo que o Amazon SQS espera para que mensagens fiquem disponíveis após a fila receber uma solicitação de recebimento. Para mais informações, consulte Polling Curto e Longo do Amazon SQS.

  • Número Máximo de Mensagens: Insira o número máximo de mensagens a serem recuperadas. Isso pode variar de 1 a 10 mensagens.

  • Excluir Mensagens Automaticamente da Fila: Selecione para excluir automaticamente as mensagens recebidas da fila. Isso está selecionado por padrão.

  • Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações. Isso está selecionado por padrão.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    Nota

    Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

    O conector Amazon SQS utiliza a API Amazon SQS. Consulte a documentação da ação ReceiveMessage para informações sobre os nós e campos do esquema.

    Os esquemas de dados de solicitação e resposta consistem nos seguintes nós e campos:

    • Solicitação:

      Nó/Campo do Esquema de Solicitação Descrição
      GetMessagesRequest Solicitação para recuperar mensagens de uma fila
      request Nó representando a solicitação
      attributeNames Lista de atributos a serem recuperados junto com as mensagens
      #text Definido como Todos por padrão, consulte a referência API Message para valores aplicáveis
      maxNumberOfMessages Inteiro com o número máximo de mensagens a serem recuperadas
      messageAttributeNames Lista de atributos a serem recuperados dentro de cada mensagem
      #text Definido como Todos por padrão, consulte a referência API Message para valores aplicáveis
      queueUrl String com a URL da fila de onde obter mensagens
      receiveRequestAttemptId String com um token usado para deduplicação de mensagens em fila FIFO
      visibilityTimeout Inteiro com as configurações de tempo limite de visibilidade das mensagens em segundos
      waitTimeSeconds Inteiro com a duração do tempo a esperar por mensagens em segundos
      autoDeleteMessages Booleano que determina se as mensagens devem ou não ser excluídas após a recuperação

    • Resposta:

      Nó/Campo do Esquema de Resposta Descrição
      GetMessagesRequest Resposta ao recuperar mensagens de uma fila
      response Nó representando a resposta
      errorMessage String definida para a mensagem de erro da resposta
      autoDeleteStatus String definida para o status do resultado de exclusão automática
      messages Lista de mensagens retornadas com a resposta
      body String definida para o corpo da mensagem
      mD5OfBody String definida para o resumo MD5 do corpo da mensagem não codificado em URL
      mD5OfMessageAttributes String definida para o resumo MD5 dos atributos da mensagem não codificados em URL
      messageAttributes Lista de atributos associados à mensagem
      attrName String definida para o nome do atributo
      stringValue String definida para o valor do atributo
      dataType String definida para o tipo de dado do atributo
      messageId String definida para o identificador único da mensagem
      receiptHandle String definida para o identificador de recebimento associado à mensagem

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint Amazon SQS. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração da atividade.

  • Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Obter Mensagens do Amazon SQS, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos do conector.

As atividades Obter Mensagens do Amazon SQS podem ser usadas como uma fonte com esses padrões de operação:

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.