describe_settings

DirectoryService.Client.describe_settings(**kwargs)

Retrieves information about the configurable settings for the specified directory.

See also: AWS API Documentation

Request Syntax

response = client.describe_settings(
    DirectoryId='string',
    Status='Requested'|'Updating'|'Updated'|'Failed'|'Default',
    NextToken='string'
)

Parameters

• DirectoryId (string) --

  [REQUIRED]

  The identifier of the directory for which to retrieve information.

• Status (string) -- The status of the directory settings for which to retrieve information.
• NextToken (string) -- The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.

Return type

dict

Returns

Response Syntax

{
    'DirectoryId': 'string',
    'SettingEntries': [
        {
            'Type': 'string',
            'Name': 'string',
            'AllowedValues': 'string',
            'AppliedValue': 'string',
            'RequestedValue': 'string',
            'RequestStatus': 'Requested'|'Updating'|'Updated'|'Failed'|'Default',
            'RequestDetailedStatus': {
                'string': 'Requested'|'Updating'|'Updated'|'Failed'|'Default'
            },
            'RequestStatusMessage': 'string',
            'LastUpdatedDateTime': datetime(2015, 1, 1),
            'LastRequestedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • DirectoryId (string) --

    The identifier of the directory.

  • SettingEntries (list) --

    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.

    • (dict) --

      Contains information about the specified configurable setting for a directory.

      • Type (string) --

        The type of directory setting. For example, Protocol or Cipher .

      • Name (string) --

        The name of the directory setting. For example:

        TLS_1_0

      • AllowedValues (string) --

        The valid range of values for the directory setting.

      • AppliedValue (string) --

        The value of the directory setting that is applied to the directory.

      • RequestedValue (string) --

        The value that was last requested for the directory setting.

      • RequestStatus (string) --

        The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is Failed .

      • RequestDetailedStatus (dict) --

        Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.

        • (string) --
          • (string) --

      • RequestStatusMessage (string) --

        The last status message for the directory status request.

      • LastUpdatedDateTime (datetime) --

        The date and time when the directory setting was last updated.

      • LastRequestedDateTime (datetime) --

        The date and time when the request to update a directory setting was last submitted.

  • NextToken (string) --

    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.

Exceptions

• DirectoryService.Client.exceptions.DirectoryDoesNotExistException
• DirectoryService.Client.exceptions.UnsupportedOperationException
• DirectoryService.Client.exceptions.InvalidParameterException
• DirectoryService.Client.exceptions.InvalidNextTokenException
• DirectoryService.Client.exceptions.ClientException
• DirectoryService.Client.exceptions.ServiceException