Spec-Zone.ru › AWS CLI v2

[ aws . neptunedata ]

get-propertygraph-stream

Описание

Получает поток для графа свойств.

С помощью функции Neptune Streams вы можете сгенерировать полный набор записей журнала изменений, которые записывают каждое изменение данных вашего графа по мере его выполнения. GetPropertygraphStream позволяет собирать эти записи журнала изменений для графа свойств.

Функция Neptune streams должна быть включена в вашем кластере баз данных Neptune. Чтобы включить потоки, установите параметр кластера баз данных neptune_streams в значение 1 .

См. Захват изменений графа в реальном времени с помощью потоков Neptune.

При вызове этой операции в кластере Neptune, в котором включена аутентификация IAM, пользователь или роль IAM, производящие запрос, должны иметь прикреплённую политику, разрешающую действие IAM neptune-db:GetStreamRecords в этом кластере.

При вызове этой операции в кластере Neptune, в котором включена аутентификация IAM, пользователь или роль IAM, производящие запрос, должны иметь прикреплённую политику, разрешающую одно из следующих действий IAM в зависимости от запроса:

Обратите внимание, что вы можете ограничить запросы графов свойств, используя следующие ключи контекста IAM:

  • neptune-db:QueryLanguage:Gremlin
  • neptune-db:QueryLanguage:OpenCypher

См. Доступные ключи условий в политиках доступа к данным Neptune IAM.

См. также: Документация API AWS

get-propertygraph-stream использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команды, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  get-propertygraph-stream
[--limit <value>]
[--iterator-type <value>]
[--commit-num <value>]
[--op-num <value>]
[--encoding <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]

Опции

--limit (целое число)

Указывает максимальное количество записей для возврата. Также существует ограничение размера ответа в 10 МБ, которое нельзя изменить и которое имеет приоритет над количеством записей, указанных в параметре limit. Ответ включает запись, нарушающую порог, если был достигнут предел в 10 МБ.

Диапазон значений для limit составляет от 1 до 100 000, по умолчанию 10.

--iterator-type (строка)

Может быть одним из следующих:

  • AT_SEQUENCE_NUMBER — Указывает, что чтение должно начинаться с номера последовательности события, указанного совместно параметрами commitNum и opNum.
  • AFTER_SEQUENCE_NUMBER — Указывает, что чтение должно начинаться сразу после номера последовательности события, указанного совместно параметрами commitNum и opNum.
  • TRIM_HORIZON — Указывает, что чтение должно начинаться с последней не обрезанной записи в системе, которая является самой старой не истекшей (ещё не удалённой) записью в потоке журнала изменений.
  • LATEST — Указывает, что чтение должно начинаться с самой последней записи в системе, которая является самой последней не истекшей (ещё не удалённой) записью в потоке журнала изменений.

Возможные значения:

  • AT_SEQUENCE_NUMBER
  • AFTER_SEQUENCE_NUMBER
  • TRIM_HORIZON
  • LATEST

--commit-num (целое число)

Номер коммита начальной записи для чтения из потока журнала изменений. Этот параметр требуется, когда iteratorType равен``AT_SEQUENCE_NUMBER`` или AFTER_SEQUENCE_NUMBER, и игнорируется, когда iteratorType равен TRIM_HORIZON или LATEST.

--op-num (целое число)

Номер операции последовательности внутри указанного коммита для начала чтения из данных потока журнала изменений. По умолчанию — 1.

--encoding (строка)

Если установлено в TRUE, Neptune сжимает ответ с помощью кодирования gzip.

Возможные значения:

  • gzip

--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
  • таблица
  • 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.

Вывод

lastEventId -> (словарь)

Идентификатор последовательности последнего изменения в ответном потоке.

Идентификатор события состоит из двух полей: commitNum, который идентифицирует транзакцию, изменившую граф, и opNum, который идентифицирует конкретную операцию в рамках этой транзакции:

ключ -> (строка)

значение -> (строка)

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

Время запроса коммита для транзакции в миллисекундах с начала эпохи Unix.

формат -> (строка)

Формат сериализации записей журнала изменений, возвращаемых в ответе. В настоящее время поддерживается только значение PG_JSON.

records -> (список)

Массив сериализованных записей потока журнала изменений, включённых в ответ.

(структура)

Структура записи графа свойств.

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

Время запроса коммита для транзакции в миллисекундах с начала эпохи Unix.

eventId -> (словарь)

Идентификатор последовательности записи изменения потока.

ключ -> (строка)

значение -> (строка)

data -> (структура)

Сериализованная запись изменения Gremlin или openCypher.

id -> (строка)

Идентификатор элемента Gremlin или openCypher.

тип -> (строка)

Тип этого элемента Gremlin или openCypher. Должен быть одним из следующих:

  • **v1 ** - Метка вершины для Gremlin или метка узла для openCypher.
  • **vp ** - Свойства вершины для Gremlin или свойства узла для openCypher.
  • **e ** - Рёбра и метки рёбер для Gremlin или отношения и тип отношения для openCypher.
  • **ep ** - Свойства рёбер для Gremlin или свойства отношений для openCypher.

ключ -> (строка)

Имя свойства. Для меток элементов это label.

значение -> (документ)

Это JSON-объект, который содержит поле value для самого значения и поле datatype для JSON-типа данных этого значения:

от -> (строка)

Если это ребро (тип = e), идентификатор соответствующей from вершины или узла-источника.

до -> (строка)

Если это ребро (тип = e), идентификатор соответствующей to вершины или узла-назначения.

op -> (строка)

Операция, которая создала изменение.

isLastOp -> (булево значение)

Присутствует только если эта операция является последней в своей транзакции. Если присутствует, установлено в true. Полезно для обеспечения того, чтобы вся транзакция была обработана.

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

Общее количество записей в ответе.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API