Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
StreamJournalToKinesis
Crea una transmisión de diarios para un determinado libro mayor de Amazon QLDB. El flujo captura cada revisión del documento que está comprometida con el libro mayor y entrega los datos a un recurso de Amazon Kinesis Data Streams especificado.
Sintaxis de la solicitud
POST /ledgers/name/journal-kinesis-streams HTTP/1.1
Content-type: application/json
{
"ExclusiveEndTime": number,
"InclusiveStartTime": number,
"KinesisConfiguration": {
"AggregationEnabled": boolean,
"StreamArn": "string"
},
"RoleArn": "string",
"StreamName": "string",
"Tags": {
"string" : "string"
}
}Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- name
-
El nombre de contabilidad.
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 32 caracteres.
Patrón:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Obligatorio: sí
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ExclusiveEndTime
-
La fecha y hora exclusivas que especifican cuándo termina la transmisión. Si no define este parámetro, la transmisión se ejecutará indefinidamente hasta que lo cancele.
La
ExclusiveEndTimedebe estar en formato de fecha y horaISO 8601y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z.Tipo: marca temporal
Obligatorio: no
- InclusiveStartTime
-
Fecha y hora de inicio inclusivas a partir de la cual se iniciará la transmisión de datos del diario. Este parámetro debe estar en formato de fecha y hora
ISO 8601y en hora universal coordinada (UTC). Por ejemplo:2019-06-13T21:36:34Z.El
InclusiveStartTimeno puede estar en el futuro y debe ir antes deExclusiveEndTime.Si proporciona un
InclusiveStartTimeque sea anterior a laCreationDateTimede contabilidad, QLDB lo asigna por defecto a laCreationDateTimede contabilidad.Tipo: marca temporal
Obligatorio: sí
- KinesisConfiguration
-
Los ajustes de la configuración del destino de Kinesis Data Streams de su solicitud de transmisión.
Tipo: objeto KinesisConfiguration
Obligatorio: sí
- RoleArn
-
El nombre de recurso de Amazon (ARN) del rol de IAM que concede a QLDB permisos para que una transmisión de diario escriba registros de datos en un recurso de Kinesis Data Streams.
Para transferir un rol a QLDB al solicitar una secuencia, debe tener permisos para realizar la acción
iam:PassRoleen el recurso de rol de IAM. Esto es necesario para todas las solicitudes de secuencias.Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
Obligatorio: sí
- StreamName
-
Nombre que desea asignar al flujo de diario QLDB. Los nombres definidos por el usuario pueden ayudar a identificar e indicar el propósito de un flujo.
El nombre del flujo debe ser único entre otros flujos activos de un libro mayor determinado. Los nombres de la transmisión tienen las mismas restricciones de denominación que los nombres de contabilidad, tal como se definen en Cuotas en Amazon QLDB en la Guía para desarrolladores de Amazon QLDB.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 32 caracteres.
Patrón:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$Obligatorio: sí
- Tags
-
Los pares clave-valor que quiera agregar como etiquetas a la transmisión que desea crear. Las claves de etiqueta distinguen entre mayúsculas y minúsculas. Los valores de etiquetas distinguen entre mayúsculas y minúsculas y pueden ser nulos.
Tipo: mapa de cadena a cadena
Entradas de mapa: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.
Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.
Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.
Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"StreamId": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- StreamId
-
El UUID (representado en texto codificado en Base62) que QLDB asigna a cada transmisión de diario QLDB.
Tipo: cadena
Limitaciones de longitud: longitud fija de 22.
Patrón:
^[A-Za-z-0-9]+$
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterException
-
Uno o más parámetros de la solicitud no son válidos.
Código de estado HTTP: 400
- ResourceNotFoundException
-
El recurso especificado no existe.
Código de estado HTTP: 404
- ResourcePreconditionNotMetException
-
La operación ha fallado porque no se ha cumplido una condición previa.
Código de estado HTTP: 412
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente:
