Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeSettings

Retrieves information about the configurable settings for the specified directory.

Request Syntax


{
   "DirectoryId": "string",
   "NextToken": "string",
   "Status": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The identifier of the directory for which to retrieve information.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

NextToken

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

Type: String

Required: No

Status

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

Type: String

Valid Values: Requested | Updating | Updated | Failed | Default

Required: No

Response Syntax


{
   "DirectoryId": "string",
   "NextToken": "string",
   "SettingEntries": [ 
      { 
         "AllowedValues": "string",
         "AppliedValue": "string",
         "DataType": "string",
         "LastRequestedDateTime": number,
         "LastUpdatedDateTime": number,
         "Name": "string",
         "RequestDetailedStatus": { 
            "string" : "string" 
         },
         "RequestedValue": "string",
         "RequestStatus": "string",
         "RequestStatusMessage": "string",
         "Type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DirectoryId

The identifier of the directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

NextToken

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

Type: String

SettingEntries

The list of SettingEntry objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

Type: Array of SettingEntry objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400