Spec-Zone.ru › AWS CLI v2

[ aws . neptune-graph ]

start-export-task

Описание

Экспорт данных из существующего графа Neptune Analytics в Amazon S3. Состояние графа должно быть AVAILABLE.

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

Синтаксис

  start-export-task
--graph-identifier <value>
--role-arn <value>
--format <value>
--destination <value>
--kms-key-identifier <value>
[--parquet-type <value>]
[--export-filter <value>]
[--tags <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]

Параметры

--graph-identifier (строка)

Идентификатор исходного графа задачи экспорта.

--role-arn (строка)

ARN роли IAM, которая позволит экспортировать данные в целевое расположение.

--format (строка)

Формат задачи экспорта.

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

  • PARQUET
  • CSV

--destination (строка)

Amazon S3 URI, в который будут экспортированы данные.

--kms-key-identifier (строка)

Идентификатор ключа KMS задачи экспорта.

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

Тип parquet задачи экспорта.

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

  • COLUMNAR

--export-filter (структура)

Фильтр экспорта задачи экспорта.

vertexFilter -> (массив)

Используется для указания фильтров по меткам для вершин. Это позволяет контролировать, какие метки вершин и свойства включаются в экспорт.

key -> (строка)

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

Указывает, какие свойства этой метки должны быть включены в экспорт.

properties -> (массив)

Каждое свойство определяется парой ключ-значение, где ключ — желаемое имя выходного свойства (например, «name»), а значение — объект.

key -> (строка)

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

Структура, представляющая атрибуты свойства. Это массив outputType, sourcePropertyName и multiValueHandling.

outputType -> (строка)

Указывает тип данных для свойства в экспортированных данных (например, «String», «Int», «Float»). Если тип не указан, процесс экспорта определит тип. Если данное свойство присутствует в нескольких типах (например, у одной вершины «height» хранится как double, а у другого ребра — как строка), тип будет Any, в противном случае — тип свойства, как он представлен в вершинах.

sourcePropertyName -> (строка)

Имя свойства, как оно существует в исходных данных графа. Если не указано, предполагается, что ключ соответствует желаемому sourcePropertyName.

multiValueHandling -> (строка)

Указывает, как обрабатывать свойства, имеющие несколько значений. Может быть либо TO_LIST для экспорта всех значений в виде списка, либо PICK_FIRST для экспорта первого встретившегося значения. Если не указано, значение по умолчанию — PICK_FIRST.

edgeFilter -> (массив)

Используется для указания фильтров по меткам для ребер. Это позволяет контролировать, какие метки ребер и свойства включаются в экспорт.

key -> (строка)

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

Указывает, какие свойства этой метки должны быть включены в экспорт.

properties -> (массив)

Каждое свойство определяется парой ключ-значение, где ключ — желаемое имя выходного свойства (например, «name»), а значение — объект.

key -> (строка)

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

Структура, представляющая атрибуты свойства. Это массив outputType, sourcePropertyName и multiValueHandling.

outputType -> (строка)

Указывает тип данных для свойства в экспортированных данных (например, «String», «Int», «Float»). Если тип не указан, процесс экспорта определит тип. Если данное свойство присутствует в нескольких типах (например, у одной вершины «height» хранится как double, а у другого ребра — как строка), тип будет Any, в противном случае — тип свойства, как он представлен в вершинах.

sourcePropertyName -> (строка)

Имя свойства, как оно существует в исходных данных графа. Если не указано, предполагается, что ключ соответствует желаемому sourcePropertyName.

multiValueHandling -> (строка)

Указывает, как обрабатывать свойства, имеющие несколько значений. Может быть либо TO_LIST для экспорта всех значений в виде списка, либо PICK_FIRST для экспорта первого встретившегося значения. Если не указано, значение по умолчанию — PICK_FIRST.

Сокращенный синтаксис:

vertexFilter={KeyName1={properties={KeyName1={outputType=string,sourcePropertyName=string,multiValueHandling=string},KeyName2={outputType=string,sourcePropertyName=string,multiValueHandling=string}}},KeyName2={properties={KeyName1={outputType=string,sourcePropertyName=string,multiValueHandling=string},KeyName2={outputType=string,sourcePropertyName=string,multiValueHandling=string}}}},edgeFilter={KeyName1={properties={KeyName1={outputType=string,sourcePropertyName=string,multiValueHandling=string},KeyName2={outputType=string,sourcePropertyName=string,multiValueHandling=string}}},KeyName2={properties={KeyName1={outputType=string,sourcePropertyName=string,multiValueHandling=string},KeyName2={outputType=string,sourcePropertyName=string,multiValueHandling=string}}}}

