Ir para o conteúdo

Atividade de Obtenção de Mensagens do Amazon SQS

Introdução

Uma atividade Get Messages do Amazon SQS, usando sua conexão do Amazon SQS, recupera todas as mensagens do Amazon SQS disponíveis em uma fila específica e deve ser usada como origem em uma operação.

Esta atividade usa o ReceiveMessage da API do Amazon SQS.

Pré-requisitos

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

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

As permissões entre contas não se aplicam a esta ação. Para obter mais informações, consulte Exemplos básicos de políticas do Amazon SQS no *Guia do desenvolvedor do Amazon SQS *.

Crie uma Atividade de Obtenção de Mensagens do Amazon SQS

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

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

Uma atividade existente do Amazon SQS Get Messages pode ser editada nestes locais:

Configurar uma Atividade de Obtenção de Mensagens do Amazon SQS

Siga estas etapas para configurar uma atividade 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 recebimento de mensagens.

Etapa 1 da configuração da atividade de obtenção de mensagens do Amazon SQS

Dica

Campos com ícone de variável Ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone da variável para exibir uma lista das variáveis existentes para escolher.

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

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

    • Fila Selecionada: Depois que uma fila é selecionada, ela é listada aqui.

    • Pesquisar: Insira qualquer parte do nome da fila na caixa de pesquisa para filtrar a lista de filas. A busca não diferencia maiúsculas de minúsculas. Se as filas já estiverem exibidas na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar filas do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

    • Atualizar: Clique no ícone de atualização Ícone de atualização ou a palavra Atualizar para recarregar filas do endpoint do Amazon SQS. Isso pode ser útil se filas tiverem sido 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: Na tabela, clique em qualquer lugar de uma linha para selecionar uma fila. Somente uma fila pode ser selecionada. As informações disponíveis para cada fila são buscadas no endpoint do 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 do Amazon SQS pode não ter sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.

  • ID da tentativa de solicitação de recebimento: Insira o ID da tentativa de solicitação de recebimento. É um token usado para desduplicação de mensagens.

  • Tempo limite de visibilidade: Insira o período 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 obter mais informações, consulte Tempo limite de visibilidade do Amazon SQS.

  • Tempo de espera em segundos: Insira o tempo máximo que o Amazon SQS aguarda até que as mensagens fiquem disponíveis depois que a fila recebe uma solicitação de recebimento. Para obter mais informações, consulte Pesquisa curta e longa 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 automaticamente mensagens da fila: Selecione para excluir automaticamente as mensagens recebidas da fila. Ele é selecionado por padrão.

  • Continuar em caso de erro: Selecione para continuar a execução da atividade se for encontrado um erro para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será gravado no log de operação. Ele é selecionado por padrão.

  • Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Revise os Esquemas de Dados

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

Etapa 2 da configuração da atividade de obtenção de mensagens do Amazon SQS

  • 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 usa o AWS SDK for Java versão 1.12.522. Consulte a documentação da API para obter informações sobre os nós e campos do esquema.

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

    • Solicitação:

      Nó/campo do esquema de solicitação Campo/método da API do Amazon SQS Descrição
      GetMessagesRequest ReceberMessageRequest Solicitação para recuperar mensagens de uma fila
      solicitação N/A (nó de solicitação) Nó que representa a solicitação
      nomesdeatributos NomeAtributo (Lista) Lista de atributos a serem recuperados junto com mensagens
      #texto Definido como Todos por padrão, consulte Mensagem API referência para valores aplicáveis
      maxNumberOfMessages MaxNumberOfMessages Inteiro com o número máximo de mensagens a serem recuperadas
      messageAttributeNames MessageAttributeName (Lista) Lista de atributos a serem recuperados em cada mensagem
      #texto Definido como Todos por padrão, consulte Mensagem API referência para valores aplicáveis
      queueUrl URL da fila String com a URL da fila para obter mensagens
      receberRequestAttemptId ReceiveRequestAttemptID String com um token usado para desduplicação de mensagens da fila FIFO
      visibilidadeTimeout VisibilidadeTimeout Inteiro com as configurações de tempo limite de visibilidade das mensagens em segundos
      esperarTimeSeconds Tempo de EsperaSegundos Inteiro com o tempo de espera pelas mensagens em segundos
      autoDeleteMensagens N/A 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 Campo/método da API do Amazon SQS Descrição
      GetMessagesRequest ReceberMessageResponse Resposta da recuperação de mensagens de uma fila
      resposta N/A (nó de resposta) Nó representando a resposta
      mensagem de erro N/A (mensagem de resposta) String definida para a mensagem de erro da resposta
      autoDeleteStatus N/A String definida para o status do resultado de exclusão automática
      mensagens Mensagem (Lista) Lista de mensagens retornadas com a resposta
      corpo Corpo String definida para o corpo da mensagem
      mD5OfBody MD5OfBody String definida como MD5 digest do corpo da mensagem não codificada em URL
      mD5OfMessageAttributes MD5OfMessageAttributes String definida como MD5 digest dos atributos da mensagem não codificada em URL
      messageAttributes Atributo (Lista) Lista de atributos associados à mensagem
      atributoNome Nome String definida como o nome do atributo
      stringValor Valor String definida como o valor do atributo
      tipo de dados Tipo String definida para o tipo de dados do atributo
      ID da mensagem ID da mensagem String definida como o identificador exclusivo da mensagem
      alça de recibo Alça de recibo String define o identificador de recebimento associado à mensagem

    Nota

    Consulte ReceiveMessage para obter informações detalhadas sobre os nós e campos do esquema.

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

  • Voltar: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos

Depois de configurar uma atividade Get Messages do Amazon SQS, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu Ações da atividade em Noções básicas do conector.

As atividades Get Messages do Amazon SQS podem ser usadas como origem com estes padrões de operação:

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

Quando estiver pronto, implantar e execute a operação e validar o comportamento verificando os logs de operação.