Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the user activities in a specified time period.
This operation returns paginated results.
Synopsis
- data DescribeActivities = DescribeActivities' {}
- newDescribeActivities :: DescribeActivities
- describeActivities_activityTypes :: Lens' DescribeActivities (Maybe Text)
- describeActivities_authenticationToken :: Lens' DescribeActivities (Maybe Text)
- describeActivities_endTime :: Lens' DescribeActivities (Maybe UTCTime)
- describeActivities_includeIndirectActivities :: Lens' DescribeActivities (Maybe Bool)
- describeActivities_limit :: Lens' DescribeActivities (Maybe Natural)
- describeActivities_marker :: Lens' DescribeActivities (Maybe Text)
- describeActivities_organizationId :: Lens' DescribeActivities (Maybe Text)
- describeActivities_resourceId :: Lens' DescribeActivities (Maybe Text)
- describeActivities_startTime :: Lens' DescribeActivities (Maybe UTCTime)
- describeActivities_userId :: Lens' DescribeActivities (Maybe Text)
- data DescribeActivitiesResponse = DescribeActivitiesResponse' {
- marker :: Maybe Text
- userActivities :: Maybe [Activity]
- httpStatus :: Int
- newDescribeActivitiesResponse :: Int -> DescribeActivitiesResponse
- describeActivitiesResponse_marker :: Lens' DescribeActivitiesResponse (Maybe Text)
- describeActivitiesResponse_userActivities :: Lens' DescribeActivitiesResponse (Maybe [Activity])
- describeActivitiesResponse_httpStatus :: Lens' DescribeActivitiesResponse Int
Creating a Request
data DescribeActivities Source #
See: newDescribeActivities
smart constructor.
DescribeActivities' | |
|
Instances
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.
DescribeActivitiesResponse' | |
|
Instances
newDescribeActivitiesResponse Source #
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.