amazonka-workdocs-2.0: Amazon WorkDocs SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkDocs.DescribeActivities

Description

Describes the user activities in a specified time period.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeActivities Source #

See: newDescribeActivities smart constructor.

Constructors

DescribeActivities' 

Fields

  • activityTypes :: Maybe Text

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

  • authenticationToken :: Maybe (Sensitive Text)

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

  • endTime :: Maybe POSIX

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

  • includeIndirectActivities :: Maybe 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 :: Maybe Natural

    The maximum number of items to return.

  • marker :: Maybe Text

    The marker for the next set of results.

  • organizationId :: Maybe Text

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

  • resourceId :: Maybe Text

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

  • startTime :: Maybe POSIX

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

  • userId :: Maybe Text

    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.

Instances

Instances details
ToHeaders DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

toHeaders :: DescribeActivities -> [Header] #

ToPath DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

toPath :: DescribeActivities -> ByteString #

ToQuery DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

toQuery :: DescribeActivities -> QueryString #

AWSPager DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

page :: DescribeActivities -> AWSResponse DescribeActivities -> Maybe DescribeActivities #

AWSRequest DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Associated Types

type AWSResponse DescribeActivities #

Methods

request :: (Service -> Service) -> DescribeActivities -> Request DescribeActivities #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeActivities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeActivities))) #

Generic DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Associated Types

type Rep DescribeActivities :: Type -> Type #

Methods

from :: DescribeActivities -> Rep DescribeActivities x #

to :: Rep DescribeActivities x -> DescribeActivities #

Show DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

showsPrec :: Int -> DescribeActivities -> ShowS #

show :: DescribeActivities -> String #

showList :: [DescribeActivities] -> ShowS #

NFData DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

rnf :: DescribeActivities -> () #

Eq DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

(==) :: DescribeActivities -> DescribeActivities -> Bool #

(/=) :: DescribeActivities -> DescribeActivities -> Bool #

Hashable DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

hashWithSalt :: Int -> DescribeActivities -> Int #

hash :: DescribeActivities -> Int #

type AWSResponse DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

type AWSResponse DescribeActivities = DescribeActivitiesResponse
type Rep DescribeActivities Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

type Rep DescribeActivities = D1 ('MetaData "DescribeActivities" "Amazonka.WorkDocs.DescribeActivities" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeActivities'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "activityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "includeIndirectActivities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :*: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newDescribeActivities :: DescribeActivities Source #

Create a value of DescribeActivities with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activityTypes:DescribeActivities', describeActivities_activityTypes - Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

$sel:authenticationToken:DescribeActivities', describeActivities_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:endTime:DescribeActivities', describeActivities_endTime - The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

$sel:includeIndirectActivities:DescribeActivities', describeActivities_includeIndirectActivities - 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).

$sel:limit:DescribeActivities', describeActivities_limit - The maximum number of items to return.

DescribeActivities, describeActivities_marker - The marker for the next set of results.

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

$sel:resourceId:DescribeActivities', describeActivities_resourceId - The document or folder ID for which to describe activity types.

$sel:startTime:DescribeActivities', describeActivities_startTime - The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

$sel:userId:DescribeActivities', describeActivities_userId - 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.

Request Lenses

describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text) Source #

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

describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text) Source #

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

describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime) Source #

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

describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool) Source #

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

describeActivities_limit :: Lens' DescribeActivities (Maybe Natural) Source #

The maximum number of items to return.

describeActivities_marker :: Lens' DescribeActivities (Maybe Text) Source #

The marker for the next set of results.

describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text) Source #

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

describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text) Source #

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

describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime) Source #

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

describeActivities_userId :: Lens' DescribeActivities (Maybe Text) Source #

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.

Destructuring the Response

data DescribeActivitiesResponse Source #

See: newDescribeActivitiesResponse smart constructor.

Constructors

DescribeActivitiesResponse' 

Fields

Instances

Instances details
Generic DescribeActivitiesResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Associated Types

type Rep DescribeActivitiesResponse :: Type -> Type #

Methods

from :: DescribeActivitiesResponse -> Rep DescribeActivitiesResponse x #

to :: Rep DescribeActivitiesResponse x -> DescribeActivitiesResponse #

Show DescribeActivitiesResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

showsPrec :: Int -> DescribeActivitiesResponse -> ShowS #

show :: DescribeActivitiesResponse -> String #

showList :: [DescribeActivitiesResponse] -> ShowS #

NFData DescribeActivitiesResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

rnf :: DescribeActivitiesResponse -> () #

Eq DescribeActivitiesResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

Methods

(==) :: DescribeActivitiesResponse -> DescribeActivitiesResponse -> Bool #

(/=) :: DescribeActivitiesResponse -> DescribeActivitiesResponse -> Bool #

type Rep DescribeActivitiesResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.DescribeActivities

type Rep DescribeActivitiesResponse = D1 ('MetaData "DescribeActivitiesResponse" "Amazonka.WorkDocs.DescribeActivities" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeActivitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "userActivities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Activity])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeActivitiesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeActivitiesResponse'

-> DescribeActivitiesResponse 

Create a value of DescribeActivitiesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeActivities, describeActivitiesResponse_marker - The marker for the next set of results.

$sel:userActivities:DescribeActivitiesResponse', describeActivitiesResponse_userActivities - The list of activities for the specified user and time period.

$sel:httpStatus:DescribeActivitiesResponse', describeActivitiesResponse_httpStatus - The response's http status code.

Response Lenses

describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text) Source #

The marker for the next set of results.

describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity]) Source #

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

describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int Source #

The response's http status code.