получить-сессию
Описание
Получает информацию для указанной сессии.
См. также: документацию API AWS
Синтаксис
get-session
--assistant-id <value>
--session-id <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]
Параметры
--assistant-id (строка)
--session-id (строка)
--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 (строка)
Переопределить адрес по умолчанию команды указанным адресом.
--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.
Вывод
session -> (структура)
Сессия.
sessionArn -> (строка)
sessionId -> (строка)
name -> (строка)
description -> (строка)
tags -> (карта)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
key -> (строка)
value -> (строка)
integrationConfiguration -> (структура)
Конфигурационная информация для интеграции сессии.
topicIntegrationArn -> (строка)
tagFilter -> (структура помеченных объединений)
Объект, который может быть использован для указания условий тегов.
Примечание
Это структура помеченных объединений. Только один из следующих верхних ключей может быть установлен:tagCondition, andConditions, orConditions.tagCondition -> (структура)
Условие узла листа, которое может быть использовано для указания условия тега.
key -> (строка)
value -> (строка)
andConditions -> (список)
Список условий, которые применяются совместно с условием AND.
(структура)
Условие узла листа, которое может быть использовано для указания условия тега.
key -> (строка)
value -> (строка)
orConditions -> (список)
Список условий, которые применяются совместно с условием OR.
(структура помеченных объединений)
Список условий, которые применяются совместно с условием OR.
Примечание
Это структура помеченных объединений. Только один из следующих верхних ключей может быть установлен:andConditions, tagCondition.andConditions -> (список)
Список условий, которые применяются совместно с условием AND.
(структура)
Условие узла листа, которое может быть использовано для указания условия тега.
key -> (строка)
value -> (строка)
tagCondition -> (структура)
Условие узла листа, которое может быть использовано для указания условия тега.
key -> (строка)
value -> (строка)
aiAgentConfiguration -> (карта)
Конфигурация агентов ИИ (отображенных по типу агента ИИ к версии агента ИИ), которые должны использоваться Amazon Q в Connect для этой сессии.
key -> (строка)
value -> (структура)
Тип, определяющий конфигурационные данные идентификатора агента ИИ при сопоставлении агентов ИИ, которые должны использоваться для типа агента ИИ в сессии или помощнике.
aiAgentId -> (строка)
origin -> (строка)
SYSTEM для сессии по умолчанию, созданной Amazon Q в Connect, или CUSTOMER для сессии, созданной с помощью API CreateSession.
© Copyright 2025, Amazon Web Services. Created using Sphinx.