describe-activities
Описание
Описывает действия пользователя в указанный период времени.
См. также: Документацию API AWS
describe-activities — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: UserActivities
Синтаксис
describe-activities
[--authentication-token <value>]
[--start-time <value>]
[--end-time <value>]
[--organization-id <value>]
[--activity-types <value>]
[--resource-id <value>]
[--user-id <value>]
[--include-indirect-activities | --no-include-indirect-activities]
[--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]
Параметры
--authentication-token (строка)
--start-time (метка времени)
--end-time (метка времени)
--organization-id (строка)
--activity-types (строка)
--resource-id (строка)
--user-id (строка)
--include-indirect-activities | --no-include-indirect-activities (логическое значение)
--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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, во всех примерах используются правила цитирования unix-подобных систем. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Получение списка действий пользователей
В этом примере возвращается список последних действий пользователей для указанной организации, с установленным лимитом на последние два действия.
Команда:
aws workdocs describe-activities --organization-id d-926726012c --limit 2
Вывод:
{
"UserActivities": [
{
"Type": "DOCUMENT_VERSION_DOWNLOADED",
"TimeStamp": 1534800122.17,
"Initiator": {
"Id": "arn:aws:iam::123456789123:user/exampleUser"
},
"ResourceMetadata": {
"Type": "document",
"Name": "updatedDoc",
"Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
"Owner": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
}
}
},
{
"Type": "DOCUMENT_VERSION_VIEWED",
"TimeStamp": 1534799079.207,
"Initiator": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
},
"ResourceMetadata": {
"Type": "document",
"Name": "updatedDoc",
"Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
"Owner": {
"Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
"GivenName": "exampleName",
"Surname": "exampleSurname"
}
}
}
],
"Marker": "DnF1ZXJ5VGhlbkZldGNoAgAAAAAAAAS7FmlTaU1OdlFTU1h1UU00VVFIbDlRWHcAAAAAAAAJTRY3bWh5eUgzaVF1ZXN2RUE5Wm8tTTdR"
}
Выходные данные
UserActivities -> (список)
Список действий для указанного пользователя и периода времени.
(структура)
Описывает информацию о действии.
Тип -> (строка)
Отметка времени -> (метка времени)
ЯвляетсяКосвеннымДействием -> (логическое значение)
IdОрганизации -> (строка)
Инициатор -> (структура)
Пользователь, выполнивший действие.
Id -> (строка)
Имя пользователя -> (строка)
Имя -> (строка)
Фамилия -> (строка)
Адрес электронной почты -> (строка)
Участники -> (структура)
Список пользователей или групп, затронутых этим действием. Это необязательное поле, которое заполняется для следующих действий по совместному использованию: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.
Пользователи -> (список)
Список пользователей.
(структура)
Описывает метаданные пользователя.
Id -> (строка)
Имя пользователя -> (строка)
Имя -> (строка)
Фамилия -> (строка)
Адрес электронной почты -> (строка)
Группы -> (список)
Список групп пользователей.
(структура)
Описывает метаданные группы пользователей.
Id -> (строка)
Название -> (строка)
МетаданныеРесурса -> (структура)
Метаданные ресурса, участвующего в действии пользователя.
Тип -> (строка)
Название -> (строка)
ОригинальноеНазвание -> (строка)
Id -> (строка)
IdВерсии -> (строка)
Владелец -> (структура)
Владелец ресурса.
Id -> (строка)
Имя пользователя -> (строка)
Имя -> (строка)
Фамилия -> (строка)
Адрес электронной почты -> (строка)
ParentId -> (строка)
ОригинальныйРодитель -> (структура)
Оригинальный родитель ресурса. Это необязательное поле и заполняется для действий перемещения.
Тип -> (строка)
Название -> (строка)
ОригинальноеНазвание -> (строка)
Id -> (строка)
IdВерсии -> (строка)
Владелец -> (структура)
Владелец ресурса.
Id -> (строка)
Имя пользователя -> (строка)
Имя -> (строка)
Фамилия -> (строка)
Адрес электронной почты -> (строка)
ParentId -> (строка)
МетаданныеКомментарии -> (структура)
Метаданные действия комментирования. Это необязательное поле и заполняется для действий комментирования.
IdКомментарии -> (строка)
Автор -> (структура)
Пользователь, который оставил комментарий.
Id -> (строка)
Имя пользователя -> (строка)
Адрес электронной почты -> (строка)
Имя -> (строка)
Фамилия -> (строка)
IdОрганизации -> (строка)
IdКорневойПапки -> (строка)
IdКорзиныУдаленных -> (строка)
Статус -> (строка)
Тип -> (строка)
ДатаСоздание -> (метка времени)
ДатаИзменение -> (метка времени)
IdЧасовогоПояса -> (строка)
Язык -> (строка)
Хранилище -> (структура)
Хранилище для пользователя.
ИспользованноеХранилищеВбайтах -> (целое число)
ПравилоХранилища -> (структура)
Хранилище для пользователя.
ВыделенноеХранилищеВбайтах -> (целое число)
ТипХранилища -> (строка)
ДатаСоздание -> (метка времени)
СтатусКомментарии -> (строка)
IdПолучателя -> (строка)
IdАвтора -> (строка)
Маркер -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.