2022/06/20 - AWS Directory Service - 2 new 3 updated api methods
Changes This release adds support for describing and updating AWS Managed Microsoft AD settings
Retrieves information about the configurable settings for the specified directory.
See also: AWS API Documentation
Request Syntax
client.describe_settings(
DirectoryId='string',
Status='Requested'|'Updating'|'Updated'|'Failed'|'Default',
NextToken='string'
)
string
[REQUIRED]
The identifier of the directory for which to retrieve information.
string
The status of the directory settings for which to retrieve information.
string
The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.
dict
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.
Updates the configurable settings for the specified directory.
See also: AWS API Documentation
Request Syntax
client.update_settings(
DirectoryId='string',
Settings=[
{
'Name': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identifier of the directory for which to update settings.
list
[REQUIRED]
The list of Setting objects.
(dict) --
Contains information about the configurable settings for a directory.
Name (string) -- [REQUIRED]
The name of the directory setting. For example:
TLS_1_0
Value (string) -- [REQUIRED]
The value of the directory setting for which to retrieve information. For example, for TLS_1_0 , the valid values are: Enable and Disable .
dict
Response Syntax
{
'DirectoryId': 'string'
}
Response Structure
(dict) --
DirectoryId (string) --
The identifier of the directory.
{'Type': {'SmartCardOrPassword'}}
Response {'ClientAuthenticationSettingsInfo': {'Type': {'SmartCardOrPassword'}}}
Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.
See also: AWS API Documentation
Request Syntax
client.describe_client_authentication_settings(
DirectoryId='string',
Type='SmartCard'|'SmartCardOrPassword',
NextToken='string',
Limit=123
)
string
[REQUIRED]
The identifier of the directory for which to retrieve information.
string
The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.
string
The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
integer
The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
dict
Response Syntax
{
'ClientAuthenticationSettingsInfo': [
{
'Type': 'SmartCard'|'SmartCardOrPassword',
'Status': 'Enabled'|'Disabled',
'LastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ClientAuthenticationSettingsInfo (list) --
Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.
(dict) --
Contains information about a client authentication method for a directory.
Type (string) --
The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved.
Status (string) --
Whether the client authentication type is enabled or disabled for the specified directory.
LastUpdatedDateTime (datetime) --
The date and time when the status of the client authentication type was last updated.
NextToken (string) --
The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.
{'Type': {'SmartCardOrPassword'}}
Disables alternative client authentication methods for the specified directory.
See also: AWS API Documentation
Request Syntax
client.disable_client_authentication(
DirectoryId='string',
Type='SmartCard'|'SmartCardOrPassword'
)
string
[REQUIRED]
The identifier of the directory
string
[REQUIRED]
The type of client authentication to disable. Currently, only the parameter, SmartCard is supported.
dict
Response Syntax
{}
Response Structure
(dict) --
{'Type': {'SmartCardOrPassword'}}
Enables alternative client authentication methods for the specified directory.
See also: AWS API Documentation
Request Syntax
client.enable_client_authentication(
DirectoryId='string',
Type='SmartCard'|'SmartCardOrPassword'
)
string
[REQUIRED]
The identifier of the specified directory.
string
[REQUIRED]
The type of client authentication to enable. Currently only the value SmartCard is supported. Smart card authentication in AD Connector requires that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in your self-managed AD.
dict
Response Syntax
{}
Response Structure
(dict) --