list-records

Описание

Получает постранично записи, необязательно изменённые после определённого синхронизационного счётчика для набора данных и идентификатора. В Amazon Cognito Sync каждый идентификатор имеет доступ только к собственным данным. Таким образом, учетные данные, используемые для выполнения этого API-запроса, должны иметь доступ к данным идентификатора.

ListRecords можно вызвать с временными учетными данными пользователя, предоставленными Cognito Identity, или с учетными данными разработчика. Вы должны использовать учетные данные Cognito Identity для выполнения этого API-запроса.

См. также: AWS API Documentation

Синтаксис

  list-records
--identity-pool-id <value>
--identity-id <value>
--dataset-name <value>
[--last-sync-count <value>]
[--next-token <value>]
[--max-results <value>]
[--sync-session-token <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, ‘_’ (подчеркивание), ‘-’ (дефис) и ‘.’ (точка).

--last-sync-count (целое число) Последний счётчик серверной синхронизации для этой записи.

--next-token (строка) Маркер постраничной навигации для получения следующей страницы результатов.

--max-results (целое число) Максимальное количество результатов, которые должны быть возвращены.

--sync-session-token (строка) Токен, содержащий идентификатор сеанса, идентификатор пользователя и срок действия.

--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
• текст
• таблица
• yaml
• yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить вывод цвета.

• вкл
• выкл
• авто

--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.

Вывод

Записи -> (список)

NextToken -> (строка)

Счёт -> (целое число)

DatasetSyncCount -> (целое число)

LastModifiedBy -> (строка)

MergedDatasetNames -> (список)

DatasetExists -> (логическое значение)

DatasetDeletedAfterRequestedSyncCount -> (логическое значение)

SyncSessionToken -> (строка)