DescribeUsersRequest

public struct DescribeUsersRequest : AWSShape
extension WorkDocs.DescribeUsersRequest: AWSPaginateStringToken

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let authenticationToken: String?

  • A comma-separated list of values. Specify “STORAGE_METADATA” to include the user storage quota and utilization information.

    Declaration

    Swift

    public let fields: String?

  • The state of the users. Specify “ALL” to include inactive users.

    Declaration

    Swift

    public let include: UserFilterType?

  • The maximum number of items to return.

    Declaration

    Swift

    public let limit: Int?

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

    Declaration

    Swift

    public let marker: String?

  • The order for the results.

    Declaration

    Swift

    public let order: OrderType?

  • The ID of the organization.

    Declaration

    Swift

    public let organizationId: String?

  • A query to filter users by user name.

    Declaration

    Swift

    public let query: String?

  • The sorting criteria.

    Declaration

    Swift

    public let sort: UserSortType?

  • The IDs of the users.

    Declaration

    Swift

    public let userIds: String?

  • Undocumented

    Declaration

    Swift

    public init(authenticationToken: String? = nil, fields: String? = nil, include: UserFilterType? = nil, limit: Int? = nil, marker: String? = nil, order: OrderType? = nil, organizationId: String? = nil, query: String? = nil, sort: UserSortType? = nil, userIds: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws

Paginators