Saltar al contenido

Actividad de Obtener Mensajes de Amazon SQS

Introducción

Una actividad de Obtener Mensajes de Amazon SQS, utilizando su conexión de Amazon SQS, recupera todos los mensajes de Amazon SQS disponibles en una cola específica y está destinada a ser utilizada como fuente en una operación.

Esta actividad utiliza la acción ReceiveMessage de la API de Amazon SQS.

Requisitos Previos

Para utilizar esta actividad con éxito, debe tener los siguientes permisos de cuenta IAM de AWS:

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

Los permisos entre cuentas no se aplican a esta acción. Para más información, consulte Ejemplos Básicos de Políticas de Amazon SQS en la Guía del Desarrollador de Amazon SQS.

Crear una Actividad de Obtener Mensajes de Amazon SQS

Una instancia de una actividad de Obtener Mensajes de Amazon SQS se crea a partir de una conexión de Amazon SQS utilizando su tipo de actividad Obtener Mensajes.

Para crear una instancia de una actividad, arrastre el tipo de actividad al lienzo de diseño o copie el tipo de actividad y péguelo en el lienzo de diseño. Para más detalles, consulte Crear una instancia de actividad o herramienta en Reutilización de componentes.

Una actividad existente de Obtener Mensajes de Amazon SQS se puede editar desde estas ubicaciones:

Configurar una actividad de Obtener Mensajes de Amazon SQS

Sigue estos pasos para configurar una actividad de Obtener Mensajes de Amazon SQS:

Paso 1: Ingresa un nombre, selecciona una cola y especifica configuraciones

En este paso, proporciona un nombre para la actividad, selecciona una cola y especifica las configuraciones para recibir mensajes.

Configuración de la actividad Obtener Mensajes de Amazon SQS paso 1

Consejo

