SendCommand - Base de datos Amazon Quantum Ledger (AmazonQLDB)

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.

SendCommand

Envía un comando a un libro mayor de Amazon QLDB.

nota

En lugar de interactuar directamente con esta API, recomendamos usar el controlador de QLDB o el intérprete de comandos de QLDB para ejecutar transacciones de datos en un libro mayor.

  • Si trabaja con un AWS SDK, utilice el controlador QLDB. El controlador proporciona una capa de abstracción de alto nivel sobre la API de datos de sesión de QLDB, y gestiona la operación de SendCommand por usted. Para obtener más información y una lista de los lenguajes de programación compatibles, consulte Introducción al controlador en la Guía del desarrollador de Amazon QLDB.

  • Si está trabajando con AWS Command Line Interface (AWS CLI), utilice el shell QLDB. El intérprete de comandos es una interfaz de la línea de comandos que usa el controlador de QLDB para interactuar con un libro mayor. Para obtener más información, consulte Acceder a Amazon QLDB mediante el intérprete de comandos de QLDB.

Sintaxis de la solicitud

{ "AbortTransaction": { }, "CommitTransaction": { "CommitDigest": blob, "TransactionId": "string" }, "EndSession": { }, "ExecuteStatement": { "Parameters": [ { "IonBinary": blob, "IonText": "string" } ], "Statement": "string", "TransactionId": "string" }, "FetchPage": { "NextPageToken": "string", "TransactionId": "string" }, "SessionToken": "string", "StartSession": { "LedgerName": "string" }, "StartTransaction": { } }

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

AbortTransaction

Comando para anular la transacción actual.

Tipo: objeto AbortTransactionRequest

Obligatorio: no

CommitTransaction

Comando para confirmar la transacción especificada.

Tipo: objeto CommitTransactionRequest

Obligatorio: no

EndSession

Comando para finalizar la sesión actual.

Tipo: objeto EndSessionRequest

Obligatorio: no

ExecuteStatement

Comando para ejecutar una instrucción en la transacción especificada.

Tipo: objeto ExecuteStatementRequest

Obligatorio: no

FetchPage

Comando para recuperar una página.

Tipo: objeto FetchPageRequest

Obligatorio: no

SessionToken

Especifica el token de sesión del comando actual. Un token de sesión es constante a lo largo de toda la sesión.

Para obtener un token de sesión, ejecute el comando StartSession. Este SessionToken será necesario para todos los comandos posteriores que se emitan durante la sesión actual.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 4. La longitud máxima es de 1024 caracteres.

Patrón: ^[A-Za-z-0-9+/=]+$

Obligatorio: no

StartSession

Comando para iniciar una nueva sesión. Se obtiene un token de sesión como parte de la respuesta.

Tipo: objeto StartSessionRequest

Obligatorio: no

StartTransaction

Comando para iniciar una nueva transacción.

Tipo: objeto StartTransactionRequest

Obligatorio: no

Sintaxis de la respuesta

{ "AbortTransaction": { "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "CommitTransaction": { "CommitDigest": blob, "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "TimingInformation": { "ProcessingTimeMilliseconds": number }, "TransactionId": "string" }, "EndSession": { "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "ExecuteStatement": { "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "FirstPage": { "NextPageToken": "string", "Values": [ { "IonBinary": blob, "IonText": "string" } ] }, "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "FetchPage": { "ConsumedIOs": { "ReadIOs": number, "WriteIOs": number }, "Page": { "NextPageToken": "string", "Values": [ { "IonBinary": blob, "IonText": "string" } ] }, "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "StartSession": { "SessionToken": "string", "TimingInformation": { "ProcessingTimeMilliseconds": number } }, "StartTransaction": { "TimingInformation": { "ProcessingTimeMilliseconds": number }, "TransactionId": "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.

AbortTransaction

Contiene los detalles de la transacción anulada.

Tipo: objeto AbortTransactionResult

CommitTransaction

Contiene los detalles de la transacción confirmada.

Tipo: objeto CommitTransactionResult

EndSession

Contiene los detalles de la sesión finalizada.

Tipo: objeto EndSessionResult

ExecuteStatement

Contiene los detalles de la instrucción ejecutada.

Tipo: objeto ExecuteStatementResult

FetchPage

Contiene los detalles de la página recuperada.

Tipo: objeto FetchPageResult

StartSession

Contiene los detalles de la sesión iniciada, que incluye un token de sesión. Este SessionToken será necesario para todos los comandos posteriores que se emitan durante la sesión actual.

Tipo: objeto StartSessionResult

StartTransaction

Contiene los detalles de la transacción iniciada.

Tipo: objeto StartTransactionResult

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

BadRequestException

Se devuelve si la solicitud tiene un formato incorrecto o contiene un error, como un valor de parámetro no válido o falta de parámetro obligatorio.

Código de estado HTTP: 400

CapacityExceededException

Se devuelve cuando la solicitud supera la capacidad de procesamiento del libro mayor.

Código de estado HTTP: 400

InvalidSessionException

Se devuelve si la sesión ya no existe porque se agotó el tiempo de espera o caducó.

Código de estado HTTP: 400

LimitExceededException

Se devuelve si se supera un límite de recursos, como el número de sesiones activas.

Código de estado HTTP: 400

OccConflictException

Se devuelve cuando no se puede escribir una transacción en el diario debido a un fallo en la fase de verificación del control de concurrencia optimista (OCC).

Código de estado HTTP: 400

RateExceededException

Devuelto cuando la tasa de solicitudes excede el rendimiento permitido.

Código de estado HTTP: 400

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: