[ aws . cognito-sync ]
update-records
Описание
Отправляет обновления записей и добавляет и удаляет записи для набора данных и пользователя.
Счётчик синхронизации в обновлении записи — это ваш последний известный счётчик синхронизации для этой записи. Сервер отклонит запрос UpdateRecords с ResourceConflictException, если вы попытаетесь обновить запись с новым значением, но устаревшим значением счётчика синхронизации.
Например, если счётчик синхронизации на сервере равен 5 для ключа highScore, и вы пытаетесь отправить новое значение highScore со счётчиком синхронизации 4, запрос будет отклонен. Чтобы получить текущий счётчик синхронизации для записи, вызовите ListRecords. При успешном обновлении записи ответ возвращает новый счётчик синхронизации для этой записи. Вы должны предоставить этот счётчик синхронизации в следующий раз, когда будете пытаться обновить эту же запись. Когда запись не существует, укажите счётчик синхронизации как 0.
К этому API можно обращаться с временными учетными данными пользователя, предоставленными Cognito Identity, или с учетными данными разработчика.
См. также: Документация AWS API
Синтаксис
update-records
--identity-pool-id <value>
--identity-id <value>
--dataset-name <value>
[--device-id <value>]
[--record-patches <value>]
--sync-session-token <value>
[--client-context <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--identity-pool-id (строка) Имя-пространственный GUID (например, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE), созданный Amazon Cognito. Генерация GUID уникальна в пределах региона.
--identity-id (строка) Имя-пространственный GUID (например, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE), созданный Amazon Cognito. Генерация GUID уникальна в пределах региона.
--dataset-name (строка) Строка длиной до 128 символов. Разрешенные символы: a-z, A-Z, 0-9, ‘_’ (нижнее подчеркивание), ‘-’ (дефис) и ‘.’ (точка).
--device-id (строка)
--record-patches (список) Список операций обновления (структура).
Операция обновления записи.
Op -> (строка)
Key -> (строка)
Value -> (строка)
SyncCount -> (целое число)
DeviceLastModifiedDate -> (временная метка)
Сокращённый синтаксис:
Op=string,Key=string,Value=string,SyncCount=long,DeviceLastModifiedDate=timestamp ...
Синтаксис JSON:
[
{
"Op": "replace"|"remove",
"Key": "string",
"Value": "string",
"SyncCount": long,
"DeviceLastModifiedDate": timestamp
}
...
]
--sync-session-token (строка) SyncSessionToken, возвращённый предыдущим вызовом ListRecords для этого набора данных и идентификатора.
--client-context (строка) Предназначен для предоставления идентификатора устройства, который заполнит поле lastModifiedBy, упомянутое в других методах. Поле ClientContext пока не реализовано.
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если предоставлено без значения или значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном скелете JSON.
Глобальные параметры
--debug (булево)
Включить отладовую запись в журнал.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров входных данных CLI.
Вывод
Records -> (список)
Список обновлённых записей.
(структура)
Основная структура данных набора данных.
Key -> (строка)
Value -> (строка)
SyncCount -> (целое число)
LastModifiedDate -> (временная метка)
LastModifiedBy -> (строка)
DeviceLastModifiedDate -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.