Spec-Zone.ru › AWS CLI v2

[ aws . clouddirectory ]

list-outgoing-typed-links

Описание

Возвращает постраничный список всей информации об исходящих TypedLinkSpecifier для объекта. Также поддерживает фильтрацию по аспекту типизированной ссылки и атрибутам идентификации. Для получения дополнительной информации см. Типизированные ссылки .

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

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

Синтаксис

  list-outgoing-typed-links
--directory-arn <value>
--object-reference <value>
[--filter-attribute-ranges <value>]
[--filter-typed-link <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 (строка)

Amazon Resource Name (ARN) каталога, в котором необходимо перечислить типизированные ссылки.

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

Ссылка, идентифицирующая объект, атрибуты которого необходимо перечислить.

Selector -> (строка)

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

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

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

Selector=string

Синтаксис JSON:

{
  "Selector": "string"
}

--filter-attribute-ranges (список)

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

(структура)

Идентифицирует диапазон атрибутов, используемых указанным фильтром.

AttributeName -> (строка)

Уникальное имя атрибута типизированной ссылки.

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

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

StartMode -> (строка)

Включительно или исключающий начальный диапазон.

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

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

StringValue -> (строка)

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

BinaryValue -> (бинарные данные)

Значение данных в бинарном формате.

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

Значение логического типа данных.

NumberValue -> (строка)

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

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

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

EndMode -> (строка)

Включительно или исключающий конечный диапазон.

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

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

StringValue -> (строка)

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

BinaryValue -> (бинарные данные)

Значение данных в бинарном формате.

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

Значение логического типа данных.

NumberValue -> (строка)

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

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

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

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

AttributeName=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:

[
  {
    "AttributeName": "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
      }
    }
  }
  ...
]

--filter-typed-link (структура)

Фильтры интерпретируются в порядке определения атрибутов в аспекте типизированной ссылки, а не в порядке их предоставления в API-вызовах.

SchemaArn -> (строка)

Amazon Resource Name (ARN), связанный со схемой. Дополнительную информацию см. в разделе arns .

TypedLinkName -> (строка)

Уникальное имя аспекта типизированной ссылки.

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

SchemaArn=string,TypedLinkName=string

Синтаксис JSON:

{
  "SchemaArn": "string",
  "TypedLinkName": "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 Command Line Interface .

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

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

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

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

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

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

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

Вывод

TypedLinkSpecifiers -> (список)

Возвращает спецификатор типизированной ссылки в качестве вывода.

(структура)

Содержит всю информацию, используемую для уникальной идентификации типизированной ссылки. Параметры, обсуждаемые в этой теме, используются для уникальной идентификации обрабатываемой типизированной ссылки. API AttachTypedLink возвращает спецификатор типизированной ссылки, а API DetachTypedLink принимает его в качестве входных данных. Аналогично, операции API ListIncomingTypedLinks и ListOutgoingTypedLinks предоставляют спецификаторы типизированных ссылок в качестве вывода. Вы также можете создать спецификатор типизированной ссылки с нуля.

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

Идентифицирует аспект типизированной ссылки, связанный с типизированной ссылкой.

SchemaArn -> (строка)

Идентификатор ресурса Amazon (ARN), связанный со схемой. Дополнительную информацию см. в arns .

TypedLinkName -> (строка)

Уникальное имя аспекта типизированной ссылки.

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

Идентифицирует исходный объект, к которому будет прикреплена типизированная ссылка.

Selector -> (строка)

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

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

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

Идентифицирует целевой объект, к которому будет прикреплена типизированная ссылка.

Selector -> (строка)

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

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

IdentityAttributeValues -> (список)

Идентифицирует значение атрибута для обновления.

(структура)

Идентифицирует имя и значение атрибута для типизированной ссылки.

AttributeName -> (строка)

Имя атрибута типизированной ссылки.

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

Значение для типизированной ссылки.

StringValue -> (строка)

Значение строковых данных.

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

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

BooleanValue -> (булево)

Значение данных типа «Булево».

NumberValue -> (строка)

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

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

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

NextToken -> (строка)

Токен пагинации.

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

Spec-Zone.ru

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