Spec-Zone.ru › AWS CLI v2

[ aws . backupsearch ]

start-search-result-export-job

Описание

Эта операция запускает задачу экспорта результатов поиска в указанный ведро S3.

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

Синтаксис

  start-search-result-export-job
--search-job-identifier <value>
--export-specification <value>
[--client-token <value>]
[--tags <value>]
[--role-arn <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]

Параметры

--search-job-identifier (строка)

Уникальная строка, определяющая задачу поиска.

--export-specification (меченый союз структур)

Это спецификация, содержащая необходимую строку назначения ведра; необязательно, вы можете включить префикс назначения.

Примечание

Это меченый союз структур. Только один из следующих верхних ключей может быть установлен: s3ExportSpecification.

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

Это задаёт назначенное Amazon S3 ведро для задачи экспорта. И, если указано, также задаёт префикс назначения.

DestinationBucket -> (строка)

Это задаёт назначенное Amazon S3 ведро для задачи экспорта.

DestinationPrefix -> (строка)

Это задаёт префикс назначения для Amazon S3 ведра задачи экспорта.

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

s3ExportSpecification={DestinationBucket=string,DestinationPrefix=string}

Синтаксис JSON:

{
  "s3ExportSpecification": {
    "DestinationBucket": "string",
    "DestinationPrefix": "string"
  }
}

--client-token (строка)

Включите этот параметр, чтобы разрешить несколько одинаковых вызовов для идемпотентности.

Токен клиента действителен в течение 8 часов после завершения первого запроса, который его использует. После этого времени любой запрос с тем же токеном обрабатывается как новый запрос.

--tags (массив)

Необязательные теги для включения. Тег — это пара ключ-значение, которую вы можете использовать для управления, фильтрации и поиска ваших ресурсов. Разрешённые символы включают буквы UTF-8, цифры, пробелы и следующие символы: + - = . _ : /.

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Этот параметр задаёт ARN роли, используемой для запуска задач экспорта результатов поиска.

--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 (boolean)

Включить отладку.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут представлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет рассматриваться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросить параметры ввода CLI.

Вывод

ExportJobArn -> (string)

Это уникальный ARN (Amazon Resource Name), принадлежащий новой задаче экспорта.

ExportJobIdentifier -> (string)

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

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

Spec-Zone.ru

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