Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-verified-access-instances

Описание

Описывает указанные экземпляры Amazon Web Services Verified Access.

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

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

Синтаксис

  describe-verified-access-instances
[--verified-access-instance-ids <value>]
[--filters <value>]
[--dry-run | --no-dry-run]
[--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]

Параметры

--verified-access-instance-ids (список)

Идентификаторы экземпляров Verified Access.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров. Имена и значения фильтров чувствительны к регистру.

(структура)

Пара имя-значение фильтра, используемая для получения более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы укажете несколько фильтров, фильтры будут объединены с помощью AND, и запрос вернёт только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе «Список и фильтрация с помощью командной строки и API» в руководстве пользователя Amazon EC2.

Имя -> (строка)

Имя фильтра. Имена фильтров чувствительны к регистру.

Значения -> (список)

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы укажете несколько значений для фильтра, значения будут объединены с помощью OR, и запрос вернёт все результаты, соответствующие любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

Проверяет, имеете ли вы необходимые разрешения для действия, не выполняя сам запрос, и возвращает ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке будет DryRunOperation. В противном случае - UnauthorizedOperation.

--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
  • text
  • таблица
  • 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.

Примеры

Примечание

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

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

Чтобы описать экземпляр Verified Access

В следующем describe-verified-access-instances примере описывается указанный экземпляр Verified Access.

aws ec2 describe-verified-access-instances \
    --verified-access-instance-ids vai-0ce000c0b7643abea

Вывод:

{
    "VerifiedAccessInstances": [
        {
            "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea",
            "Description": "Testing Verified Access",
            "VerifiedAccessTrustProviders": [
                {
                    "VerifiedAccessTrustProviderId": "vatp-0bb32de759a3e19e7",
                    "TrustProviderType": "user",
                    "UserTrustProviderType": "iam-identity-center"
                }
            ],
            "CreationTime": "2023-08-25T18:27:56",
            "LastUpdatedTime": "2023-08-25T19:03:32",
            "Tags": [
                {
                    "Key": "Name",
                    "Value": "my-ava-instance"
                }
            ]
        }
    ]
}

Дополнительную информацию см. в разделе «Экземпляры Verified Access» в руководстве пользователя AWS Verified Access.

Вывод

VerifiedAccessInstances -> (список)

Подробности об экземплярах Verified Access.

(структура)

Описывает экземпляр Verified Access.

VerifiedAccessInstanceId -> (строка)

Идентификатор экземпляра Amazon Web Services Verified Access.

Description -> (строка)

Описание экземпляра Amazon Web Services Verified Access.

VerifiedAccessTrustProviders -> (список)

Идентификаторы поставщиков доверия Amazon Web Services Verified Access.

(структура)

Сжатая информация о поставщике доверия.

VerifiedAccessTrustProviderId -> (строка)

Идентификатор поставщика доверия.

Description -> (строка)

Описание поставщика доверия.

TrustProviderType -> (строка)

Тип поставщика доверия (пользовательский или основанный на устройстве).

UserTrustProviderType -> (строка)

Тип пользовательского поставщика доверия.

DeviceTrustProviderType -> (строка)

Тип поставщика доверия, основанного на устройстве.

CreationTime -> (строка)

Время создания.

LastUpdatedTime -> (строка)

Время последнего обновления.

Tags -> (список)

Теги.

(структура)

Описывает тег.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают не более 127 символов Юникода. Не должны начинаться с aws: .

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают не более 256 символов Юникода.

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

Указывает, включена ли поддержка стандартов обработки информации (FIPS) в экземпляре.

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

Пользовательский домен.

SubDomain -> (строка)

Поддомен.

Nameservers -> (список)

Серверы имен.

(строка)

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение null, когда больше результатов не возвращается.

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

Spec-Zone.ru

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