List Groups

workmail_list_groups

R Documentation

Returns summaries of the organization's groups

Description

Returns summaries of the organization's groups.

Usage

workmail_list_groups(OrganizationId, NextToken, MaxResults, Filters)

Arguments

OrganizationId	[required] The identifier for the organization under which the groups exist.
NextToken	The token to use to retrieve the next page of results. The first call does not contain any tokens.
MaxResults	The maximum number of results to return in a single call.
Filters	Limit the search results based on the filter criteria. Only one filter per request is supported.

Value

A list with the following syntax:

list(
  Groups = list(
    list(
      Id = "string",
      Email = "string",
      Name = "string",
      State = "ENABLED"|"DISABLED"|"DELETED",
      EnabledDate = as.POSIXct(
        "2015-01-01"
      ),
      DisabledDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_groups(
  OrganizationId = "string",
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    NamePrefix = "string",
    PrimaryEmailPrefix = "string",
    State = "ENABLED"|"DISABLED"|"DELETED"
  )
)