Синтаксис JSON:

{
  "vertexFilter": {"string": {
        "properties": {"string": {
              "outputType": "string",
              "sourcePropertyName": "string",
              "multiValueHandling": "TO_LIST"|"PICK_FIRST"
            }
          ...}
      }
    ...},
  "edgeFilter": {"string": {
        "properties": {"string": {
              "outputType": "string",
              "sourcePropertyName": "string",
              "multiValueHandling": "TO_LIST"|"PICK_FIRST"
            }
          ...}
      }
    ...}
}

--tags (массив)

Метки, которые будут применены к задаче экспорта.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (строка)

Переопределить адрес по умолчанию команды указанным адресом.

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

Вывод

graphId -> (строка)

Идентификатор исходного графа задачи экспорта.

roleArn -> (строка)

ARN роли IAM, которая позволит экспортировать данные в целевой ресурс.

taskId -> (строка)

Уникальный идентификатор задачи экспорта.

status -> (строка)

Текущий статус задачи экспорта.

format -> (строка)

Формат задачи экспорта.

destination -> (строка)

Amazon S3 URI задачи экспорта, в которую будут экспортированы данные.

kmsKeyIdentifier -> (строка)

Идентификатор ключа KMS задачи экспорта.

parquetType -> (строка)

Тип parquet задачи экспорта.

statusReason -> (строка)

Причина, по которой задача экспорта имеет данное значение статуса.

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

Фильтр экспорта задачи экспорта.

vertexFilter -> (массив)

Используется для задания фильтров на основе меток для вершин. Это позволяет управлять тем, какие метки и свойства вершин включаются в экспорт.

key -> (строка)

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

Указывает, какие свойства этой метки должны быть включены в экспорт.

properties -> (массив)

Каждое свойство определяется парой ключ-значение, где ключ — желаемое имя выходного свойства (например, «name»), а значение — объект.

key -> (строка)

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

Структура, представляющая атрибуты свойства. Это объект-массив с полями outputType, sourcePropertyName и multiValueHandling.

outputType -> (строка)

Определяет тип данных, который необходимо использовать для свойства в экспортированных данных (например, «String», «Int», «Float»). Если тип не указан, процесс экспорта определит тип. Если данное свойство присутствует в нескольких типах (например, у одной вершины «высота» хранится как double, а у другого ребра — как строка), тип будет Any, в противном случае — тип свойства, как он представлен в вершинах.

sourcePropertyName -> (строка)

Имя свойства, как оно существует в исходных данных графа. Если не указано, предполагается, что ключ соответствует желаемому sourcePropertyName.

multiValueHandling -> (строка)

Указывает, как обрабатывать свойства, которые имеют несколько значений. Может быть либо TO_LIST для экспорта всех значений в виде списка, либо PICK_FIRST для экспорта первого встретившегося значения. Если не указано, значение по умолчанию — PICK_FIRST.

edgeFilter -> (массив)

Используется для задания фильтров на основе меток для ребер. Это позволяет управлять тем, какие метки и свойства ребер включаются в экспорт.

key -> (строка)

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

Указывает, какие свойства этой метки должны быть включены в экспорт.

properties -> (массив)

Каждое свойство определяется парой ключ-значение, где ключ — желаемое имя выходного свойства (например, «name»), а значение — объект.

key -> (строка)

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

Структура, представляющая атрибуты свойства. Это объект-массив с полями outputType, sourcePropertyName и multiValueHandling.

outputType -> (строка)

Определяет тип данных, который необходимо использовать для свойства в экспортированных данных (например, «String», «Int», «Float»). Если тип не указан, процесс экспорта определит тип. Если данное свойство присутствует в нескольких типах (например, у одной вершины «высота» хранится как double, а у другого ребра — как строка), тип будет Any, в противном случае — тип свойства, как он представлен в вершинах.

sourcePropertyName -> (строка)

Имя свойства, как оно существует в исходных данных графа. Если не указано, предполагается, что ключ соответствует желаемому sourcePropertyName.

multiValueHandling -> (строка)

Указывает, как обрабатывать свойства, которые имеют несколько значений. Может быть либо TO_LIST для экспорта всех значений в виде списка, либо PICK_FIRST для экспорта первого встретившегося значения. Если не указано, значение по умолчанию — PICK_FIRST.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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