Spec-Zone.ru › AWS CLI v2

[ aws . oam ]

получить-ссылку

Описание

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

Для использования этой операции укажите ARN ссылки. Чтобы получить список ARN ссылок, используйте ListLinks.

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

Синтаксис

  get-link
--identifier <value>
[--include-tags | --no-include-tags]
[--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]

Параметры

--identifier (строка)

ARN ссылки, для которой требуется информация.

--include-tags | --no-include-tags (логическое значение)

Указывает, нужно ли включать метки, связанные со ссылкой, в ответ. Когда IncludeTags установлено в значение true и у вызывающего пользователя есть необходимые разрешения, oam:ListTagsForResource , API вернёт метки для указанного ресурса. Если у вызывающего пользователя нет необходимых разрешений, oam:ListTagsForResource , API сгенерирует исключение.

Значение по умолчанию — false.

--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
  • текст
  • таблица
  • 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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, во всех примерах используются правила цитирования Unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Чтобы получить полную информацию об одной ссылке

Следующий get-link пример возвращает полную информацию о ссылке.

aws oam get-link \
    --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111

Вывод:

{
    "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
    "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
    "Label": "sourceAccount",
    "LabelTemplate": "sourceAccount",
    "ResourceTypes": [
        "AWS::CloudWatch::Metric"
    ],
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Tags": {}
}

Для получения дополнительной информации см. раздел Пересекающая учетные записи наблюдательность CloudWatch в руководстве пользователя Amazon CloudWatch.

Вывод

Arn -> (строка)

ARN ссылки.

Id -> (строка)

Случайная строка ID, сгенерированная Amazon Web Services в качестве части ARN ссылки.

Label -> (строка)

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

LabelTemplate -> (строка)

Точная шаблон метки, который был указан при создании ссылки, с неразрешенными переменными шаблона.

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

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

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

Используйте эту структуру для фильтрации групп журналов, которые должны отправлять события журнала из учётной записи-источника в учётную запись мониторинга.

Filter -> (строка)

Используйте это поле для указания групп журналов, которые должны обмениваться событиями журнала с учётной записью мониторинга. Используйте термин LogGroupName и один или несколько следующих операндов. Используйте одинарные кавычки (’) вокруг имён групп журналов. Сопоставление имён групп журналов чувствительно к регистру. Каждый фильтр имеет ограничение в пять условных операндов. Условные операнды — AND и OR.

  • = и !=
  • AND
  • OR
  • LIKE и NOT LIKE . Эти можно использовать только в качестве поиска по префиксу. Включайте % в конце строки, для которой вы хотите выполнить поиск, и включайте её.
  • IN и NOT IN , используя скобки ( )

Примеры:

  • LogGroupName IN ('This-Log-Group', 'Other-Log-Group') включает только группы журналов с именами This-Log-Group и Other-Log-Group.
  • LogGroupName NOT IN ('Private-Log-Group', 'Private-Log-Group-2') включает все группы журналов, за исключением групп журналов с именами Private-Log-Group и Private-Log-Group-2.
  • LogGroupName LIKE 'aws/lambda/%' OR LogGroupName LIKE 'AWSLogs%' включает все группы журналов, у которых имена начинаются с aws/lambda/ или AWSLogs.

Примечание

Если вы обновляете ссылку, которая использует фильтры, вы можете указать * в качестве единственного значения для параметра filter, чтобы удалить фильтр и предоставить все группы журналов для учётной записи мониторинга.

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

Используйте эту структуру для фильтрации пространств имён метрик, которые должны быть совместно использованы от учётной записи-источника до учётной записи мониторинга.

Filter -> (строка)

Используйте это поле для указания метрик, которые должны быть совместно использованы с учётной записью мониторинга. Используйте термин Namespace и один или несколько следующих операндов. Используйте одинарные кавычки (’) вокруг имён пространств имён. Сопоставление имён пространств имён чувствительно к регистру. Каждый фильтр имеет ограничение в пять условных операндов. Условные операнды — AND и OR.

  • = и !=
  • AND
  • OR
  • LIKE и NOT LIKE . Эти можно использовать только в качестве поиска по префиксу. Включайте % в конце строки, для которой вы хотите выполнить поиск, и включайте её.
  • IN и NOT IN , используя скобки ( )

Примеры:

  • Namespace NOT LIKE 'AWS/%' включает только пространства имён, которые не начинаются с AWS/, например, пользовательские пространства имён.
  • Namespace IN ('AWS/EC2', 'AWS/ELB', 'AWS/S3') включает только метрики в пространствах имён EC2, Elastic Load Balancing и Amazon S3.
  • Namespace = 'AWS/EC2' OR Namespace NOT LIKE 'AWS/%' включает только пространство имён EC2 и ваши пользовательские пространства имён.

Примечание

Если вы обновляете ссылку, которая использует фильтры, вы можете указать * в качестве единственного значения для параметра filter, чтобы удалить фильтр и предоставить все пространства имён метрик для учётной записи мониторинга.

ResourceTypes -> (список)

Типы ресурсов, поддерживаемые этой ссылкой.

(строка)

SinkArn -> (строка)

ARN стока, используемого для этой ссылки.

Tags -> (карта)

Метки, назначенные ссылке.

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

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

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

Spec-Zone.ru

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