Smaws_Client_DirectoryService.Typestype nonrec verify_trust_result = {trust_id : trust_id option;The unique Trust ID of the trust relationship that was verified.
*)}Result of a VerifyTrust request.
type nonrec verify_trust_request = {trust_id : trust_id;The unique Trust ID of the trust relationship to verify.
*)}Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.
type nonrec unsupported_operation_exception = {request_id : request_id option;message : exception_message option;}The operation is not supported.
type nonrec service_exception = {request_id : request_id option;message : exception_message option;}An exception has occurred in Directory Service.
type nonrec invalid_parameter_exception = {request_id : request_id option;message : exception_message option;}One or more parameters are not valid.
type nonrec entity_does_not_exist_exception = {request_id : request_id option;message : exception_message option;}The specified entity could not be found.
A client exception has occurred.
type nonrec user_does_not_exist_exception = {request_id : request_id option;message : exception_message option;}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_result = {trust_id : trust_id option;Identifier of the trust relationship.
*)request_id : request_id option;}type nonrec update_trust_request = {selective_auth : selective_auth option;Updates selective authentication for the trust.
*)trust_id : trust_id;Identifier of the trust relationship.
*)}type nonrec update_settings_result = {directory_id : directory_id option;The identifier of the directory.
*)}type nonrec setting = {value : directory_configuration_setting_value;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 : directory_configuration_setting_name;The name of the directory setting. For example:
TLS_1_0
}Contains information about the configurable settings for a directory.
type nonrec settings = setting listtype nonrec update_settings_request = {settings : settings;The list of Setting objects.
directory_id : directory_id;The identifier of the directory for which to update settings.
*)}type nonrec unsupported_settings_exception = {request_id : request_id option;message : exception_message option;}The specified directory setting is not supported.
type nonrec incompatible_settings_exception = {request_id : request_id option;message : exception_message option;}The specified directory setting is not compatible with other settings.
The specified directory is unavailable.
type nonrec directory_does_not_exist_exception = {request_id : request_id option;message : exception_message option;}The specified directory does not exist in the system.
type nonrec servers = server listtype nonrec radius_settings = {use_same_username : use_same_username option;Not currently used.
*)display_label : radius_display_label option;Not currently used.
*)authentication_protocol : radius_authentication_protocol option;The protocol specified for your RADIUS endpoints.
*)radius_retries : radius_retries option;The maximum number of times that communication with the RADIUS server is retried after the initial attempt.
*)radius_timeout : radius_timeout option;The amount of time, in seconds, to wait for the RADIUS server to respond.
*)radius_port : port_number 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 : servers 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 : directory_id;The identifier of the directory for which to update the RADIUS server information.
*)}Contains the inputs for the UpdateRadius operation.
type nonrec update_number_of_domain_controllers_request = {desired_number : desired_number_of_domain_controllers;The number of domain controllers desired in the directory.
*)directory_id : directory_id;Identifier of the directory to which the domain controllers will be added or removed.
*)}type nonrec domain_controller_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}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 : last_updated_date_time option;The last updated date and time of a particular directory setting.
*)start_time : start_date_time 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 : initiated_by option;This specifies if the update was initiated by the customer or by the service team.
*)status_reason : update_status_reason 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 : region_name 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 : create_snapshot_before_update 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 : directory_id;The identifier of the directory on which you want to perform the update.
*)}type nonrec snapshot_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}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.
type nonrec directory_in_desired_state_exception = {request_id : request_id option;message : exception_message option;}The directory is already updated to desired update type settings.
type nonrec access_denied_exception = {request_id : request_id option;message : exception_message option;}You do not have sufficient access to perform this action.
type nonrec dns_ip_addrs = ip_addr listtype nonrec update_conditional_forwarder_request = {dns_ip_addrs : dns_ip_addrs;The updated IP addresses of the remote DNS server associated with the conditional forwarder.
*)remote_domain_name : remote_domain_name;The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*)directory_id : directory_id;The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.
*)}Updates a conditional forwarder.
type nonrec update_activities = update_info_entry listIdentifier that contains details about the directory consumer account with whom the directory is being unshared.
type nonrec invalid_target_exception = {request_id : request_id option;message : exception_message option;}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 : trust_state_reason option;The reason for the TrustState.
*)state_last_updated_date_time : state_last_updated_date_time option;The date and time that the TrustState was last updated.
*)last_updated_date_time : last_updated_date_time option;The date and time that the trust relationship was last updated.
*)created_date_time : created_date_time 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 : remote_domain_name option;The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
*)trust_id : trust_id option;The unique ID of the trust relationship.
*)directory_id : directory_id 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 trusts = trust listtype nonrec trust_ids = trust_id listtype nonrec topic_names = topic_name listtype nonrec tag = {value : tag_value;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 : tag_key;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.
type nonrec tags = tag listtype nonrec tag_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}The maximum allowed number of tags was exceeded.
type nonrec tag_keys = tag_key listtype nonrec subnet_ids = subnet_id listtype nonrec start_schema_extension_result = {schema_extension_id : schema_extension_id option;The identifier of the schema extension that will be applied.
*)}type nonrec start_schema_extension_request = {description : description;A description of the schema extension.
*)ldif_content : ldif_content;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 : create_snapshot_before_schema_extension;If true, creates a snapshot of the directory before applying the schema extension.
*)directory_id : directory_id;The identifier of the directory for which the schema extension will be applied to.
*)}type nonrec snapshot = {start_time : start_time option;The date and time that the snapshot was taken.
*)status : snapshot_status option;The snapshot status.
*)name : snapshot_name option;The descriptive name of the snapshot.
*)type_ : snapshot_type option;The snapshot type.
*)snapshot_id : snapshot_id option;The snapshot identifier.
*)directory_id : directory_id option;The directory identifier.
*)}Describes a directory snapshot.
type nonrec snapshots = snapshot listtype nonrec snapshot_limits = {manual_snapshots_limit_reached : manual_snapshots_limit_reached option;Indicates if the manual snapshot limit has been reached.
*)manual_snapshots_current_count : limit option;The current number of manual snapshots of the directory.
*)manual_snapshots_limit : limit option;The maximum number of manual snapshots allowed.
*)}Contains manual snapshot limit information for a directory.
type nonrec snapshot_ids = snapshot_id listDetails 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.
type nonrec organizations_exception = {request_id : request_id option;message : exception_message option;}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 =
(region_name * directory_configuration_status) listtype nonrec setting_entry = {data_type : directory_configuration_setting_data_type 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 : directory_configuration_setting_last_requested_date_time
option;The date and time when the request to update a directory setting was last submitted.
*)last_updated_date_time : directory_configuration_setting_last_updated_date_time
option;The date and time when the directory setting was last updated.
*)request_status_message : directory_configuration_setting_request_status_message
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 : directory_configuration_setting_value option;The value that was last requested for the directory setting.
*)applied_value : directory_configuration_setting_value option;The value of the directory setting that is applied to the directory.
*)allowed_values : directory_configuration_setting_allowed_values option;The valid range of values for the directory setting. These values depend on the DataType of your directory.
name : directory_configuration_setting_name option;The name of the directory setting. For example:
TLS_1_0
type_ : directory_configuration_setting_type 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 setting_entries = setting_entry listtype nonrec schema_extension_info = {end_date_time : end_date_time option;The date and time that the schema extension was completed.
*)start_date_time : start_date_time option;The date and time that the schema extension started being applied to the directory.
*)schema_extension_status_reason : schema_extension_status_reason option;The reason for the SchemaExtensionStatus.
schema_extension_status : schema_extension_status option;The current status of the schema extension.
*)description : description option;A description of the schema extension.
*)schema_extension_id : schema_extension_id option;The identifier of the schema extension.
*)directory_id : directory_id option;The identifier of the directory to which the schema extension is applied.
*)}Information about a schema extension.
type nonrec schema_extensions_info = schema_extension_info listtype nonrec restore_from_snapshot_request = {snapshot_id : snapshot_id;The identifier of the snapshot to restore from.
*)}An object representing the inputs for the RestoreFromSnapshot operation.
type nonrec reset_user_password_request = {new_password : user_password;The new password that will be reset.
*)user_name : customer_user_name;The user name of the user whose password will be reset.
*)directory_id : directory_id;Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.
*)}type nonrec invalid_password_exception = {request_id : request_id option;message : exception_message option;}The new password provided by the user does not meet the password complexity requirements defined in your directory.
type nonrec remove_region_request = {directory_id : directory_id;The identifier of the directory for which you want to remove Region replication.
*)}type nonrec cidr_ips = cidr_ip listtype nonrec remove_ip_routes_request = {cidr_ips : cidr_ips;IP address blocks that you want to remove.
*)directory_id : directory_id;Identifier (ID) of the directory from which you want to remove the IP addresses.
*)}type nonrec remote_domain_names = remote_domain_name listtype nonrec register_event_topic_request = {topic_name : topic_name;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 : directory_id;The Directory ID that will publish status messages to the Amazon SNS topic.
*)}Registers a new event topic.
type nonrec register_certificate_result = {certificate_id : certificate_id option;The identifier of the certificate.
*)}type nonrec client_cert_auth_settings = {ocsp_url : ocsp_url 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 : certificate_data;The certificate PEM string that needs to be registered.
*)directory_id : directory_id;The identifier of the directory.
*)}type nonrec invalid_certificate_exception = {request_id : request_id option;message : exception_message option;}The certificate PEM that was provided has incorrect encoding.
type nonrec certificate_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}The certificate could not be added because the certificate limit has been reached.
type nonrec certificate_already_exists_exception = {request_id : request_id option;message : exception_message option;}The certificate has already been registered into the system.
type nonrec additional_regions = region_name listtype nonrec regions_info = {additional_regions : additional_regions option;Lists the Regions where the directory has been replicated, excluding the primary Region.
*)primary_region : region_name 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 : subnet_ids;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 : vpc_id;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 : last_updated_date_time option;The date and time that the Region description was last updated.
*)status_last_updated_date_time : state_last_updated_date_time option;The date and time that the Region status was last updated.
*)launch_time : launch_time option;Specifies when the Region replication began.
*)desired_number_of_domain_controllers : desired_number_of_domain_controllers
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 : region_name option;The name of the Region. For example, us-east-1.
directory_id : directory_id option;The identifier of the directory.
*)}The replicated Region information for a directory.
type nonrec regions_description = region_description listtype nonrec region_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}You have reached the limit for maximum number of simultaneous Region replications per directory.
type nonrec availability_zones = availability_zone listtype nonrec directory_vpc_settings_description = {availability_zones : availability_zones option;The list of Availability Zones that the directory is in.
*)security_group_id : security_group_id option;The domain controller security group identifier for the directory.
*)subnet_ids : subnet_ids option;The identifiers of the subnets for the directory servers.
*)vpc_id : vpc_id 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 : dns_ip_addrs option;IP address of the directory’s domain controllers.
*)account_id : customer_id option;Identifier of the directory owner account.
*)directory_id : directory_id 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.
type nonrec no_available_certificate_exception = {request_id : request_id option;message : exception_message option;}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 : subscription_created_date_time option;The date and time that the log subscription was created.
*)log_group_name : log_group_name option;The name of the log group.
*)directory_id : directory_id 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.
type nonrec log_subscriptions = log_subscription listtype nonrec invalid_next_token_exception = {request_id : request_id option;message : exception_message option;}The NextToken value is not valid.
type nonrec list_schema_extensions_result = {next_token : next_token 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_extensions_info option;Information about the schema extensions applied to the directory.
*)}type nonrec list_schema_extensions_request = {limit : limit option;The maximum number of items to return.
*)next_token : next_token option;The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
directory_id : directory_id;The identifier of the directory from which to retrieve the schema extension information.
*)}type nonrec list_log_subscriptions_result = {next_token : next_token option;The token for the next set of items to return.
*)log_subscriptions : log_subscriptions option;A list of active LogSubscription objects for calling the Amazon Web Services account.
}type nonrec list_log_subscriptions_request = {limit : limit option;The maximum number of items returned.
*)next_token : next_token option;The token for the next set of items to return.
*)directory_id : directory_id 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 : description option;Description of the IpRouteInfo.
ip_route_status_reason : ip_route_status_reason option;The reason for the IpRouteStatusMsg.
*)added_date_time : added_date_time 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 : cidr_ip option;IP address block in the IpRoute.
directory_id : directory_id option;Identifier (ID) of the directory associated with the IP addresses.
*)}Information about one or more IP address blocks.
type nonrec ip_routes_info = ip_route_info listtype nonrec list_ip_routes_result = {next_token : next_token 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_routes_info option;A list of IpRoutes.
}type nonrec list_ip_routes_request = {limit : limit 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 : next_token option;The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
directory_id : directory_id;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 : certificate_expiry_date_time option;The date and time when the certificate will expire.
*)state : certificate_state option;The state of the certificate.
*)common_name : certificate_c_n option;The common name for the certificate.
*)certificate_id : certificate_id option;The identifier of the certificate.
*)}Contains general information about a certificate.
type nonrec certificates_info = certificate_info listtype nonrec list_certificates_result = {certificates_info : certificates_info option;A list of certificates with basic details including certificate ID, certificate common name, certificate state.
*)next_token : next_token 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 : page_limit option;The number of items that should show up on one page
*)next_token : next_token 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 : directory_id;The identifier of the directory.
*)}type nonrec ldaps_setting_info = {last_updated_date_time : last_updated_date_time option;The date and time when the LDAPS settings were last updated.
*)ldaps_status_reason : ldaps_status_reason 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 ldaps_settings_info = ldaps_setting_info listtype nonrec ip_route = {description : description option;Description of the address block.
*)cidr_ip : cidr_ip 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.
type nonrec ip_routes = ip_route listtype nonrec ip_route_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
type nonrec ip_addrs = ip_addr listtype nonrec invalid_ldaps_status_exception = {request_id : request_id option;message : exception_message option;}The LDAP activities could not be performed because they are limited by the LDAPS status.
type nonrec invalid_client_auth_status_exception = {request_id : request_id option;message : exception_message option;}Client authentication is already enabled.
type nonrec insufficient_permissions_exception = {request_id : request_id option;message : exception_message option;}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.
type nonrec get_snapshot_limits_request = {directory_id : directory_id;Contains the identifier of the directory to obtain the limits for.
*)}Contains the inputs for the GetSnapshotLimits operation.
type nonrec directory_limits = {connected_directories_limit_reached : connected_directories_limit_reached
option;Indicates if the connected directory limit has been reached.
*)connected_directories_current_count : limit option;The current number of connected directories in the Region.
*)connected_directories_limit : limit option;The maximum number of connected directories allowed in the Region.
*)cloud_only_microsoft_ad_limit_reached : cloud_only_directories_limit_reached
option;Indicates if the Managed Microsoft AD directory limit has been reached.
*)cloud_only_microsoft_ad_current_count : limit option;The current number of Managed Microsoft AD directories in the region.
*)cloud_only_microsoft_ad_limit : limit option;The maximum number of Managed Microsoft AD directories allowed in the region.
*)cloud_only_directories_limit_reached : cloud_only_directories_limit_reached
option;Indicates if the cloud directory limit has been reached.
*)cloud_only_directories_current_count : limit option;The current number of cloud directories in the Region.
*)cloud_only_directories_limit : limit 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 : created_date_time option;The date and time of when you associated your directory with the Amazon SNS topic.
*)topic_arn : topic_arn option;The Amazon SNS topic ARN (Amazon Resource Name).
*)topic_name : topic_name option;The name of an Amazon SNS topic the receives status messages from the directory.
*)directory_id : directory_id 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.
type nonrec event_topics = event_topic listtype nonrec entity_already_exists_exception = {request_id : request_id option;message : exception_message option;}The specified entity already exists.
type nonrec enable_sso_request = {password : connect_password 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 : user_name 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 : directory_id;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 : request_id option;The identifier of the request that caused the exception.
*)message : exception_message 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 : directory_id;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 : directory_id;The identifier of the directory.
*)}type nonrec enable_directory_data_access_request = {directory_id : directory_id;The directory identifier.
*)}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 : directory_id;The identifier of the specified directory.
*)}type nonrec domain_controller = {status_last_updated_date_time : last_updated_date_time option;The date and time that the status was last updated.
*)launch_time : launch_time option;Specifies when the domain controller was created.
*)status_reason : domain_controller_status_reason option;A description of the domain controller state.
*)status : domain_controller_status option;The status of the domain controller.
*)availability_zone : availability_zone option;The Availability Zone where the domain controller is located.
*)subnet_id : subnet_id option;Identifier of the subnet in the VPC that contains the domain controller.
*)vpc_id : vpc_id option;The identifier of the VPC that contains the domain controller.
*)dns_ip_addr : ip_addr option;The IP address of the domain controller.
*)domain_controller_id : domain_controller_id option;Identifies a specific domain controller in the directory.
*)directory_id : directory_id option;Identifier of the directory where the domain controller resides.
*)}Contains information about the domain controllers for a specified directory.
type nonrec domain_controllers = domain_controller listtype nonrec domain_controller_ids = domain_controller_id listtype nonrec disable_sso_request = {password : connect_password 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 : user_name 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 : directory_id;The identifier of the directory for which to disable single-sign on.
*)}Contains the inputs for the DisableSso operation.
type nonrec disable_radius_request = {directory_id : directory_id;The identifier of the directory for which to disable MFA.
*)}Contains the inputs for the DisableRadius 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 : directory_id;The identifier of the directory.
*)}type nonrec disable_directory_data_access_request = {directory_id : directory_id;The directory identifier.
*)}type nonrec disable_client_authentication_request = {type_ : client_authentication_type;The type of client authentication to disable. Currently the only parameter "SmartCard" is supported.
directory_id : directory_id;The identifier of the directory
*)}type nonrec describe_update_directory_result = {next_token : next_token option;If not null, more results are available. Pass this value for the NextToken parameter.
update_activities : update_activities option;The list of update activities on a directory for the requested update type.
*)}type nonrec describe_update_directory_request = {next_token : next_token option;The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.
region_name : region_name option;The name of the Region.
*)update_type : update_type;The type of updates you want to describe for the directory.
*)directory_id : directory_id;The unique identifier of the directory.
*)}type nonrec describe_trusts_result = {next_token : next_token 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 : trusts 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 : limit option;The maximum number of objects to return.
*)next_token : next_token option;The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
trust_ids : trust_ids 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 : directory_id 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 : next_token option;If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
snapshots : snapshots 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 : limit option;The maximum number of objects to return.
*)next_token : next_token option;The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
snapshot_ids : snapshot_ids 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 : directory_id option;The identifier of the directory for which to retrieve snapshot information.
*)}Contains the inputs for the DescribeSnapshots operation.
type nonrec directory_ids = directory_id listtype nonrec describe_settings_result = {next_token : next_token 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_entries 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 : directory_id option;The identifier of the directory.
*)}type nonrec describe_settings_request = {next_token : next_token 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 : directory_id;The identifier of the directory for which to retrieve information.
*)}type nonrec describe_regions_result = {next_token : next_token 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 : regions_description option;List of Region information related to the directory for each replicated Region.
*)}type nonrec describe_regions_request = {next_token : next_token option;The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.
region_name : region_name option;The name of the Region. For example, us-east-1.
directory_id : directory_id;The identifier of the directory.
*)}type nonrec describe_ldaps_settings_result = {next_token : next_token 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_settings_info 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 : page_limit option;Specifies the number of items that should be displayed on one page.
*)next_token : next_token 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 : directory_id;The identifier of the directory.
*)}type nonrec describe_event_topics_result = {event_topics : event_topics 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 : topic_names 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 : directory_id 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 : next_token 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_controllers option;List of the DomainController objects that were retrieved.
}type nonrec describe_domain_controllers_request = {limit : limit option;The maximum number of items to return.
*)next_token : next_token option;The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
domain_controller_ids : domain_controller_ids option;A list of identifiers for the domain controllers whose information will be provided.
*)directory_id : directory_id;Identifier of the directory for which to retrieve the domain controller information.
*)}type nonrec describe_directory_data_access_result = {data_access_status : data_access_status option;The current status of data access through the Directory Service Data API.
*)}type nonrec describe_directory_data_access_request = {directory_id : directory_id;The directory identifier.
*)}type nonrec directory_connect_settings_description = {connect_ips : ip_addrs option;The IP addresses of the AD Connector servers.
*)availability_zones : availability_zones option;A list of the Availability Zones that the directory is in.
*)security_group_id : security_group_id option;The security group identifier for the AD Connector directory.
*)customer_user_name : user_name option;The user name of the service account in your self-managed directory.
*)subnet_ids : subnet_ids option;A list of subnet identifiers in the VPC that the AD Connector is in.
*)vpc_id : vpc_id 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 : desired_number_of_domain_controllers
option;The desired number of domain controllers in the directory if the directory is Microsoft AD.
*)sso_enabled : sso_enabled option;Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
stage_reason : stage_reason 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 type.
*)stage_last_updated_date_time : last_updated_date_time option;The date and time that the stage was last updated.
*)launch_time : launch_time option;Specifies when the directory was created.
*)stage : directory_stage option;The current stage of the directory.
*)dns_ip_addrs : dns_ip_addrs 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 : description option;The description for the directory.
*)access_url : access_url 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 : alias_name 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 : directory_short_name option;The short name of the directory.
*)name : directory_name option;The fully qualified name of the directory.
*)directory_id : directory_id option;The directory identifier.
*)}Contains information about an Directory Service directory.
type nonrec directory_descriptions = directory_description listtype nonrec describe_directories_result = {next_token : next_token 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_descriptions option;The list of available 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 : limit 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 : next_token option;The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
directory_ids : directory_ids 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 : dns_ip_addrs 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 : remote_domain_name 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 conditional_forwarders = conditional_forwarder listtype nonrec describe_conditional_forwarders_result = {conditional_forwarders : conditional_forwarders 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 : remote_domain_names 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 : directory_id;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 : last_updated_date_time 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 client_authentication_settings_info =
client_authentication_setting_info listtype nonrec describe_client_authentication_settings_result = {next_token : next_token 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_settings_info
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 : page_limit 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 : next_token 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 : directory_id;The identifier of the directory for which to retrieve information.
*)}type nonrec certificate_does_not_exist_exception = {request_id : request_id option;message : exception_message option;}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 : certificate_expiry_date_time option;The date and time when the certificate will expire.
*)registered_date_time : certificate_registered_date_time option;The date and time that the certificate was registered.
*)common_name : certificate_c_n option;The common name for the certificate.
*)state_reason : certificate_state_reason option;Describes a state change for the certificate.
*)state : certificate_state option;The state of the certificate.
*)certificate_id : certificate_id 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 describe_certificate_request = {certificate_id : certificate_id;The identifier of the certificate.
*)directory_id : directory_id;The identifier of the directory.
*)}type nonrec deregister_event_topic_request = {topic_name : topic_name;The name of the Amazon SNS topic from which to remove the directory as a publisher.
*)directory_id : directory_id;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.
type nonrec certificate_in_use_exception = {request_id : request_id option;message : exception_message option;}The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.
type nonrec deregister_certificate_request = {certificate_id : certificate_id;The identifier of the certificate.
*)directory_id : directory_id;The identifier of the directory.
*)}type nonrec delete_trust_result = {trust_id : trust_id option;The Trust ID of the trust relationship that was deleted.
*)}The result of a DeleteTrust request.
type nonrec delete_trust_request = {delete_associated_conditional_forwarder : delete_associated_conditional_forwarder
option;Delete a conditional forwarder as part of a DeleteTrustRequest.
*)trust_id : trust_id;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.
type nonrec delete_snapshot_result = {snapshot_id : snapshot_id option;The identifier of the directory snapshot that was deleted.
*)}Contains the results of the DeleteSnapshot operation.
type nonrec delete_snapshot_request = {snapshot_id : snapshot_id;The identifier of the directory snapshot to be deleted.
*)}Contains the inputs for the DeleteSnapshot operation.
type nonrec delete_log_subscription_request = {directory_id : directory_id;Identifier of the directory whose log subscription you want to delete.
*)}type nonrec delete_directory_result = {directory_id : directory_id option;The directory identifier.
*)}Contains the results of the DeleteDirectory operation.
type nonrec delete_directory_request = {directory_id : directory_id;The identifier of the directory to delete.
*)}Contains the inputs for the DeleteDirectory operation.
type nonrec delete_conditional_forwarder_request = {remote_domain_name : remote_domain_name;The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
*)directory_id : directory_id;The directory ID for which you are deleting the conditional forwarder.
*)}Deletes a conditional forwarder.
type nonrec create_trust_result = {trust_id : trust_id option;A unique identifier for the trust relationship that was created.
*)}The result of a CreateTrust request.
type nonrec create_trust_request = {selective_auth : selective_auth option;Optional parameter to enable selective authentication for the trust.
*)conditional_forwarder_ip_addrs : dns_ip_addrs 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 : trust_password;The trust password. The trust password must be the same password that was used when creating the trust relationship on the external domain.
*)remote_domain_name : remote_domain_name;The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
*)directory_id : directory_id;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_result = {snapshot_id : snapshot_id option;The identifier of the snapshot that was created.
*)}Contains the results of the CreateSnapshot operation.
type nonrec create_snapshot_request = {name : snapshot_name option;The descriptive name to apply to the snapshot.
*)directory_id : directory_id;The identifier of the directory of which to take a snapshot.
*)}Contains the inputs for the CreateSnapshot operation.
type nonrec directory_limit_exceeded_exception = {request_id : request_id option;message : exception_message option;}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_result = {directory_id : directory_id option;The identifier of the directory that was created.
*)}Result of a CreateMicrosoftAD request.
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 : description 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 : password;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 : directory_short_name 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 : directory_name;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 : log_group_name;The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
*)directory_id : directory_id;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_result = {directory_id : directory_id option;The identifier of the directory that was created.
*)}Contains the results of the CreateDirectory operation.
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 : description option;A description for the directory.
*)password : password;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 : directory_short_name option;The NetBIOS name of the directory, such as CORP.
name : directory_name;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 : dns_ip_addrs;The IP addresses of the remote DNS server associated with RemoteDomainName.
*)remote_domain_name : remote_domain_name;The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
*)directory_id : directory_id;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 : attribute_value option;The value of the attribute.
*)name : attribute_name option;The name of the attribute.
*)}Represents a named directory attribute.
type nonrec attributes = attribute listtype nonrec computer = {computer_attributes : attributes option;An array of Attribute objects containing the LDAP attributes that belong to the computer account.
computer_name : computer_name option;The computer name.
*)computer_id : si_d 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 : attributes option;An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
organizational_unit_distinguished_name : organizational_unit_d_n option;The fully-qualified distinguished name of the organizational unit to place the computer account in.
*)password : computer_password;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 : computer_name;The name of the computer account.
*)directory_id : directory_id;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 : alias_name option;The alias for the directory.
*)directory_id : directory_id option;The identifier of the directory.
*)}Contains the results of the CreateAlias operation.
type nonrec create_alias_request = {alias : alias_name;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 : directory_id;The identifier of the directory for which to create the alias.
*)}Contains the inputs for the CreateAlias operation.
type nonrec connect_directory_result = {directory_id : directory_id option;The identifier of the new directory.
*)}Contains the results of the ConnectDirectory operation.
type nonrec directory_connect_settings = {customer_user_name : user_name;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 : dns_ip_addrs;A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.
*)subnet_ids : subnet_ids;A list of subnet identifiers in the VPC in which the AD Connector is created.
*)vpc_id : vpc_id;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 : description option;A description for the directory.
*)password : connect_password;The password for your self-managed user account.
*)short_name : directory_short_name option;The NetBIOS name of your self-managed directory, such as CORP.
name : directory_name;The fully qualified name of your self-managed directory, such as corp.example.com.
}Contains the inputs for the ConnectDirectory operation.
type nonrec cancel_schema_extension_request = {schema_extension_id : schema_extension_id;The identifier of the schema extension that will be canceled.
*)directory_id : directory_id;The identifier of the directory whose schema extension will be canceled.
*)}type nonrec directory_already_in_region_exception = {request_id : request_id option;message : exception_message option;}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 : region_name;The name of the Region where you want to add domain controllers for replication. For example, us-east-1.
directory_id : directory_id;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 : update_security_group_for_directory_controllers
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_routes;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 : directory_id;Identifier (ID) of the directory to which to add the address block.
*)}