/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WorkDocs::DescribeActivities

NAME

Paws::WorkDocs::DescribeActivities - Arguments for method DescribeActivities on Paws::WorkDocs

DESCRIPTION

This class represents the parameters used for calling the method DescribeActivities on the Amazon WorkDocs service. Use the attributes of this class as arguments to method DescribeActivities.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeActivities.

SYNOPSIS

my $workdocs = Paws->service('WorkDocs');
my $DescribeActivitiesResponse = $workdocs->DescribeActivities(
  ActivityTypes             => 'MyActivityNamesFilterType',     # OPTIONAL
  AuthenticationToken       => 'MyAuthenticationHeaderType',    # OPTIONAL
  EndTime                   => '1970-01-01T01:00:00',           # OPTIONAL
  IncludeIndirectActivities => 1,                               # OPTIONAL
  Limit                     => 1,                               # OPTIONAL
  Marker                    => 'MyMarkerType',                  # OPTIONAL
  OrganizationId            => 'MyIdType',                      # OPTIONAL
  ResourceId                => 'MyIdType',                      # OPTIONAL
  StartTime                 => '1970-01-01T01:00:00',           # OPTIONAL
  UserId                    => 'MyIdType',                      # OPTIONAL
);

# Results:
my $Marker         = $DescribeActivitiesResponse->Marker;
my $UserActivities = $DescribeActivitiesResponse->UserActivities;

# Returns a L<Paws::WorkDocs::DescribeActivitiesResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeActivities

ATTRIBUTES

ActivityTypes => Str

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

AuthenticationToken => Str

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

EndTime => Str

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

IncludeIndirectActivities => Bool

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

Limit => Int

The maximum number of items to return.

Marker => Str

The marker for the next set of results.

OrganizationId => Str

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

ResourceId => Str

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

StartTime => Str

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

UserId => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeActivities in Paws::WorkDocs

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues