Spec-Zone.ru › AWS CLI v2

[ aws . clouddirectory ]

список-индексов

Описание

Отображает объекты, присоединённые к указанному индексу.

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

list-index это операция с постраничной загрузкой. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: IndexAttachments

Синтаксис

  list-index
--directory-arn <value>
[--ranges-on-indexed-values <value>]
--index-reference <value>
[--consistency-level <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

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

ARN каталога, в котором существует индекс.

--ranges-on-indexed-values (список)

Указывает диапазоны индексированных значений, которые вы хотите запросить.

(структура)

Диапазон атрибутов.

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

Ключ атрибута, который охватывает диапазон атрибута.

SchemaArn -> (строка)

Amazon Resource Name (ARN) схемы, содержащей фасет и атрибут.

FacetName -> (строка)

Имя фасета, в котором существует атрибут.

Name -> (строка)

Имя атрибута.

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

Диапазон значений атрибутов, которые выбираются.

StartMode -> (строка)

Начальная точка диапазона (включительно или исключающее).

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

Значение, с которого начинается диапазон.

StringValue -> (строка)

Строковое значение данных.

BinaryValue -> (двоичные данные)

Двоичное значение данных.

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

Логическое значение данных.

NumberValue -> (строка)

Числовое значение данных.

DatetimeValue -> (маркер времени)

Значение даты и времени.

EndMode -> (строка)

Конечная точка диапазона (включительно или исключающее).

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

Значение атрибута, по которому завершается диапазон.

StringValue -> (строка)

Строковое значение данных.

BinaryValue -> (двоичные данные)

Двоичное значение данных.

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

Логическое значение данных.

NumberValue -> (строка)

Числовое значение данных.

DatetimeValue -> (маркер времени)

Значение даты и времени.

Краткая синтаксическая запись:

AttributeKey={SchemaArn=string,FacetName=string,Name=string},Range={StartMode=string,StartValue={StringValue=string,BinaryValue=blob,BooleanValue=boolean,NumberValue=string,DatetimeValue=timestamp},EndMode=string,EndValue={StringValue=string,BinaryValue=blob,BooleanValue=boolean,NumberValue=string,DatetimeValue=timestamp}} ...

Синтаксис JSON:

[
  {
    "AttributeKey": {
      "SchemaArn": "string",
      "FacetName": "string",
      "Name": "string"
    },
    "Range": {
      "StartMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
      "StartValue": {
        "StringValue": "string",
        "BinaryValue": blob,
        "BooleanValue": true|false,
        "NumberValue": "string",
        "DatetimeValue": timestamp
      },
      "EndMode": "FIRST"|"LAST"|"LAST_BEFORE_MISSING_VALUES"|"INCLUSIVE"|"EXCLUSIVE",
      "EndValue": {
        "StringValue": "string",
        "BinaryValue": blob,
        "BooleanValue": true|false,
        "NumberValue": "string",
        "DatetimeValue": timestamp
      }
    }
  }
  ...
]

--index-reference (структура)

Ссылка на индекс, который нужно отобразить.

Selector -> (строка)

Селектор пути обеспечивает легкий выбор объекта по ссылкам родитель/ребёнок, ведущим к нему от корня каталога. Используйте имена ссылок из каждой ссылки родитель/ребёнок для построения пути. Селекторы путей начинаются с косой черты (/), а имена ссылок разделяются косыми чертами. Дополнительную информацию о путях см. в разделе Доступ к объектам. Вы можете идентифицировать объект одним из следующих способов:

  • $ObjectIdentifier - Идентификатор объекта — это непрозрачная строка, предоставленная Amazon Cloud Directory. При создании объектов система предоставит вам идентификатор созданного объекта. Идентификатор объекта неизменяемый и любые два объекта никогда не будут иметь одинаковый идентификатор объекта. Для идентификации объекта с помощью ObjectIdentifier, ObjectIdentifier должен быть заключён в двойные кавычки.
  • /some/path - Идентифицирует объект на основе пути
  • #SomeBatchReference - Идентифицирует объект в вызове пакетной обработки

Краткая синтаксическая запись:

Selector=string

Синтаксис JSON:

{
  "Selector": "string"
}

--consistency-level (строка)

Уровень согласованности для выполнения запроса.

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

  • SERIALIZABLE
  • EVENTUAL

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.

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

Токен для указания начала постраничной загрузки. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная загрузка в Руководстве пользователя командной строки AWS.

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

Вывод

IndexAttachments -> (список)

Объекты и индексированные значения, прикрепленные к индексу.

(структура)

Представляет индекс и прикрепленный объект.

IndexedAttributes -> (список)

Индексированные значения атрибутов.

(структура)

Комбинация ключа атрибута и значения атрибута.

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

Ключ атрибута.

SchemaArn -> (строка)

Amazon Resource Name (ARN) схемы, содержащей фасет и атрибут.

FacetName -> (строка)

Имя фасета, в котором существует атрибут.

Name -> (строка)

Имя атрибута.

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

Значение атрибута.

StringValue -> (строка)

Строковое значение данных.

BinaryValue -> (двоичные данные)

Двоичное значение данных.

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

Логическое значение данных.

NumberValue -> (строка)

Числовое значение данных.

DatetimeValue -> (маркер времени)

Значение даты и времени.

ObjectIdentifier -> (строка)

В ответ на ListIndex , ObjectIdentifier объекта, прикрепленного к индексу. В ответ на ListAttachedIndices , ObjectIdentifier индекса, прикрепленного к объекту. Это поле всегда будет содержать ObjectIdentifier объекта на противоположной стороне прикрепления, указанного в запросе.

NextToken -> (строка)

Токен постраничной загрузки.

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

Spec-Zone.ru

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