Struct aws_sdk_workdocs::client::fluent_builders::DescribeActivities

source · [−]

pub struct DescribeActivities { /* private fields */ }

Expand description

Fluent builder constructing a request to DescribeActivities.

Describes the user activities in a specified time period.

Implementations

source

impl DescribeActivities

source

pub async fn customize(
self
) -> Result<CustomizableOperation<DescribeActivities, AwsResponseRetryClassifier>, SdkError<DescribeActivitiesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<DescribeActivitiesOutput, SdkError<DescribeActivitiesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn authentication_token(self, input: impl Into<String>) -> Self

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

source

pub fn set_authentication_token(self, input: Option<String>) -> Self

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

source

pub fn start_time(self, input: DateTime) -> Self

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

source

pub fn set_start_time(self, input: Option<DateTime>) -> Self

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

source

pub fn end_time(self, input: DateTime) -> Self

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

source

pub fn set_end_time(self, input: Option<DateTime>) -> Self

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

source

pub fn organization_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_organization_id(self, input: Option<String>) -> Self

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

source

pub fn activity_types(self, input: impl Into<String>) -> Self

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

source

pub fn set_activity_types(self, input: Option<String>) -> Self

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

source

pub fn resource_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_resource_id(self, input: Option<String>) -> Self

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

source

pub fn user_id(self, input: impl Into<String>) -> Self

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.

source

pub fn set_user_id(self, input: Option<String>) -> Self

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.

source

pub fn include_indirect_activities(self, input: bool) -> Self

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

source

pub fn set_include_indirect_activities(self, input: Option<bool>) -> Self

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

source