Spec-Zone.ru › AWS CLI v2

[ aws . workdocs ]

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 (строка)

Токен аутентификации Amazon WorkDocs. Не требуется при использовании учетных данных администратора Amazon Web Services для доступа к API.

--start-time (метка времени)

Метка времени, определяющая начальное время активности. Ответ включает действия, выполненные после указанной метки времени.

--end-time (метка времени)

Метка времени, определяющая конечное время активности. Ответ включает действия, выполненные до указанной метки времени.

--organization-id (строка)

Идентификатор организации. Это обязательный параметр при использовании запросов административного API (SigV4).

--activity-types (строка)

Указывает, какие типы активности включать в ответ. Если этот параметр не указан, возвращаются все типы активности.

--resource-id (строка)

Идентификатор документа или папки, для которых требуется описать типы активности.

--user-id (строка)

Идентификатор пользователя, который выполнил действие. Ответ включает действия, относящиеся к этому пользователю. Это необязательный параметр и применяется только к запросам административного API (SigV4).

--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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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