Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes the user activities in a specified time period.
Synopsis
- describeActivities :: DescribeActivities
- data DescribeActivities
- daStartTime :: Lens' DescribeActivities (Maybe UTCTime)
- daAuthenticationToken :: Lens' DescribeActivities (Maybe Text)
- daUserId :: Lens' DescribeActivities (Maybe Text)
- daMarker :: Lens' DescribeActivities (Maybe Text)
- daEndTime :: Lens' DescribeActivities (Maybe UTCTime)
- daLimit :: Lens' DescribeActivities (Maybe Natural)
- daOrganizationId :: Lens' DescribeActivities (Maybe Text)
- describeActivitiesResponse :: Int -> DescribeActivitiesResponse
- data DescribeActivitiesResponse
- darsUserActivities :: Lens' DescribeActivitiesResponse [Activity]
- darsMarker :: Lens' DescribeActivitiesResponse (Maybe Text)
- darsResponseStatus :: Lens' DescribeActivitiesResponse Int
Creating a Request
describeActivities :: DescribeActivities Source #
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. Do not set this field 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.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 Source #
See: describeActivities
smart constructor.
Instances
Request Lenses
daStartTime :: 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.
daAuthenticationToken :: Lens' DescribeActivities (Maybe Text) Source #
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
daUserId :: 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.
daEndTime :: 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.
daOrganizationId :: Lens' DescribeActivities (Maybe Text) Source #
The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.
Destructuring the Response
describeActivitiesResponse Source #
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 Source #
See: describeActivitiesResponse
smart constructor.
Instances
Response Lenses
darsUserActivities :: Lens' DescribeActivitiesResponse [Activity] Source #
The list of activities for the specified user and time period.
darsMarker :: Lens' DescribeActivitiesResponse (Maybe Text) Source #
The marker for the next set of results.
darsResponseStatus :: Lens' DescribeActivitiesResponse Int Source #
- - | The response status code.