Describe Settings

directoryservice_describe_settings

R Documentation

Retrieves information about the configurable settings for the specified directory

Description

Retrieves information about the configurable settings for the specified directory.

Usage

directoryservice_describe_settings(DirectoryId, Status, NextToken)

Arguments

DirectoryId

[required] The identifier of the directory for which to retrieve information.

Status

The status of the directory settings for which to retrieve information.

NextToken

The DescribeSettingsResult.NextToken value from a previous call to describe_settings. Pass null if this is the first call.

Value

A list with the following syntax:

list(
  DirectoryId = "string",
  SettingEntries = list(
    list(
      Type = "string",
      Name = "string",
      AllowedValues = "string",
      AppliedValue = "string",
      RequestedValue = "string",
      RequestStatus = "Requested"|"Updating"|"Updated"|"Failed"|"Default",
      RequestDetailedStatus = list(
        "Requested"|"Updating"|"Updated"|"Failed"|"Default"
      ),
      RequestStatusMessage = "string",
      LastUpdatedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      LastRequestedDateTime = as.POSIXct(
        "2015-01-01"
      ),
      DataType = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_settings(
  DirectoryId = "string",
  Status = "Requested"|"Updating"|"Updated"|"Failed"|"Default",
  NextToken = "string"
)