Los campos con un ícono de variable admiten el uso de variables globales, variables de proyecto y variables de Jitterbit. Comienza escribiendo un corchete cuadrado abierto [ en el campo o haciendo clic en el ícono de variable para mostrar una lista de las variables existentes de las que elegir.

  • Nombre: Ingresa un nombre para identificar la actividad. El nombre debe ser único para cada actividad de Obtener Mensajes de Amazon SQS y no debe contener barras diagonales (/) ni dos puntos (:).

  • Seleccionar una Cola: Esta sección muestra las colas disponibles en el punto final de Amazon SQS. Al reabrir la configuración de una actividad existente, solo se muestra la cola seleccionada en lugar de recargar toda la lista de colas.

    • Cola Seleccionada: Después de seleccionar una cola, se lista aquí.

    • Buscar: Ingresa el valor de cualquier columna en el cuadro de búsqueda para filtrar la lista de colas. La búsqueda no distingue entre mayúsculas y minúsculas. Si las colas ya se muestran en la tabla, los resultados de la tabla se filtran en tiempo real con cada pulsación de tecla. Para recargar las colas desde el punto final al buscar, ingresa criterios de búsqueda y luego actualiza, como se describe a continuación.

    • Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para recargar las colas desde el punto final de Amazon SQS. Esto puede ser útil si se han agregado colas a Amazon SQS. Esta acción actualiza todos los metadatos utilizados para construir la tabla de colas que se muestra en la configuración.

    • Seleccionar una Cola: Dentro de la tabla, haga clic en cualquier parte de una fila para seleccionar una cola. Solo se puede seleccionar una cola. La información disponible para cada cola se obtiene del punto final de Amazon SQS:

      • Nombre: El nombre de la cola de Amazon SQS.

      • Descripción: La descripción de la cola de Amazon SQS.

    Consejo

    Si la tabla no se llena con las colas disponibles, la conexión de Amazon SQS puede no ser exitosa. Asegúrese de estar conectado volviendo a abrir la conexión y volviendo a probar las credenciales.

  • ID de Intento de Solicitud de Recepción: Ingrese el ID de intento de solicitud de recepción. Es un token utilizado para la deduplicación de mensajes.

  • Tiempo de Espera de Visibilidad: Ingrese la duración de tiempo durante la cual un mensaje recibido de una cola (por un consumidor) no será visible para los otros consumidores de mensajes. Esto puede variar de 0 a 43,200 segundos. Para más información, consulte Tiempo de Espera de Visibilidad de Amazon SQS.

  • Segundos de Tiempo de Espera: Ingrese la cantidad máxima de tiempo que Amazon SQS espera a que los mensajes estén disponibles después de que la cola recibe una solicitud de recepción. Para más información, consulte Sondeo Corto y Largo de Amazon SQS.

  • Número Máximo de Mensajes: Ingrese el número máximo de mensajes a recuperar. Esto puede variar de 1 a 10 mensajes.

  • Eliminar Mensajes Automáticamente de la Cola: Seleccione para eliminar automáticamente los mensajes recibidos de la cola. Está seleccionado por defecto.

  • Continuar en Caso de Error: Seleccione para continuar la ejecución de la actividad si se encuentra un error para un conjunto de datos en una solicitud por lotes. Si se encuentran errores, se escriben en el registro de operaciones. Está seleccionado por defecto.

  • Guardar y salir: Si está habilitado, haga clic para guardar la configuración de este paso y cerrar la configuración de la actividad.

  • Siguiente: Haga clic para almacenar temporalmente la configuración de este paso y continuar al siguiente paso. La configuración no se guardará hasta que haga clic en el botón Finalizado en el último paso.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea descartar los cambios.

Paso 2: Revisar los esquemas de datos

Cualquier esquema de solicitud o respuesta generado desde el punto final se muestra.

Configuración de la actividad Amazon SQS Obtener mensajes paso 2

  • Esquemas de datos: Estos esquemas de datos son heredados por transformaciones adyacentes y se muestran nuevamente durante el mapeo de transformaciones.

    Nota

    Los datos suministrados en una transformación tienen prioridad sobre la configuración de la actividad.

    El conector de Amazon SQS utiliza la AWS SDK para Java versión 1.12.522. Consulte la documentación de la API para obtener información sobre los nodos y campos del esquema.

    Los esquemas de datos de solicitud y respuesta constan de estos nodos y campos:

    • Solicitud:

      Nodo/Campo del esquema de solicitud Campo/Método de la API de Amazon SQS Descripción
      GetMessagesRequest ReceiveMessageRequest Solicitud para recuperar mensajes de una cola
      request N/A (Nodo de solicitud) Nodo que representa la solicitud
      attributeNames AttributeName (Lista) Lista de atributos a recuperar junto con los mensajes
      #text Establecido en Todos por defecto, consulte la referencia de API Message para valores aplicables
      maxNumberOfMessages MaxNumberOfMessages Entero con el número máximo de mensajes a recuperar
      messageAttributeNames MessageAttributeName (Lista) Lista de atributos a recuperar dentro de cada mensaje
      #text Establecido en Todos por defecto, consulte la referencia de API Message para valores aplicables
      queueUrl QueueUrl Cadena con la URL de la cola de la que obtener mensajes
      receiveRequestAttemptId ReceiveRequestAttemptId Cadena con un token utilizado para la deduplicación de mensajes en colas FIFO
      visibilityTimeout VisibilityTimeout Entero con la configuración del tiempo de visibilidad de los mensajes en segundos
      waitTimeSeconds WaitTimeSeconds Entero con la duración del tiempo de espera para mensajes en segundos
      autoDeleteMessages N/A Booleano que determina si se deben eliminar o no los mensajes después de la recuperación

    • Respuesta:

      Nodo/Campo del Esquema de Respuesta Campo/Método de la API de Amazon SQS Descripción
      GetMessagesRequest ReceiveMessageResponse Respuesta de la recuperación de mensajes de una cola
      response N/A (Nodo de Respuesta) Nodo que representa la respuesta
      errorMessage N/A (Mensaje de Respuesta) Cadena establecida en el mensaje de error de la respuesta
      autoDeleteStatus N/A Cadena establecida en el estado del resultado de eliminación automática
      messages Mensaje (Lista) Lista de mensajes devueltos con la respuesta
      body Cuerpo Cadena establecida en el cuerpo del mensaje
      mD5OfBody MD5OfBody Cadena establecida en el resumen MD5 del cuerpo del mensaje no codificado en URL
      mD5OfMessageAttributes MD5OfMessageAttributes Cadena establecida en el resumen MD5 de los atributos del mensaje no codificados en URL
      messageAttributes Atributo (Lista) Lista de atributos asociados con el mensaje
      attrName Nombre Cadena establecida en el nombre del atributo
      stringValue Valor Cadena establecida en el valor del atributo
      dataType Tipo Cadena establecida en el tipo de dato del atributo
      messageId MessageId Cadena establecida en el identificador único del mensaje
      receiptHandle ReceiptHandle Cadena establecida en el identificador de recibo asociado con el mensaje

    Nota

    Referirse a la acción ReceiveMessage para obtener información detallada sobre los nodos y campos del esquema.

  • Actualizar: Haga clic en el ícono de actualizar o en la palabra Actualizar para regenerar esquemas desde el punto final de Amazon SQS. Esta acción también regenera un esquema en otras ubicaciones a lo largo del proyecto donde se hace referencia al mismo esquema, como en una transformación adyacente.

  • Atrás: Haga clic para almacenar temporalmente la configuración de este paso y regresar al paso anterior.

  • Terminado: Haga clic para guardar la configuración de todos los pasos y cerrar la configuración de la actividad.

  • Descartar cambios: Después de realizar cambios, haga clic para cerrar la configuración sin guardar los cambios realizados en ningún paso. Un mensaje le pide que confirme que desea descartar los cambios.

Próximos pasos

Después de configurar una actividad de Amazon SQS Obtener mensajes, complete la configuración de la operación agregando y configurando otras actividades o herramientas como pasos de operación. También puede configurar los ajustes de la operación, que incluyen la capacidad de encadenar operaciones que están en los mismos o diferentes flujos de trabajo.

Las acciones del menú para una actividad son accesibles desde el panel del proyecto y el lienzo de diseño. Para más detalles, consulte el menú de acciones de actividad en Conceptos básicos de conectores.

Las actividades de Amazon SQS Obtener mensajes se pueden utilizar como fuente con estos patrones de operación:

Para utilizar la actividad con funciones de scripting, escribe los datos en una ubicación temporal y luego usa esa ubicación temporal en la función de scripting.

Cuando estés listo, despliega y ejecuta la operación y valida el comportamiento revisando los registros de la operación.