Network.AWS.WorkDocs.DescribeActivities

Describes the user activities in a specified time period.

Creating a Request

describeActivities :: DescribeActivities

Creates a value of DescribeActivities with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• daStartTime - The timestamp that determines the starting time of the activities; the response includes the activities performed after the specified timestamp.
• daAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
• daUserId - 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.
• daMarker - The marker for the next set of results. (You received this marker from a previous call.)
• daEndTime - The timestamp that determines the end time of the activities; the response includes the activities performed before the specified timestamp.
• daLimit - The maximum number of items to return.
• daOrganizationId - The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

data DescribeActivities

See: describeActivities smart constructor.

Instances

Eq DescribeActivities

Methods

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

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

Data DescribeActivities

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeActivities -> c DescribeActivities

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeActivities

toConstr :: DescribeActivities -> Constr

dataTypeOf :: DescribeActivities -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeActivities)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeActivities)

gmapT :: (forall b. Data b => b -> b) -> DescribeActivities -> DescribeActivities

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivities -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivities -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeActivities -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeActivities -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeActivities -> m DescribeActivities

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivities -> m DescribeActivities

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivities -> m DescribeActivities

Show DescribeActivities

Methods

showsPrec :: Int -> DescribeActivities -> ShowS

show :: DescribeActivities -> String

showList :: [DescribeActivities] -> ShowS

Generic DescribeActivities

Associated Types

type Rep DescribeActivities :: * -> *

Methods

from :: DescribeActivities -> Rep DescribeActivities x

to :: Rep DescribeActivities x -> DescribeActivities

Hashable DescribeActivities

Methods

hashWithSalt :: Int -> DescribeActivities -> Int

hash :: DescribeActivities -> Int

NFData DescribeActivities

Methods

rnf :: DescribeActivities -> ()

AWSRequest DescribeActivities

Associated Types

type Rs DescribeActivities :: *

Methods

request :: DescribeActivities -> Request DescribeActivities

response :: MonadResource m => Logger -> Service -> Proxy * DescribeActivities -> ClientResponse -> m (Response DescribeActivities)

ToQuery DescribeActivities

Methods

toQuery :: DescribeActivities -> QueryString

ToPath DescribeActivities

Methods

toPath :: DescribeActivities -> ByteString

ToHeaders DescribeActivities

Methods

toHeaders :: DescribeActivities -> [Header]

type Rep DescribeActivities

type Rep DescribeActivities = D1 (MetaData "DescribeActivities" "Network.AWS.WorkDocs.DescribeActivities" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeActivities'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_daStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_daAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) (S1 (MetaSel (Just Symbol "_daUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_daMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_daEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_daLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_daOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs DescribeActivities

type Rs DescribeActivities = DescribeActivitiesResponse

Request Lenses

daStartTime :: Lens' DescribeActivities (Maybe UTCTime)

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

daAuthenticationToken :: Lens' DescribeActivities (Maybe Text)

Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.

daUserId :: Lens' DescribeActivities (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.

daMarker :: Lens' DescribeActivities (Maybe Text)

The marker for the next set of results. (You received this marker from a previous call.)

daEndTime :: Lens' DescribeActivities (Maybe UTCTime)

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

daLimit :: Lens' DescribeActivities (Maybe Natural)

The maximum number of items to return.

daOrganizationId :: Lens' DescribeActivities (Maybe Text)

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

Destructuring the Response

describeActivitiesResponse

Arguments

:: Int

darsResponseStatus

-> DescribeActivitiesResponse

Creates a value of DescribeActivitiesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• darsUserActivities - The list of activities for the specified user and time period.
• darsMarker - The marker for the next set of results.
• darsResponseStatus - -- | The response status code.

data DescribeActivitiesResponse

See: describeActivitiesResponse smart constructor.

Instances

Eq DescribeActivitiesResponse

Methods

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

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

Data DescribeActivitiesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeActivitiesResponse -> c DescribeActivitiesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeActivitiesResponse

toConstr :: DescribeActivitiesResponse -> Constr

dataTypeOf :: DescribeActivitiesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeActivitiesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeActivitiesResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeActivitiesResponse -> DescribeActivitiesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivitiesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeActivitiesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeActivitiesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeActivitiesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeActivitiesResponse -> m DescribeActivitiesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivitiesResponse -> m DescribeActivitiesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeActivitiesResponse -> m DescribeActivitiesResponse

Read DescribeActivitiesResponse

Methods

readsPrec :: Int -> ReadS DescribeActivitiesResponse

readList :: ReadS [DescribeActivitiesResponse]

readPrec :: ReadPrec DescribeActivitiesResponse

readListPrec :: ReadPrec [DescribeActivitiesResponse]

Show DescribeActivitiesResponse

Methods

showsPrec :: Int -> DescribeActivitiesResponse -> ShowS

show :: DescribeActivitiesResponse -> String

showList :: [DescribeActivitiesResponse] -> ShowS

Generic DescribeActivitiesResponse

Associated Types

type Rep DescribeActivitiesResponse :: * -> *

Methods

from :: DescribeActivitiesResponse -> Rep DescribeActivitiesResponse x

to :: Rep DescribeActivitiesResponse x -> DescribeActivitiesResponse

NFData DescribeActivitiesResponse

Methods

rnf :: DescribeActivitiesResponse -> ()

type Rep DescribeActivitiesResponse

type Rep DescribeActivitiesResponse = D1 (MetaData "DescribeActivitiesResponse" "Network.AWS.WorkDocs.DescribeActivities" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "DescribeActivitiesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_darsUserActivities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Activity]))) ((:*:) (S1 (MetaSel (Just Symbol "_darsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_darsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

darsUserActivities :: Lens' DescribeActivitiesResponse [Activity]

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

darsMarker :: Lens' DescribeActivitiesResponse (Maybe Text)

The marker for the next set of results.

darsResponseStatus :: Lens' DescribeActivitiesResponse Int

• - | The response status code.