describe-activities¶

Description¶

Describes the user activities in a specified time period.

Synopsis¶

  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]

Options¶

--authentication-token (string)

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

--start-time (timestamp)

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

--end-time (timestamp)

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

--organization-id (string)

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

--activity-types (string)

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

--resource-id (string)

The document or folder ID for which to describe activity types.

--user-id (string)

The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

--include-indirect-activities | --no-include-indirect-activities (boolean)

Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get a list of user activities

This example returns a list of the latest user activities for the specified organization, with a limit set for the latest two activities.

Command:

aws workdocs describe-activities --organization-id d-926726012c --limit 2

Output:

{
  "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"
}

Output¶

UserActivities -> (list)

The list of activities for the specified user and time period.

(structure)

Describes the activity information.

Type -> (string)

The activity type.

TimeStamp -> (timestamp)

The timestamp when the action was performed.

IsIndirectActivity -> (boolean)

Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

OrganizationId -> (string)

The ID of the organization.

Initiator -> (structure)

The user who performed the action.

Id -> (string)

The ID of the user.

Username -> (string)

The name of the user.

GivenName -> (string)

The given name of the user before a rename operation.

Surname -> (string)

The surname of the user.

EmailAddress -> (string)

The email address of the user.

Participants -> (structure)

The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

Users -> (list)

The list of users.

(structure)

Describes the metadata of the user.

Id -> (string)

The ID of the user.

Username -> (string)

The name of the user.

GivenName -> (string)

The given name of the user before a rename operation.

Surname -> (string)

The surname of the user.

EmailAddress -> (string)

The email address of the user.

Groups -> (list)

The list of user groups.

(structure)

Describes the metadata of a user group.

Id -> (string)

The ID of the user group.

Name -> (string)

The name of the group.

ResourceMetadata -> (structure)

The metadata of the resource involved in the user action.

Type -> (string)

The type of resource.

Name -> (string)

The name of the resource.

OriginalName -> (string)

The original name of the resource before a rename operation.

Id -> (string)

The ID of the resource.

VersionId -> (string)

The version ID of the resource. This is an optional field and is filled for action on document version.

Owner -> (structure)

The owner of the resource.

Id -> (string)

The ID of the user.

Username -> (string)

The name of the user.

GivenName -> (string)

The given name of the user before a rename operation.

Surname -> (string)

The surname of the user.

EmailAddress -> (string)

The email address of the user.

ParentId -> (string)

The parent ID of the resource before a rename operation.

OriginalParent -> (structure)

The original parent of the resource. This is an optional field and is filled for move activities.

Type -> (string)

The type of resource.

Name -> (string)

The name of the resource.

OriginalName -> (string)

The original name of the resource before a rename operation.

Id -> (string)

The ID of the resource.

VersionId -> (string)

The version ID of the resource. This is an optional field and is filled for action on document version.

Owner -> (structure)

The owner of the resource.

Id -> (string)

The ID of the user.

Username -> (string)

The name of the user.

GivenName -> (string)

The given name of the user before a rename operation.

Surname -> (string)

The surname of the user.

EmailAddress -> (string)

The email address of the user.

ParentId -> (string)

The parent ID of the resource before a rename operation.

CommentMetadata -> (structure)

Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

CommentId -> (string)

The ID of the comment.

Contributor -> (structure)

The user who made the comment.

Id -> (string)

The ID of the user.

Username -> (string)

The login name of the user.

EmailAddress -> (string)

The email address of the user.

GivenName -> (string)

The given name of the user.

Surname -> (string)

The surname of the user.

OrganizationId -> (string)

The ID of the organization.

RootFolderId -> (string)

The ID of the root folder.

RecycleBinFolderId -> (string)

The ID of the recycle bin folder.

Status -> (string)

The status of the user.

Type -> (string)

The type of user.

CreatedTimestamp -> (timestamp)

The time when the user was created.

ModifiedTimestamp -> (timestamp)

The time when the user was modified.

TimeZoneId -> (string)

The time zone ID of the user.

Locale -> (string)

The locale of the user.

Storage -> (structure)

The storage for the user.

StorageUtilizedInBytes -> (long)

The amount of storage used, in bytes.

StorageRule -> (structure)

The storage for a user.

StorageAllocatedInBytes -> (long)

The amount of storage allocated, in bytes.

StorageType -> (string)

The type of storage.

CreatedTimestamp -> (timestamp)

The timestamp that the comment was created.

CommentStatus -> (string)

The status of the comment.

RecipientId -> (string)

The ID of the user being replied to.

Marker -> (string)

The marker for the next set of results.

Table of Contents

Feedback

User Guide