Skip to content

List Resources

workmail_list_resources R Documentation

Returns summaries of the organization's resources

Description

Returns summaries of the organization's resources.

Usage

workmail_list_resources(OrganizationId, NextToken, MaxResults, Filters)

Arguments

OrganizationId

[required] The identifier for the organization under which the resources 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 resource search results based on the filter criteria. You can only use one filter per request.

Value

A list with the following syntax: 

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

Request syntax

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