Skip to main content
POST
Suscribir un destino a un tema
Requiere la acción IAM notifications:Subscribe. Consulte NOTIFICATIONS permisos para la lista completa, el alcance de cada acción y un ejemplo de política.

Autorizaciones

Authorization
string
header
requerido

Un token bearer de OAuth 2.0, enviado como Authorization: Bearer <token>. Esta es la forma recomendada de autenticación.

Obtén el token intercambiando el par de claves de acceso de una cuenta de servicio en POST /v1/oauth/token con grant_type=client_credentials. Es el flujo estándar de credenciales de cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar el token por ti.

Los tokens duran una hora por defecto. El mismo par de claves de acceso también sirve como credencial AWS SigV4 para el endpoint de objetos compatible con S3, que solo acepta ese método de autenticación.

Encabezados

Idempotency-Key
string

Clave opcional generada por el cliente que hace que una creación sea segura para la reproducción. Al volver a intentar una solicitud con la misma clave, se devuelve el resultado original literalmente en lugar de crear un recurso duplicado. Se rechaza la reutilización de una clave con un cuerpo de solicitud diferente (422); una solicitud cuya clave todavía se está procesando devuelve 409. Los registros se mantienen durante 24 horas. Usa un UUID o un token único similar.

Maximum string length: 255

Parámetros de ruta

topic_id
string<uuid>
requerido
Ejemplo:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Cuerpo

application/json
protocol
enum<string>
requerido
Opciones disponibles:
email,
https,
http,
queue
Ejemplo:

"https"

endpoint
string
requerido

Dirección de email, URL http/https con esquema correspondiente al protocolo y dirección públicamente enrutable o, para queue, UUID, CRN o nombre exacto de una cola en la cuenta y región del suscriptor. Las colas se almacenan y devuelven como CRN canónicos. Las suscripciones de cola se confirman al crearse: el consentimiento se verifica mediante el permiso queue:SendMessage. Email y webhooks requieren confirmación del propietario del destino.

Maximum string length: 2048
Ejemplo:

"https://hooks.example.com/basaltic"

raw_message_delivery
boolean
predeterminado:false

Solo http/https.

Ejemplo:

false

filter_policy
object

Filtra atributos de la publicación, no campos del cuerpo. Cada atributo debe coincidir con una alternativa: AND entre nombres y OR dentro de cada lista. Los nombres y comparaciones distinguen mayúsculas. Una política omitida o vacía acepta todos los mensajes.

Alternativas: cadenas o números exactos, u objetos con un operador: {"prefix": "order."}, {"suffix": ".failed"}, {"anything-but": ["debug", "trace"]}, {"exists": true}, {"exists": false} o {"numeric": [">=", 100, "<", 1000]}. Los prefijos y sufijos no pueden estar vacíos. anything-but acepta una cadena, número o lista de 1–50 valores.

Solo exists: false acepta un atributo ausente. La exclusión también exige presencia. Operadores numéricos: =, <, <=, > y >=; todos los pares deben ser verdaderos. Los valores no numéricos no coinciden. Los números simples comparan representaciones textuales; use numeric para la equivalencia entre "100" y "100.0".

Hasta 20 nombres no vacíos, con 1–50 alternativas por nombre. Un operador por objeto. No hay comodines, expresiones regulares, filtros del cuerpo ni operadores anidados. PATCH sustituye toda la política; {} la borra y omitirla la conserva. Consulte Políticas de filtro.

Ejemplo:
delivery_policy
object

Política de reintentos. Los campos omitidos heredan el tema y después los valores predeterminados: 6 intentos, espera exponencial de 20s a 20min con variación aleatoria y timeout de 15s. La herencia se aplica por campo; cambiar max_attempts conserva la curva del tema.

redrive_policy
object

Cola de la cuenta del suscriptor que recibe fallos definitivos como mensajes delivery_failure, con la notificación original y un bloque failure que contiene ID, destino, intentos, último error y estado. Sin cola, los fallos siguen disponibles en registros y métricas. Exige queue:SendMessage al definir la política. En suscripciones de cola, el destino debe ser distinto de la cola suscrita.

tags
object
Ejemplo:

Respuesta

Suscripción creada o existente devuelta.

subscription
object
requerido
signing_secret
string

Clave HMAC para verificar entregas por webhook. Se devuelve solo en la primera creación http/https; ausente para email y para suscripciones existentes.

Ejemplo:

"kJ8vQ2xR5tY7uI0oP3aS6dF9gH1jK4lZ7xC0vB3nM6Q"