Smaws_Client_DirectoryServiceDirectory Service client library built on EIO.
val service : Smaws_Lib.Service.descriptorInitiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.
The operation is not supported.
An exception has occurred in Directory Service.
One or more parameters are not valid.
The specified entity could not be found.
A client exception has occurred.
The user provided a username that does not exist in your directory.
type nonrec os_update_settings = {os_version : os_version option;OS version that the directory needs to be updated to.
*)}OS version that the directory needs to be updated to.
type nonrec update_value = {os_update_settings : os_update_settings option;The OS update related settings.
*)}The value for a given type of UpdateSettings.
type nonrec update_trust_request = {selective_auth : selective_auth option;Updates selective authentication for the trust.
*)trust_id : string;Identifier of the trust relationship.
*)}type nonrec setting = {value : string;The value of the directory setting for which to retrieve information. For example, for TLS_1_0, the valid values are: Enable and Disable.
name : string;The name of the directory setting. For example:
TLS_1_0
}Contains information about the configurable settings for a directory.
type nonrec update_settings_request = {settings : setting list;The list of Setting objects.
directory_id : string;The identifier of the directory for which to update settings.
*)}The specified directory setting is not supported.
The specified directory setting is not compatible with other settings.
The specified directory is unavailable or could not be found.
The specified directory does not exist in the system.
type nonrec radius_settings = {use_same_username : bool option;Not currently used.
*)display_label : string option;Not currently used.
*)authentication_protocol : radius_authentication_protocol option;The protocol specified for your RADIUS endpoints.
*)radius_retries : int option;The maximum number of times that communication with the RADIUS server is attempted.
*)radius_timeout : int option;The amount of time, in seconds, to wait for the RADIUS server to respond.
*)radius_port : int option;The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.
*)radius_servers : string list option;An array of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.
*)}Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
type nonrec update_radius_request = {radius_settings : radius_settings;A RadiusSettings object that contains information about the RADIUS server.
directory_id : string;The identifier of the directory for which to update the RADIUS server information.
*)}Contains the inputs for the UpdateRadius operation.
The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.
type nonrec update_info_entry = {last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The last updated date and time of a particular directory setting.
*)start_time : Smaws_Lib.CoreTypes.Timestamp.t option;The start time of the UpdateDirectorySetup for the particular type.
previous_value : update_value option;The old value of the target setting.
*)new_value : update_value option;The new value of the target setting.
*)initiated_by : string option;This specifies if the update was initiated by the customer or by the service team.
*)status_reason : string option;The reason for the current status of the update type activity.
*)status : update_status option;The status of the update performed on the directory.
*)region : string option;The name of the Region.
*)}An entry of update information related to a requested update type.
type nonrec update_directory_setup_request = {create_snapshot_before_update : bool option;The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.
*)os_update_settings : os_update_settings option;The settings for the OS update that needs to be performed on the directory.
*)update_type : update_type;The type of update that needs to be performed on the directory. For example, OS.
*)directory_id : string;The identifier of the directory on which you want to perform the update.
*)}The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.
The directory is already updated to desired update type settings.
Client authentication is not available in this region at this time.
type nonrec update_conditional_forwarder_request = {dns_ip_addrs : string list;The updated IP addresses of the remote DNS server associated with the conditional forwarder.
*)remote_domain_name : string;The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*)directory_id : string;The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.
*)}Updates a conditional forwarder.
Identifier that contains details about the directory consumer account with whom the directory is being unshared.
The specified shared target is not valid.
The specified directory has not been shared with this Amazon Web Services account.
type nonrec trust = {selective_auth : selective_auth option;Current state of selective authentication for the trust.
*)trust_state_reason : string option;The reason for the TrustState.
*)state_last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the TrustState was last updated.
*)last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the trust relationship was last updated.
*)created_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the trust relationship was created.
*)trust_state : trust_state option;The trust relationship state.
*)trust_direction : trust_direction option;The trust relationship direction.
*)trust_type : trust_type option;The trust relationship type. Forest is the default.
remote_domain_name : string option;The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
*)trust_id : string option;The unique ID of the trust relationship.
*)directory_id : string option;The Directory ID of the Amazon Web Services directory involved in the trust relationship.
*)}Describes a trust relationship between an Managed Microsoft AD directory and an external domain.
type nonrec tag = {value : string;The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*)key : string;Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
*)}Metadata assigned to a directory consisting of a key-value pair.
The maximum allowed number of tags was exceeded.
type nonrec start_schema_extension_request = {description : string;A description of the schema extension.
*)ldif_content : string;The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.
*)create_snapshot_before_schema_extension : bool;If true, creates a snapshot of the directory before applying the schema extension.
*)directory_id : string;The identifier of the directory for which the schema extension will be applied to.
*)}type nonrec snapshot = {start_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the snapshot was taken.
*)status : snapshot_status option;The snapshot status.
*)name : string option;The descriptive name of the snapshot.
*)type_ : snapshot_type option;The snapshot type.
*)snapshot_id : string option;The snapshot identifier.
*)directory_id : string option;The directory identifier.
*)}Describes a directory snapshot.
type nonrec snapshot_limits = {manual_snapshots_limit_reached : bool option;Indicates if the manual snapshot limit has been reached.
*)manual_snapshots_current_count : int option;The current number of manual snapshots of the directory.
*)manual_snapshots_limit : int option;The maximum number of manual snapshots allowed.
*)}Contains manual snapshot limit information for a directory.
Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.
Identifier that contains details about the directory consumer account.
The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.
Exception encountered while trying to access your Amazon Web Services organization.
The specified directory has already been shared with this Amazon Web Services account.
type nonrec directory_configuration_setting_request_detailed_status =
(string * directory_configuration_status) listtype nonrec setting_entry = {data_type : string option;The data type of a directory setting. This is used to define the AllowedValues of a setting. For example a data type can be Boolean, DurationInSeconds, or Enum.
last_requested_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the request to update a directory setting was last submitted.
*)last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the directory setting was last updated.
*)request_status_message : string option;The last status message for the directory status request.
*)request_detailed_status : directory_configuration_setting_request_detailed_status
option;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.
*)request_status : directory_configuration_status option;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.
requested_value : string option;The value that was last requested for the directory setting.
*)applied_value : string option;The value of the directory setting that is applied to the directory.
*)allowed_values : string option;The valid range of values for the directory setting. These values depend on the DataType of your directory.
name : string option;The name of the directory setting. For example:
TLS_1_0
type_ : string option;The type, or category, of a directory setting. Similar settings have the same type. For example, Protocol, Cipher, or Certificate-Based Authentication.
}Contains information about the specified configurable setting for a directory.
type nonrec schema_extension_info = {end_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the schema extension was completed.
*)start_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the schema extension started being applied to the directory.
*)schema_extension_status_reason : string option;The reason for the SchemaExtensionStatus.
schema_extension_status : schema_extension_status option;The current status of the schema extension.
*)description : string option;A description of the schema extension.
*)schema_extension_id : string option;The identifier of the schema extension.
*)directory_id : string option;The identifier of the directory to which the schema extension is applied.
*)}Information about a schema extension.
An object representing the inputs for the RestoreFromSnapshot operation.
The new password provided by the user does not meet the password complexity requirements defined in your directory.
type nonrec register_event_topic_request = {topic_name : string;The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS topic must be in the same region as the specified Directory ID.
*)directory_id : string;The Directory ID that will publish status messages to the Amazon SNS topic.
*)}Registers a new event topic.
type nonrec client_cert_auth_settings = {ocsp_url : string option;Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.
*)}Contains information about the client certificate authentication settings for the RegisterCertificate and DescribeCertificate operations.
type nonrec register_certificate_request = {client_cert_auth_settings : client_cert_auth_settings option;A ClientCertAuthSettings object that contains client certificate authentication settings.
type_ : certificate_type option;The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
certificate_data : string;The certificate PEM string that needs to be registered.
*)directory_id : string;The identifier of the directory.
*)}The certificate PEM that was provided has incorrect encoding.
The certificate could not be added because the certificate limit has been reached.
The certificate has already been registered into the system.
type nonrec regions_info = {additional_regions : string list option;Lists the Regions where the directory has been replicated, excluding the primary Region.
*)primary_region : string option;The Region where the Managed Microsoft AD directory was originally created.
*)}Provides information about the Regions that are configured for multi-Region replication.
type nonrec directory_vpc_settings = {subnet_ids : string list;The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. Directory Service creates a directory server and a DNS server in each of these subnets.
*)vpc_id : string;The identifier of the VPC in which to create the directory.
*)}Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
type nonrec region_description = {last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the Region description was last updated.
*)status_last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the Region status was last updated.
*)launch_time : Smaws_Lib.CoreTypes.Timestamp.t option;Specifies when the Region replication began.
*)desired_number_of_domain_controllers : int option;The desired number of domain controllers in the specified Region for the specified directory.
*)vpc_settings : directory_vpc_settings option;status : directory_stage option;The status of the replication process for the specified Region.
*)region_type : region_type option;Specifies whether the Region is the primary Region or an additional Region.
*)region_name : string option;The name of the Region. For example, us-east-1.
directory_id : string option;The identifier of the directory.
*)}The replicated Region information for a directory.
You have reached the limit for maximum number of simultaneous Region replications per directory.
type nonrec directory_vpc_settings_description = {availability_zones : string list option;The list of Availability Zones that the directory is in.
*)security_group_id : string option;The domain controller security group identifier for the directory.
*)subnet_ids : string list option;The identifiers of the subnets for the directory servers.
*)vpc_id : string option;The identifier of the VPC that the directory is in.
*)}Contains information about the directory.
type nonrec owner_directory_description = {radius_status : radius_status option;Information about the status of the RADIUS server.
*)radius_settings : radius_settings option;A RadiusSettings object that contains information about the RADIUS server.
vpc_settings : directory_vpc_settings_description option;Information about the VPC settings for the directory.
*)dns_ip_addrs : string list option;IP address of the directory’s domain controllers.
*)account_id : string option;Identifier of the directory owner account.
*)directory_id : string option;Identifier of the Managed Microsoft AD directory in the directory owner account.
*)}Describes the directory owner account details that have been shared to the directory consumer account.
Client authentication setup could not be completed because at least one valid certificate must be registered in the system.
type nonrec log_subscription = {subscription_created_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the log subscription was created.
*)log_group_name : string option;The name of the log group.
*)directory_id : string option;Identifier (ID) of the directory that you want to associate with the log subscription.
*)}Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.
The NextToken value is not valid.
type nonrec list_schema_extensions_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.
schema_extensions_info : schema_extension_info list option;Information about the schema extensions applied to the directory.
*)}type nonrec list_schema_extensions_request = {limit : int option;The maximum number of items to return.
*)next_token : string option;The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
directory_id : string;The identifier of the directory from which to retrieve the schema extension information.
*)}type nonrec list_log_subscriptions_result = {next_token : string option;The token for the next set of items to return.
*)log_subscriptions : log_subscription list option;A list of active LogSubscription objects for calling the Amazon Web Services account.
}type nonrec list_log_subscriptions_request = {limit : int option;The maximum number of items returned.
*)next_token : string option;The token for the next set of items to return.
*)directory_id : string option;If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.
*)}type nonrec ip_route_info = {description : string option;Description of the IpRouteInfo.
ip_route_status_reason : string option;The reason for the IpRouteStatusMsg.
*)added_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time the address block was added to the directory.
*)ip_route_status_msg : ip_route_status_msg option;The status of the IP address block.
*)cidr_ip : string option;IP address block in the IpRoute.
directory_id : string option;Identifier (ID) of the directory associated with the IP addresses.
*)}Information about one or more IP address blocks.
type nonrec list_ip_routes_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.
ip_routes_info : ip_route_info list option;A list of IpRoutes.
}type nonrec list_ip_routes_request = {limit : int option;Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
*)next_token : string option;The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
directory_id : string;Identifier (ID) of the directory for which you want to retrieve the IP addresses.
*)}type nonrec certificate_info = {type_ : certificate_type option;The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
expiry_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the certificate will expire.
*)state : certificate_state option;The state of the certificate.
*)common_name : string option;The common name for the certificate.
*)certificate_id : string option;The identifier of the certificate.
*)}Contains general information about a certificate.
type nonrec list_certificates_result = {certificates_info : certificate_info list option;A list of certificates with basic details including certificate ID, certificate common name, certificate state.
*)next_token : string option;Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.
*)}type nonrec list_certificates_request = {limit : int option;The number of items that should show up on one page
*)next_token : string option;A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.
directory_id : string;The identifier of the directory.
*)}type nonrec ldaps_setting_info = {last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the LDAPS settings were last updated.
*)ldaps_status_reason : string option;Describes a state change for LDAPS.
*)ldaps_status : ldaps_status option;The state of the LDAPS settings.
*)}Contains general information about the LDAPS settings.
type nonrec ip_route = {description : string option;Description of the address block.
*)cidr_ip : string option;IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your self-managed domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.
*)}IP address block. This is often the address block of the DNS server used for your self-managed domain.
The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
The LDAP activities could not be performed because they are limited by the LDAPS status.
The account does not have sufficient permission to perform the operation.
type nonrec get_snapshot_limits_result = {snapshot_limits : snapshot_limits option;A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
}Contains the results of the GetSnapshotLimits operation.
Contains the inputs for the GetSnapshotLimits operation.
type nonrec directory_limits = {connected_directories_limit_reached : bool option;Indicates if the connected directory limit has been reached.
*)connected_directories_current_count : int option;The current number of connected directories in the Region.
*)connected_directories_limit : int option;The maximum number of connected directories allowed in the Region.
*)cloud_only_microsoft_ad_limit_reached : bool option;Indicates if the Managed Microsoft AD directory limit has been reached.
*)cloud_only_microsoft_ad_current_count : int option;The current number of Managed Microsoft AD directories in the region.
*)cloud_only_microsoft_ad_limit : int option;The maximum number of Managed Microsoft AD directories allowed in the region.
*)cloud_only_directories_limit_reached : bool option;Indicates if the cloud directory limit has been reached.
*)cloud_only_directories_current_count : int option;The current number of cloud directories in the Region.
*)cloud_only_directories_limit : int option;The maximum number of cloud directories allowed in the Region.
*)}Contains directory limit information for a Region.
type nonrec get_directory_limits_result = {directory_limits : directory_limits option;A DirectoryLimits object that contains the directory limits for the current Region.
}Contains the results of the GetDirectoryLimits operation.
type nonrec event_topic = {status : topic_status option;The topic registration status.
*)created_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time of when you associated your directory with the Amazon SNS topic.
*)topic_arn : string option;The Amazon SNS topic ARN (Amazon Resource Name).
*)topic_name : string option;The name of an Amazon SNS topic the receives status messages from the directory.
*)directory_id : string option;The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS topic.
*)}Information about Amazon SNS topic and Directory Service directory associations.
The specified entity already exists.
type nonrec enable_sso_request = {password : string option;The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
*)user_name : string option;The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.
If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
*)directory_id : string;The identifier of the directory for which to enable single-sign on.
*)}Contains the inputs for the EnableSso operation.
type nonrec authentication_failed_exception = {request_id : string option;The identifier of the request that caused the exception.
*)message : string option;The textual message for the exception.
*)}An authentication error occurred.
type nonrec enable_radius_request = {radius_settings : radius_settings;A RadiusSettings object that contains information about the RADIUS server.
directory_id : string;The identifier of the directory for which to enable MFA.
*)}Contains the inputs for the EnableRadius operation.
type nonrec enable_ldaps_request = {type_ : ldaps_type;The type of LDAP security to enable. Currently only the value Client is supported.
directory_id : string;The identifier of the directory.
*)}type nonrec enable_client_authentication_request = {type_ : client_authentication_type;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.
directory_id : string;The identifier of the specified directory.
*)}type nonrec domain_controller = {status_last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the status was last updated.
*)launch_time : Smaws_Lib.CoreTypes.Timestamp.t option;Specifies when the domain controller was created.
*)status_reason : string option;A description of the domain controller state.
*)status : domain_controller_status option;The status of the domain controller.
*)availability_zone : string option;The Availability Zone where the domain controller is located.
*)subnet_id : string option;Identifier of the subnet in the VPC that contains the domain controller.
*)vpc_id : string option;The identifier of the VPC that contains the domain controller.
*)dns_ip_addr : string option;The IP address of the domain controller.
*)domain_controller_id : string option;Identifies a specific domain controller in the directory.
*)directory_id : string option;Identifier of the directory where the domain controller resides.
*)}Contains information about the domain controllers for a specified directory.
type nonrec disable_sso_request = {password : string option;The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
*)user_name : string option;The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.
If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
*)directory_id : string;The identifier of the directory for which to disable single-sign on.
*)}Contains the inputs for the DisableSso operation.
type nonrec disable_ldaps_request = {type_ : ldaps_type;The type of LDAP security to enable. Currently only the value Client is supported.
directory_id : string;The identifier of the directory.
*)}type nonrec disable_client_authentication_request = {type_ : client_authentication_type;The type of client authentication to disable. Currently, only the parameter, SmartCard is supported.
directory_id : string;The identifier of the directory
*)}type nonrec describe_update_directory_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter.
update_activities : update_info_entry list option;The list of update activities on a directory for the requested update type.
*)}type nonrec describe_update_directory_request = {next_token : string option;The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.
region_name : string option;The name of the Region.
*)update_type : update_type;The type of updates you want to describe for the directory.
*)directory_id : string;The unique identifier of the directory.
*)}type nonrec describe_trusts_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.
trusts : trust list option;The list of Trust 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.
*)}The result of a DescribeTrust request.
type nonrec describe_trusts_request = {limit : int option;The maximum number of objects to return.
*)next_token : string option;The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
trust_ids : string list option;A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.
An empty list results in an InvalidParameterException being thrown.
directory_id : string option;The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.
*)}Describes the trust relationships for a particular Managed Microsoft AD directory. If no input parameters are provided, such as directory ID or trust ID, this request describes all the trust relationships.
type nonrec describe_snapshots_result = {next_token : string option;If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
snapshots : snapshot list option;The list of Snapshot 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.
*)}Contains the results of the DescribeSnapshots operation.
type nonrec describe_snapshots_request = {limit : int option;The maximum number of objects to return.
*)next_token : string option;The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
snapshot_ids : string list option;A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
*)directory_id : string option;The identifier of the directory for which to retrieve snapshot information.
*)}Contains the inputs for the DescribeSnapshots operation.
type nonrec describe_settings_result = {next_token : string option;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.
setting_entries : setting_entry list option;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.
directory_id : string option;The identifier of the directory.
*)}type nonrec describe_settings_request = {next_token : string option;The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.
status : directory_configuration_status option;The status of the directory settings for which to retrieve information.
*)directory_id : string;The identifier of the directory for which to retrieve information.
*)}type nonrec describe_regions_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items.
regions_description : region_description list option;List of Region information related to the directory for each replicated Region.
*)}type nonrec describe_regions_request = {next_token : string option;The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.
region_name : string option;The name of the Region. For example, us-east-1.
directory_id : string;The identifier of the directory.
*)}type nonrec describe_ldaps_settings_result = {next_token : string option;The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.
*)ldaps_settings_info : ldaps_setting_info list option;Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.
*)}type nonrec describe_ldaps_settings_request = {limit : int option;Specifies the number of items that should be displayed on one page.
*)next_token : string option;The type of next token used for pagination.
*)type_ : ldaps_type option;The type of LDAP security to enable. Currently only the value Client is supported.
directory_id : string;The identifier of the directory.
*)}type nonrec describe_event_topics_result = {event_topics : event_topic list option;A list of Amazon SNS topic names that receive status messages from the specified Directory ID.
*)}The result of a DescribeEventTopic request.
type nonrec describe_event_topics_request = {topic_names : string list option;A list of Amazon SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.
An empty list results in an InvalidParameterException being thrown.
directory_id : string option;The Directory ID for which to get the list of associated Amazon SNS topics. If this member is null, associations for all Directory IDs are returned.
*)}Describes event topics.
type nonrec describe_domain_controllers_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.
domain_controllers : domain_controller list option;List of the DomainController objects that were retrieved.
}type nonrec describe_domain_controllers_request = {limit : int option;The maximum number of items to return.
*)next_token : string option;The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
domain_controller_ids : string list option;A list of identifiers for the domain controllers whose information will be provided.
*)directory_id : string;Identifier of the directory for which to retrieve the domain controller information.
*)}type nonrec directory_connect_settings_description = {connect_ips : string list option;The IP addresses of the AD Connector servers.
*)availability_zones : string list option;A list of the Availability Zones that the directory is in.
*)security_group_id : string option;The security group identifier for the AD Connector directory.
*)customer_user_name : string option;The user name of the service account in your self-managed directory.
*)subnet_ids : string list option;A list of subnet identifiers in the VPC that the AD Connector is in.
*)vpc_id : string option;The identifier of the VPC that the AD Connector is in.
*)}Contains information about an AD Connector directory.
type nonrec directory_description = {os_version : os_version option;The operating system (OS) version of the directory.
*)regions_info : regions_info option;Lists the Regions where the directory has replicated.
*)owner_directory_description : owner_directory_description option;Describes the Managed Microsoft AD directory in the directory owner account.
*)desired_number_of_domain_controllers : int option;The desired number of domain controllers in the directory if the directory is Microsoft AD.
*)sso_enabled : bool option;Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
stage_reason : string option;Additional information about the directory stage.
*)radius_status : radius_status option;The status of the RADIUS MFA server connection.
*)radius_settings : radius_settings option;A RadiusSettings object that contains information about the RADIUS server configured for this directory.
connect_settings : directory_connect_settings_description option;A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.
vpc_settings : directory_vpc_settings_description option;A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed Microsoft AD directory.
type_ : directory_type option;The directory size.
*)stage_last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the stage was last updated.
*)launch_time : Smaws_Lib.CoreTypes.Timestamp.t option;Specifies when the directory was created.
*)stage : directory_stage option;The current stage of the directory.
*)dns_ip_addrs : string list option;The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in your self-managed directory to which the AD Connector is connected.
*)description : string option;The description for the directory.
*)access_url : string option;The access URL for the directory, such as
http://.awsapps.com. If no alias has been created for the directory,
is the directory identifier, such as d-XXXXXXXXXX.
alias : string option;The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
edition : directory_edition option;The edition associated with this directory.
*)size : directory_size option;The directory size.
*)short_name : string option;The short name of the directory.
*)name : string option;The fully qualified name of the directory.
*)directory_id : string option;The directory identifier.
*)}Contains information about an Directory Service directory.
type nonrec describe_directories_result = {next_token : string option;If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.
directory_descriptions : directory_description list option;The list of DirectoryDescription 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.
}Contains the results of the DescribeDirectories operation.
type nonrec describe_directories_request = {limit : int option;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.
*)next_token : string option;The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
directory_ids : string list option;A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.
An empty list results in an InvalidParameterException being thrown.
}Contains the inputs for the DescribeDirectories operation.
type nonrec conditional_forwarder = {replication_scope : replication_scope option;The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your Amazon Web Services directory.
dns_ip_addrs : string list option;The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.
*)remote_domain_name : string option;The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
*)}Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.
type nonrec describe_conditional_forwarders_result = {conditional_forwarders : conditional_forwarder list option;The list of conditional forwarders that have been created.
*)}The result of a DescribeConditionalForwarder request.
type nonrec describe_conditional_forwarders_request = {remote_domain_names : string list option;The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.
*)directory_id : string;The directory ID for which to get the list of associated conditional forwarders.
*)}Describes a conditional forwarder.
type nonrec client_authentication_setting_info = {last_updated_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the status of the client authentication type was last updated.
*)status : client_authentication_status option;Whether the client authentication type is enabled or disabled for the specified directory.
*)type_ : client_authentication_type option;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.
*)}Contains information about a client authentication method for a directory.
type nonrec describe_client_authentication_settings_result = {next_token : string option;The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.
*)client_authentication_settings_info : client_authentication_setting_info list
option;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.
*)}type nonrec describe_client_authentication_settings_request = {limit : int option;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.
*)next_token : string option;The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
type_ : client_authentication_type option;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.
*)directory_id : string;The identifier of the directory for which to retrieve information.
*)}The certificate is not present in the system for describe or deregister activities.
type nonrec certificate = {client_cert_auth_settings : client_cert_auth_settings option;A ClientCertAuthSettings object that contains client certificate authentication settings.
type_ : certificate_type option;The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
expiry_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time when the certificate will expire.
*)registered_date_time : Smaws_Lib.CoreTypes.Timestamp.t option;The date and time that the certificate was registered.
*)common_name : string option;The common name for the certificate.
*)state_reason : string option;Describes a state change for the certificate.
*)state : certificate_state option;The state of the certificate.
*)certificate_id : string option;The identifier of the certificate.
*)}Information about the certificate.
type nonrec describe_certificate_result = {certificate : certificate option;Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.
*)}type nonrec deregister_event_topic_request = {topic_name : string;The name of the Amazon SNS topic from which to remove the directory as a publisher.
*)directory_id : string;The Directory ID to remove as a publisher. This directory will no longer send messages to the specified Amazon SNS topic.
*)}Removes the specified directory as a publisher to the specified Amazon SNS topic.
The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.
type nonrec delete_trust_request = {delete_associated_conditional_forwarder : bool option;Delete a conditional forwarder as part of a DeleteTrustRequest.
*)trust_id : string;The Trust ID of the trust relationship to be deleted.
*)}Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.
Contains the results of the DeleteDirectory operation.
type nonrec delete_conditional_forwarder_request = {remote_domain_name : string;The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
*)directory_id : string;The directory ID for which you are deleting the conditional forwarder.
*)}Deletes a conditional forwarder.
type nonrec create_trust_request = {selective_auth : selective_auth option;Optional parameter to enable selective authentication for the trust.
*)conditional_forwarder_ip_addrs : string list option;The IP addresses of the remote DNS server associated with RemoteDomainName.
*)trust_type : trust_type option;The trust relationship type. Forest is the default.
trust_direction : trust_direction;The direction of the trust relationship.
*)trust_password : string;The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
*)remote_domain_name : string;The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
*)directory_id : string;The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.
*)}Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain.
type nonrec create_snapshot_request = {name : string option;The descriptive name to apply to the snapshot.
*)directory_id : string;The identifier of the directory of which to take a snapshot.
*)}Contains the inputs for the CreateSnapshot operation.
The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.
type nonrec create_microsoft_ad_request = {edition : directory_edition option;Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
vpc_settings : directory_vpc_settings;Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
description : string option;A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.
password : string;The password for the default administrative user named Admin.
If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
short_name : string option;The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.
name : string;The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.
}Creates an Managed Microsoft AD directory.
type nonrec create_log_subscription_request = {log_group_name : string;The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
*)directory_id : string;Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.
*)}type nonrec create_directory_request = {vpc_settings : directory_vpc_settings option;A DirectoryVpcSettings object that contains additional information for the operation.
size : directory_size;The size of the directory.
*)description : string option;A description for the directory.
*)password : string;The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.
If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
The regex pattern for this string is made up of the following conditions:
AND any 3 of the following password complexity rules required by Active Directory:
For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.
*)short_name : string option;The NetBIOS name of the directory, such as CORP.
name : string;The fully qualified name for the directory, such as corp.example.com.
}Contains the inputs for the CreateDirectory operation.
type nonrec create_conditional_forwarder_request = {dns_ip_addrs : string list;The IP addresses of the remote DNS server associated with RemoteDomainName.
*)remote_domain_name : string;The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*)directory_id : string;The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.
*)}Initiates the creation of a conditional forwarder for your Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.
type nonrec attribute = {value : string option;The value of the attribute.
*)name : string option;The name of the attribute.
*)}Represents a named directory attribute.
type nonrec computer = {computer_attributes : attribute list option;An array of Attribute objects containing the LDAP attributes that belong to the computer account.
computer_name : string option;The computer name.
*)computer_id : string option;The identifier of the computer.
*)}Contains information about a computer account in a directory.
type nonrec create_computer_result = {computer : computer option;A Computer object that represents the computer account.
}Contains the results for the CreateComputer operation.
type nonrec create_computer_request = {computer_attributes : attribute list option;An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
organizational_unit_distinguished_name : string option;The fully-qualified distinguished name of the organizational unit to place the computer account in.
*)password : string;A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.
*)computer_name : string;The name of the computer account.
*)directory_id : string;The identifier of the directory in which to create the computer account.
*)}Contains the inputs for the CreateComputer operation.
type nonrec create_alias_result = {alias : string option;The alias for the directory.
*)directory_id : string option;The identifier of the directory.
*)}Contains the results of the CreateAlias operation.
type nonrec create_alias_request = {alias : string;The requested alias.
The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an EntityAlreadyExistsException error if the alias already exists.
directory_id : string;The identifier of the directory for which to create the alias.
*)}Contains the inputs for the CreateAlias operation.
type nonrec directory_connect_settings = {customer_user_name : string;The user name of an account in your self-managed directory that is used to connect to the directory. This account must have the following permissions:
customer_dns_ips : string list;A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.
*)subnet_ids : string list;A list of subnet identifiers in the VPC in which the AD Connector is created.
*)vpc_id : string;The identifier of the VPC in which the AD Connector is created.
*)}Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
type nonrec connect_directory_request = {connect_settings : directory_connect_settings;A DirectoryConnectSettings object that contains additional information for the operation.
size : directory_size;The size of the directory.
*)description : string option;A description for the directory.
*)password : string;The password for your self-managed user account.
*)short_name : string option;The NetBIOS name of your self-managed directory, such as CORP.
name : string;The fully qualified name of your self-managed directory, such as corp.example.com.
}Contains the inputs for the ConnectDirectory operation.
The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.
type nonrec add_region_request = {vpc_settings : directory_vpc_settings;region_name : string;The name of the Region where you want to add domain controllers for replication. For example, us-east-1.
directory_id : string;The identifier of the directory to which you want to add Region replication.
*)}type nonrec add_ip_routes_request = {update_security_group_for_directory_controllers : bool option;If set to true, updates the inbound and outbound rules of the security group that has the description: "Amazon Web Services created security group for directory ID directory controllers." Following are the new rules:
Inbound:
Outbound:
These security rules impact an internal network interface that is not exposed publicly.
*)ip_routes : ip_route list;IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your self-managed domain.
*)directory_id : string;Identifier (ID) of the directory to which to add the address block.
*)}Builders
val make_verify_trust_request : trust_id:string -> unit -> verify_trust_requestval make_os_update_settings :
?os_version:os_version ->
unit ->
os_update_settingsval make_update_value :
?os_update_settings:os_update_settings ->
unit ->
update_valueval make_update_trust_request :
?selective_auth:selective_auth ->
trust_id:string ->
unit ->
update_trust_requestval make_setting : value:string -> name:string -> unit -> settingval make_update_settings_request :
settings:setting list ->
directory_id:string ->
unit ->
update_settings_requestval make_radius_settings :
?use_same_username:bool ->
?display_label:string ->
?authentication_protocol:radius_authentication_protocol ->
?shared_secret:string ->
?radius_retries:int ->
?radius_timeout:int ->
?radius_port:int ->
?radius_servers:string list ->
unit ->
radius_settingsval make_update_radius_request :
radius_settings:radius_settings ->
directory_id:string ->
unit ->
update_radius_requestval make_update_number_of_domain_controllers_request :
desired_number:int ->
directory_id:string ->
unit ->
update_number_of_domain_controllers_requestval make_update_info_entry :
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?start_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?previous_value:update_value ->
?new_value:update_value ->
?initiated_by:string ->
?status_reason:string ->
?status:update_status ->
?region:string ->
unit ->
update_info_entryval make_update_directory_setup_request :
?create_snapshot_before_update:bool ->
?os_update_settings:os_update_settings ->
update_type:update_type ->
directory_id:string ->
unit ->
update_directory_setup_requestval make_update_conditional_forwarder_request :
dns_ip_addrs:string list ->
remote_domain_name:string ->
directory_id:string ->
unit ->
update_conditional_forwarder_requestval make_trust :
?selective_auth:selective_auth ->
?trust_state_reason:string ->
?state_last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?created_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?trust_state:trust_state ->
?trust_direction:trust_direction ->
?trust_type:trust_type ->
?remote_domain_name:string ->
?trust_id:string ->
?directory_id:string ->
unit ->
trustval make_tag : value:string -> key:string -> unit -> tagval make_start_schema_extension_request :
description:string ->
ldif_content:string ->
create_snapshot_before_schema_extension:bool ->
directory_id:string ->
unit ->
start_schema_extension_requestval make_snapshot :
?start_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?status:snapshot_status ->
?name:string ->
?type_:snapshot_type ->
?snapshot_id:string ->
?directory_id:string ->
unit ->
snapshotval make_snapshot_limits :
?manual_snapshots_limit_reached:bool ->
?manual_snapshots_current_count:int ->
?manual_snapshots_limit:int ->
unit ->
snapshot_limitsval make_setting_entry :
?data_type:string ->
?last_requested_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?request_status_message:string ->
?request_detailed_status:
directory_configuration_setting_request_detailed_status ->
?request_status:directory_configuration_status ->
?requested_value:string ->
?applied_value:string ->
?allowed_values:string ->
?name:string ->
?type_:string ->
unit ->
setting_entryval make_schema_extension_info :
?end_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?start_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?schema_extension_status_reason:string ->
?schema_extension_status:schema_extension_status ->
?description:string ->
?schema_extension_id:string ->
?directory_id:string ->
unit ->
schema_extension_infoval make_restore_from_snapshot_request :
snapshot_id:string ->
unit ->
restore_from_snapshot_requestval make_reset_user_password_request :
new_password:string ->
user_name:string ->
directory_id:string ->
unit ->
reset_user_password_requestval make_remove_tags_from_resource_request :
tag_keys:string list ->
resource_id:string ->
unit ->
remove_tags_from_resource_requestval make_remove_region_request :
directory_id:string ->
unit ->
remove_region_requestval make_remove_ip_routes_request :
cidr_ips:string list ->
directory_id:string ->
unit ->
remove_ip_routes_requestval make_register_event_topic_request :
topic_name:string ->
directory_id:string ->
unit ->
register_event_topic_requestval make_client_cert_auth_settings :
?ocsp_url:string ->
unit ->
client_cert_auth_settingsval make_register_certificate_request :
?client_cert_auth_settings:client_cert_auth_settings ->
?type_:certificate_type ->
certificate_data:string ->
directory_id:string ->
unit ->
register_certificate_requestval make_regions_info :
?additional_regions:string list ->
?primary_region:string ->
unit ->
regions_infoval make_directory_vpc_settings :
subnet_ids:string list ->
vpc_id:string ->
unit ->
directory_vpc_settingsval make_region_description :
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?status_last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?launch_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?desired_number_of_domain_controllers:int ->
?vpc_settings:directory_vpc_settings ->
?status:directory_stage ->
?region_type:region_type ->
?region_name:string ->
?directory_id:string ->
unit ->
region_descriptionval make_directory_vpc_settings_description :
?availability_zones:string list ->
?security_group_id:string ->
?subnet_ids:string list ->
?vpc_id:string ->
unit ->
directory_vpc_settings_descriptionval make_owner_directory_description :
?radius_status:radius_status ->
?radius_settings:radius_settings ->
?vpc_settings:directory_vpc_settings_description ->
?dns_ip_addrs:string list ->
?account_id:string ->
?directory_id:string ->
unit ->
owner_directory_descriptionval make_log_subscription :
?subscription_created_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?log_group_name:string ->
?directory_id:string ->
unit ->
log_subscriptionval make_list_tags_for_resource_request :
?limit:int ->
?next_token:string ->
resource_id:string ->
unit ->
list_tags_for_resource_requestval make_list_schema_extensions_request :
?limit:int ->
?next_token:string ->
directory_id:string ->
unit ->
list_schema_extensions_requestval make_list_log_subscriptions_request :
?limit:int ->
?next_token:string ->
?directory_id:string ->
unit ->
list_log_subscriptions_requestval make_ip_route_info :
?description:string ->
?ip_route_status_reason:string ->
?added_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?ip_route_status_msg:ip_route_status_msg ->
?cidr_ip:string ->
?directory_id:string ->
unit ->
ip_route_infoval make_list_ip_routes_request :
?limit:int ->
?next_token:string ->
directory_id:string ->
unit ->
list_ip_routes_requestval make_certificate_info :
?type_:certificate_type ->
?expiry_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?state:certificate_state ->
?common_name:string ->
?certificate_id:string ->
unit ->
certificate_infoval make_list_certificates_request :
?limit:int ->
?next_token:string ->
directory_id:string ->
unit ->
list_certificates_requestval make_ldaps_setting_info :
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?ldaps_status_reason:string ->
?ldaps_status:ldaps_status ->
unit ->
ldaps_setting_infoval make_ip_route : ?description:string -> ?cidr_ip:string -> unit -> ip_routeval make_get_snapshot_limits_request :
directory_id:string ->
unit ->
get_snapshot_limits_requestval make_directory_limits :
?connected_directories_limit_reached:bool ->
?connected_directories_current_count:int ->
?connected_directories_limit:int ->
?cloud_only_microsoft_ad_limit_reached:bool ->
?cloud_only_microsoft_ad_current_count:int ->
?cloud_only_microsoft_ad_limit:int ->
?cloud_only_directories_limit_reached:bool ->
?cloud_only_directories_current_count:int ->
?cloud_only_directories_limit:int ->
unit ->
directory_limitsval make_event_topic :
?status:topic_status ->
?created_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?topic_arn:string ->
?topic_name:string ->
?directory_id:string ->
unit ->
event_topicval make_enable_sso_request :
?password:string ->
?user_name:string ->
directory_id:string ->
unit ->
enable_sso_requestval make_enable_radius_request :
radius_settings:radius_settings ->
directory_id:string ->
unit ->
enable_radius_requestval make_enable_ldaps_request :
type_:ldaps_type ->
directory_id:string ->
unit ->
enable_ldaps_requestval make_enable_client_authentication_request :
type_:client_authentication_type ->
directory_id:string ->
unit ->
enable_client_authentication_requestval make_domain_controller :
?status_last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?launch_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?status_reason:string ->
?status:domain_controller_status ->
?availability_zone:string ->
?subnet_id:string ->
?vpc_id:string ->
?dns_ip_addr:string ->
?domain_controller_id:string ->
?directory_id:string ->
unit ->
domain_controllerval make_disable_sso_request :
?password:string ->
?user_name:string ->
directory_id:string ->
unit ->
disable_sso_requestval make_disable_radius_request :
directory_id:string ->
unit ->
disable_radius_requestval make_disable_ldaps_request :
type_:ldaps_type ->
directory_id:string ->
unit ->
disable_ldaps_requestval make_disable_client_authentication_request :
type_:client_authentication_type ->
directory_id:string ->
unit ->
disable_client_authentication_requestval make_describe_update_directory_request :
?next_token:string ->
?region_name:string ->
update_type:update_type ->
directory_id:string ->
unit ->
describe_update_directory_requestval make_describe_trusts_request :
?limit:int ->
?next_token:string ->
?trust_ids:string list ->
?directory_id:string ->
unit ->
describe_trusts_requestval make_describe_snapshots_request :
?limit:int ->
?next_token:string ->
?snapshot_ids:string list ->
?directory_id:string ->
unit ->
describe_snapshots_requestval make_describe_settings_request :
?next_token:string ->
?status:directory_configuration_status ->
directory_id:string ->
unit ->
describe_settings_requestval make_describe_regions_request :
?next_token:string ->
?region_name:string ->
directory_id:string ->
unit ->
describe_regions_requestval make_describe_ldaps_settings_request :
?limit:int ->
?next_token:string ->
?type_:ldaps_type ->
directory_id:string ->
unit ->
describe_ldaps_settings_requestval make_describe_event_topics_request :
?topic_names:string list ->
?directory_id:string ->
unit ->
describe_event_topics_requestval make_describe_domain_controllers_request :
?limit:int ->
?next_token:string ->
?domain_controller_ids:string list ->
directory_id:string ->
unit ->
describe_domain_controllers_requestval make_directory_connect_settings_description :
?connect_ips:string list ->
?availability_zones:string list ->
?security_group_id:string ->
?customer_user_name:string ->
?subnet_ids:string list ->
?vpc_id:string ->
unit ->
directory_connect_settings_descriptionval make_directory_description :
?os_version:os_version ->
?regions_info:regions_info ->
?owner_directory_description:owner_directory_description ->
?desired_number_of_domain_controllers:int ->
?sso_enabled:bool ->
?stage_reason:string ->
?radius_status:radius_status ->
?radius_settings:radius_settings ->
?connect_settings:directory_connect_settings_description ->
?vpc_settings:directory_vpc_settings_description ->
?type_:directory_type ->
?stage_last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?launch_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?share_notes:string ->
?share_method:share_method ->
?share_status:share_status ->
?stage:directory_stage ->
?dns_ip_addrs:string list ->
?description:string ->
?access_url:string ->
?alias:string ->
?edition:directory_edition ->
?size:directory_size ->
?short_name:string ->
?name:string ->
?directory_id:string ->
unit ->
directory_descriptionval make_describe_directories_request :
?limit:int ->
?next_token:string ->
?directory_ids:string list ->
unit ->
describe_directories_requestval make_conditional_forwarder :
?replication_scope:replication_scope ->
?dns_ip_addrs:string list ->
?remote_domain_name:string ->
unit ->
conditional_forwarderval make_describe_conditional_forwarders_request :
?remote_domain_names:string list ->
directory_id:string ->
unit ->
describe_conditional_forwarders_requestval make_client_authentication_setting_info :
?last_updated_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?status:client_authentication_status ->
?type_:client_authentication_type ->
unit ->
client_authentication_setting_infoval make_describe_client_authentication_settings_request :
?limit:int ->
?next_token:string ->
?type_:client_authentication_type ->
directory_id:string ->
unit ->
describe_client_authentication_settings_requestval make_certificate :
?client_cert_auth_settings:client_cert_auth_settings ->
?type_:certificate_type ->
?expiry_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?registered_date_time:Smaws_Lib.CoreTypes.Timestamp.t ->
?common_name:string ->
?state_reason:string ->
?state:certificate_state ->
?certificate_id:string ->
unit ->
certificateval make_describe_certificate_request :
certificate_id:string ->
directory_id:string ->
unit ->
describe_certificate_requestval make_deregister_event_topic_request :
topic_name:string ->
directory_id:string ->
unit ->
deregister_event_topic_requestval make_deregister_certificate_request :
certificate_id:string ->
directory_id:string ->
unit ->
deregister_certificate_requestval make_delete_trust_request :
?delete_associated_conditional_forwarder:bool ->
trust_id:string ->
unit ->
delete_trust_requestval make_delete_snapshot_request :
snapshot_id:string ->
unit ->
delete_snapshot_requestval make_delete_log_subscription_request :
directory_id:string ->
unit ->
delete_log_subscription_requestval make_delete_directory_request :
directory_id:string ->
unit ->
delete_directory_requestval make_delete_conditional_forwarder_request :
remote_domain_name:string ->
directory_id:string ->
unit ->
delete_conditional_forwarder_requestval make_create_trust_request :
?selective_auth:selective_auth ->
?conditional_forwarder_ip_addrs:string list ->
?trust_type:trust_type ->
trust_direction:trust_direction ->
trust_password:string ->
remote_domain_name:string ->
directory_id:string ->
unit ->
create_trust_requestval make_create_snapshot_request :
?name:string ->
directory_id:string ->
unit ->
create_snapshot_requestval make_create_microsoft_ad_request :
?tags:tag list ->
?edition:directory_edition ->
?description:string ->
?short_name:string ->
vpc_settings:directory_vpc_settings ->
password:string ->
name:string ->
unit ->
create_microsoft_ad_requestval make_create_log_subscription_request :
log_group_name:string ->
directory_id:string ->
unit ->
create_log_subscription_requestval make_create_directory_request :
?tags:tag list ->
?vpc_settings:directory_vpc_settings ->
?description:string ->
?short_name:string ->
size:directory_size ->
password:string ->
name:string ->
unit ->
create_directory_requestval make_create_conditional_forwarder_request :
dns_ip_addrs:string list ->
remote_domain_name:string ->
directory_id:string ->
unit ->
create_conditional_forwarder_requestval make_attribute : ?value:string -> ?name:string -> unit -> attributeval make_create_computer_request :
?computer_attributes:attribute list ->
?organizational_unit_distinguished_name:string ->
password:string ->
computer_name:string ->
directory_id:string ->
unit ->
create_computer_requestval make_create_alias_request :
alias:string ->
directory_id:string ->
unit ->
create_alias_requestval make_directory_connect_settings :
customer_user_name:string ->
customer_dns_ips:string list ->
subnet_ids:string list ->
vpc_id:string ->
unit ->
directory_connect_settingsval make_connect_directory_request :
?tags:tag list ->
?description:string ->
?short_name:string ->
connect_settings:directory_connect_settings ->
size:directory_size ->
password:string ->
name:string ->
unit ->
connect_directory_requestval make_cancel_schema_extension_request :
schema_extension_id:string ->
directory_id:string ->
unit ->
cancel_schema_extension_requestval make_add_tags_to_resource_request :
tags:tag list ->
resource_id:string ->
unit ->
add_tags_to_resource_requestval make_add_region_request :
vpc_settings:directory_vpc_settings ->
region_name:string ->
directory_id:string ->
unit ->
add_region_requestval make_add_ip_routes_request :
?update_security_group_for_directory_controllers:bool ->
ip_routes:ip_route list ->
directory_id:string ->
unit ->
add_ip_routes_requestOperations
Accepts a directory sharing request that was sent from the directory owner account.
module AddIpRoutes : sig ... endIf the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
module AddRegion : sig ... endAdds two domain controllers in the specified Region for the specified directory.
module AddTagsToResource : sig ... endAdds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
module CancelSchemaExtension : sig ... endCancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
module ConnectDirectory : sig ... endCreates an AD Connector to connect to a self-managed directory.
module CreateAlias : sig ... endCreates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as
module CreateComputer : sig ... endCreates an Active Directory computer object in the specified directory.
module CreateConditionalForwarder : sig ... endCreates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
module CreateDirectory : sig ... endCreates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
module CreateLogSubscription : sig ... endCreates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
module CreateMicrosoftAD : sig ... endCreates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
module CreateSnapshot : sig ... endCreates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
module CreateTrust : sig ... endDirectory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
module DeleteConditionalForwarder : sig ... endDeletes a conditional forwarder that has been set up for your Amazon Web Services directory.
module DeleteDirectory : sig ... endDeletes an Directory Service directory.
module DeleteLogSubscription : sig ... endDeletes the specified log subscription.
module DeleteSnapshot : sig ... endDeletes a directory snapshot.
module DeleteTrust : sig ... endDeletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
module DeregisterCertificate : sig ... endDeletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
module DeregisterEventTopic : sig ... endRemoves the specified directory as a publisher to the specified Amazon SNS topic.
module DescribeCertificate : sig ... endDisplays information about the certificate registered for secure LDAP or client certificate authentication.
module DescribeClientAuthenticationSettings : sig ... endRetrieves 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.
module DescribeConditionalForwarders : sig ... endObtains information about the conditional forwarders for this account.
module DescribeDirectories : sig ... endObtains information about the directories that belong to this account.
module DescribeDomainControllers : sig ... endProvides information about any domain controllers in your directory.
module DescribeEventTopics : sig ... endObtains information about which Amazon SNS topics receive status messages from the specified directory.
module DescribeLDAPSSettings : sig ... endDescribes the status of LDAP security for the specified directory.
module DescribeRegions : sig ... endProvides information about the Regions that are configured for multi-Region replication.
module DescribeSettings : sig ... endRetrieves information about the configurable settings for the specified directory.
Returns the shared directories in your account.
module DescribeSnapshots : sig ... endObtains information about the directory snapshots that belong to this account.
module DescribeTrusts : sig ... endObtains information about the trust relationships for this account.
module DescribeUpdateDirectory : sig ... endDescribes the updates of a directory for a particular update type.
module DisableClientAuthentication : sig ... endDisables alternative client authentication methods for the specified directory.
module DisableLDAPS : sig ... endDeactivates LDAP secure calls for the specified directory.
module DisableRadius : sig ... endDisables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
module DisableSso : sig ... endDisables single-sign on for a directory.
module EnableClientAuthentication : sig ... endEnables alternative client authentication methods for the specified directory.
module EnableLDAPS : sig ... endActivates the switch for the specific directory to always use LDAP secure calls.
module EnableRadius : sig ... endEnables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
module EnableSso : sig ... endEnables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
module GetDirectoryLimits : sig ... endObtains directory limit information for the current Region.
module GetSnapshotLimits : sig ... endObtains the manual snapshot limits for a directory.
module ListCertificates : sig ... endFor the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
module ListIpRoutes : sig ... endLists the address blocks that you have added to a directory.
module ListLogSubscriptions : sig ... endLists the active log subscriptions for the Amazon Web Services account.
module ListSchemaExtensions : sig ... endLists all schema extensions applied to a Microsoft AD Directory.
module ListTagsForResource : sig ... endLists all tags on a directory.
module RegisterCertificate : sig ... endRegisters a certificate for a secure LDAP or client certificate authentication.
module RegisterEventTopic : sig ... endAssociates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
Rejects a directory sharing request that was sent from the directory owner account.
module RemoveIpRoutes : sig ... endRemoves IP address blocks from a directory.
module RemoveRegion : sig ... endStops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.
module RemoveTagsFromResource : sig ... endRemoves tags from a directory.
module ResetUserPassword : sig ... endResets the password for any user in your Managed Microsoft AD or Simple AD directory.
module RestoreFromSnapshot : sig ... endRestores a directory using an existing directory snapshot.
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
module StartSchemaExtension : sig ... endApplies a schema extension to a Microsoft AD directory.
Stops the directory sharing between the directory owner and consumer accounts.
module UpdateConditionalForwarder : sig ... endUpdates a conditional forwarder that has been set up for your Amazon Web Services directory.
module UpdateDirectorySetup : sig ... endUpdates the directory for a particular update type.
module UpdateNumberOfDomainControllers : sig ... endAdds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
module UpdateRadius : sig ... endUpdates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
module UpdateSettings : sig ... endUpdates the configurable settings for the specified directory.
module UpdateTrust : sig ... endUpdates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
module VerifyTrust : sig ... endDirectory Service for Microsoft Active Directory allows you to configure and verify trust relationships.