describe-sessions
Описание
Возвращает список всех активных сеансов (как подключенных, так и отключенных), а также завершенных сеансов за последние 30 дней.
См. также: Документацию API AWS
describe-sessions — это страничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить страничное отображение, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе со страничным отображением, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Sessions
Синтаксис
describe-sessions
--state <value>
[--filters <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]
Параметры
--state (строка)
Статус сеанса для получения списка сеансов. Например, «Active».
Возможные значения:
ActiveHistory
--filters (список)
Один или несколько фильтров для ограничения типа возвращаемых сеансов.
(структура)
Описание фильтра для информации о Session Manager.
key -> (строка)
value -> (строка)
Значение фильтра. Допустимые значения для каждого ключа фильтра:
- InvokedAfter: Укажите отметку времени для ограничения результатов. Например, укажите 2024-08-29T00:00:00Z, чтобы увидеть сеансы, начатые 29 августа 2024 года и позже.
- InvokedBefore: Укажите отметку времени для ограничения результатов. Например, укажите 2024-08-29T00:00:00Z, чтобы увидеть сеансы, начатые до 29 августа 2024 года.
- Target: Укажите управляемый узел, к которому были подключены сеансы.
- Owner: Укажите пользователя Amazon Web Services, чтобы увидеть список сеансов, начатых этим пользователем.
- Status: Укажите допустимый статус сеанса, чтобы увидеть список всех сеансов с этим статусом. Допустимые статусы включают:
- Подключено
- Подключение
- Отключено
- Завершено
- Завершение
- Не удалось
- SessionId: Укажите идентификатор сеанса, чтобы получить подробности о сеансе.
Сокращенный синтаксис:
key=string,value=string ...
Синтаксис JSON:
[
{
"key": "InvokedAfter"|"InvokedBefore"|"Target"|"Owner"|"Status"|"SessionId",
"value": "string"
}
...
]
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом и без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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 (булево)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запрошение параметров ввода командной строки.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы с AWS CLI.
Если не указано иное, все примеры имеют правила цитирования, подобные unix-like. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Пример 1: Для отображения всех активных сеансов Session Manager
Этот describe-sessions пример получает список активных сеансов, созданных в последнее время (как подключенных, так и отключенных), за последние 30 дней, которые были начаты указанным пользователем. Эта команда возвращает только результаты подключений к узлам, начатым с помощью Session Manager. Она не перечисляет подключения, созданные другими методами, такими как удалённые подключения к рабочему столу или SSH.
aws ssm describe-sessions \
--state "Active" \
--filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez"
Вывод:
{
"Sessions": [
{
"SessionId": "John-07a16060613c408b5",
"Target": "i-1234567890abcdef0",
"Status": "Connected",
"StartDate": 1550676938.352,
"Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez",
"OutputUrl": {}
},
{
"SessionId": "John-01edf534b8b56e8eb",
"Target": "i-9876543210abcdef0",
"Status": "Connected",
"StartDate": 1550676842.194,
"Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Shirley-Rodriguez",
"OutputUrl": {}
}
]
}
Пример 2: Для отображения всех завершенных сеансов Session Manager
Этот describe-sessions пример получает список недавно завершенных сеансов за последние 30 дней для всех пользователей.
aws ssm describe-sessions \
--state "History"
Вывод:
{
"Sessions": [
{
"SessionId": "Mary-Major-0022b1eb2b0d9e3bd",
"Target": "i-1234567890abcdef0",
"Status": "Terminated",
"StartDate": 1550520701.256,
"EndDate": 1550521931.563,
"Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Mary-Major"
},
{
"SessionId": "Jane-Roe-0db53f487931ed9d4",
"Target": "i-9876543210abcdef0",
"Status": "Terminated",
"StartDate": 1550161369.149,
"EndDate": 1550162580.329,
"Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Jane-Roe"
},
...
],
"NextToken": "--token string truncated--"
}
Дополнительную информацию см. в разделе «Просмотр истории сеансов» в руководстве пользователя AWS Systems Manager.
Вывод
Sessions -> (список)
Список сеансов, соответствующих параметрам запроса.
(структура)
Информация о подключении Session Manager к управляемому узлу.
SessionId -> (строка)
Target -> (строка)
Status -> (строка)
StartDate -> (отметка времени)
EndDate -> (отметка времени)
DocumentName -> (строка)
SSM-SessionManagerRunShell.Owner -> (строка)
Reason -> (строка)
Details -> (строка)
OutputUrl -> (структура)
Зарезервировано для будущего использования.
S3OutputUrl -> (строка)
CloudWatchOutputUrl -> (строка)
MaxSessionDuration -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|