libZSservicesZSamazonka-dsZSamazonka-ds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectoryService.Lens

Contents

Description

 
Synopsis

Operations

ShareDirectory

shareDirectory_shareNotes :: Lens' ShareDirectory (Maybe Text) Source #

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

shareDirectory_directoryId :: Lens' ShareDirectory Text Source #

Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.

shareDirectory_shareTarget :: Lens' ShareDirectory ShareTarget Source #

Identifier for the directory consumer account with whom the directory is to be shared.

shareDirectory_shareMethod :: Lens' ShareDirectory ShareMethod Source #

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a directory sharing request (HANDSHAKE).

shareDirectoryResponse_sharedDirectoryId :: Lens' ShareDirectoryResponse (Maybe Text) Source #

Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).

UpdateNumberOfDomainControllers

updateNumberOfDomainControllers_directoryId :: Lens' UpdateNumberOfDomainControllers Text Source #

Identifier of the directory to which the domain controllers will be added or removed.

updateNumberOfDomainControllers_desiredNumber :: Lens' UpdateNumberOfDomainControllers Natural Source #

The number of domain controllers desired in the directory.

DescribeConditionalForwarders

describeConditionalForwarders_remoteDomainNames :: Lens' DescribeConditionalForwarders (Maybe [Text]) Source #

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.

describeConditionalForwarders_directoryId :: Lens' DescribeConditionalForwarders Text Source #

The directory ID for which to get the list of associated conditional forwarders.

GetSnapshotLimits

getSnapshotLimits_directoryId :: Lens' GetSnapshotLimits Text Source #

Contains the identifier of the directory to obtain the limits for.

getSnapshotLimitsResponse_snapshotLimits :: Lens' GetSnapshotLimitsResponse (Maybe SnapshotLimits) Source #

A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

RegisterEventTopic

registerEventTopic_directoryId :: Lens' RegisterEventTopic Text Source #

The Directory ID that will publish status messages to the Amazon SNS topic.

registerEventTopic_topicName :: Lens' RegisterEventTopic Text Source #

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.

RegisterCertificate

registerCertificate_clientCertAuthSettings :: Lens' RegisterCertificate (Maybe ClientCertAuthSettings) Source #

A ClientCertAuthSettings object that contains client certificate authentication settings.

registerCertificate_type :: Lens' RegisterCertificate (Maybe CertificateType) Source #

The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

registerCertificate_certificateData :: Lens' RegisterCertificate Text Source #

The certificate PEM string that needs to be registered.

ConnectDirectory

connectDirectory_shortName :: Lens' ConnectDirectory (Maybe Text) Source #

The NetBIOS name of your self-managed directory, such as CORP.

connectDirectory_tags :: Lens' ConnectDirectory (Maybe [Tag]) Source #

The tags to be assigned to AD Connector.

connectDirectory_name :: Lens' ConnectDirectory Text Source #

The fully qualified name of your self-managed directory, such as corp.example.com.

connectDirectory_password :: Lens' ConnectDirectory Text Source #

The password for your self-managed user account.

connectDirectory_connectSettings :: Lens' ConnectDirectory DirectoryConnectSettings Source #

A DirectoryConnectSettings object that contains additional information for the operation.

DescribeLDAPSSettings

describeLDAPSSettings_nextToken :: Lens' DescribeLDAPSSettings (Maybe Text) Source #

The type of next token used for pagination.

describeLDAPSSettings_limit :: Lens' DescribeLDAPSSettings (Maybe Natural) Source #

Specifies the number of items that should be displayed on one page.

describeLDAPSSettings_type :: Lens' DescribeLDAPSSettings (Maybe LDAPSType) Source #

The type of LDAP security to enable. Currently only the value Client is supported.

describeLDAPSSettingsResponse_lDAPSSettingsInfo :: Lens' DescribeLDAPSSettingsResponse (Maybe [LDAPSSettingInfo]) Source #

Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.

describeLDAPSSettingsResponse_nextToken :: Lens' DescribeLDAPSSettingsResponse (Maybe Text) Source #

The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.

CreateAlias

createAlias_directoryId :: Lens' CreateAlias Text Source #

The identifier of the directory for which to create the alias.

createAlias_alias :: Lens' CreateAlias Text Source #

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.

DescribeDirectories

describeDirectories_nextToken :: Lens' DescribeDirectories (Maybe Text) Source #

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

describeDirectories_directoryIds :: Lens' DescribeDirectories (Maybe [Text]) Source #

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.

describeDirectories_limit :: Lens' DescribeDirectories (Maybe Natural) Source #

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.

describeDirectoriesResponse_directoryDescriptions :: Lens' DescribeDirectoriesResponse (Maybe [DirectoryDescription]) Source #

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.

describeDirectoriesResponse_nextToken :: Lens' DescribeDirectoriesResponse (Maybe Text) Source #

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.

AddIpRoutes

addIpRoutes_updateSecurityGroupForDirectoryControllers :: Lens' AddIpRoutes (Maybe Bool) Source #

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:

  • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
  • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
  • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
  • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
  • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
  • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
  • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
  • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
  • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
  • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
  • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

Outbound:

  • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

These security rules impact an internal network interface that is not exposed publicly.

addIpRoutes_directoryId :: Lens' AddIpRoutes Text Source #

Identifier (ID) of the directory to which to add the address block.

addIpRoutes_ipRoutes :: Lens' AddIpRoutes [IpRoute] Source #

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.

ListTagsForResource

listTagsForResource_resourceId :: Lens' ListTagsForResource Text Source #

Identifier (ID) of the directory for which you want to retrieve tags.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

List of tags returned by the ListTagsForResource operation.

DescribeTrusts

describeTrusts_directoryId :: Lens' DescribeTrusts (Maybe Text) Source #

The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

describeTrusts_nextToken :: Lens' DescribeTrusts (Maybe Text) Source #

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

describeTrusts_trustIds :: Lens' DescribeTrusts (Maybe [Text]) Source #

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.

describeTrusts_limit :: Lens' DescribeTrusts (Maybe Natural) Source #

The maximum number of objects to return.

describeTrustsResponse_nextToken :: Lens' DescribeTrustsResponse (Maybe Text) Source #

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.

describeTrustsResponse_trusts :: Lens' DescribeTrustsResponse (Maybe [Trust]) Source #

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.

DeleteTrust

deleteTrust_deleteAssociatedConditionalForwarder :: Lens' DeleteTrust (Maybe Bool) Source #

Delete a conditional forwarder as part of a DeleteTrustRequest.

deleteTrust_trustId :: Lens' DeleteTrust Text Source #

The Trust ID of the trust relationship to be deleted.

deleteTrustResponse_trustId :: Lens' DeleteTrustResponse (Maybe Text) Source #

The Trust ID of the trust relationship that was deleted.

UpdateTrust

updateTrust_selectiveAuth :: Lens' UpdateTrust (Maybe SelectiveAuth) Source #

Updates selective authentication for the trust.

updateTrust_trustId :: Lens' UpdateTrust Text Source #

Identifier of the trust relationship.

updateTrustResponse_trustId :: Lens' UpdateTrustResponse (Maybe Text) Source #

Identifier of the trust relationship.

CreateMicrosoftAD

createMicrosoftAD_edition :: Lens' CreateMicrosoftAD (Maybe DirectoryEdition) Source #

Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

createMicrosoftAD_shortName :: Lens' CreateMicrosoftAD (Maybe Text) Source #

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.

createMicrosoftAD_description :: Lens' CreateMicrosoftAD (Maybe Text) Source #

A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.

createMicrosoftAD_tags :: Lens' CreateMicrosoftAD (Maybe [Tag]) Source #

The tags to be assigned to the Managed Microsoft AD directory.

createMicrosoftAD_name :: Lens' CreateMicrosoftAD Text Source #

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.

createMicrosoftAD_password :: Lens' CreateMicrosoftAD Text Source #

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.

createMicrosoftAD_vpcSettings :: Lens' CreateMicrosoftAD DirectoryVpcSettings Source #

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

createMicrosoftADResponse_directoryId :: Lens' CreateMicrosoftADResponse (Maybe Text) Source #

The identifier of the directory that was created.

DisableClientAuthentication

disableClientAuthentication_type :: Lens' DisableClientAuthentication ClientAuthenticationType Source #

The type of client authentication to disable. Currently, only the parameter, SmartCard is supported.

DeregisterEventTopic

deregisterEventTopic_directoryId :: Lens' DeregisterEventTopic Text Source #

The Directory ID to remove as a publisher. This directory will no longer send messages to the specified Amazon SNS topic.

deregisterEventTopic_topicName :: Lens' DeregisterEventTopic Text Source #

The name of the Amazon SNS topic from which to remove the directory as a publisher.

CreateDirectory

createDirectory_shortName :: Lens' CreateDirectory (Maybe Text) Source #

The NetBIOS name of the directory, such as CORP.

createDirectory_vpcSettings :: Lens' CreateDirectory (Maybe DirectoryVpcSettings) Source #

A DirectoryVpcSettings object that contains additional information for the operation.

createDirectory_description :: Lens' CreateDirectory (Maybe Text) Source #

A description for the directory.

createDirectory_tags :: Lens' CreateDirectory (Maybe [Tag]) Source #

The tags to be assigned to the Simple AD directory.

createDirectory_name :: Lens' CreateDirectory Text Source #

The fully qualified name for the directory, such as corp.example.com.

createDirectory_password :: Lens' CreateDirectory Text Source #

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:

  • Length (?=^.{8,64}$) – Must be between 8 and 64 characters

AND any 3 of the following password complexity rules required by Active Directory:

  • Numbers and upper case and lowercase (?=.*\d)(?=.*[A-Z])(?=.*[a-z])
  • Numbers and special characters and lower case (?=.*\d)(?=.*[^A-Za-z0-9\s])(?=.*[a-z])
  • Special characters and upper case and lower case (?=.*[^A-Za-z0-9\s])(?=.*[A-Z])(?=.*[a-z])
  • Numbers and upper case and special characters (?=.*\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\s])

For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

createDirectoryResponse_directoryId :: Lens' CreateDirectoryResponse (Maybe Text) Source #

The identifier of the directory that was created.

AcceptSharedDirectory

acceptSharedDirectory_sharedDirectoryId :: Lens' AcceptSharedDirectory Text Source #

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

CreateLogSubscription

createLogSubscription_directoryId :: Lens' CreateLogSubscription Text Source #

Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.

createLogSubscription_logGroupName :: Lens' CreateLogSubscription Text Source #

The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

RemoveTagsFromResource

removeTagsFromResource_resourceId :: Lens' RemoveTagsFromResource Text Source #

Identifier (ID) of the directory from which to remove the tag.

removeTagsFromResource_tagKeys :: Lens' RemoveTagsFromResource [Text] Source #

The tag key (name) of the tag to be removed.

DescribeEventTopics

describeEventTopics_directoryId :: Lens' DescribeEventTopics (Maybe Text) Source #

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.

describeEventTopics_topicNames :: Lens' DescribeEventTopics (Maybe [Text]) Source #

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.

describeEventTopicsResponse_eventTopics :: Lens' DescribeEventTopicsResponse (Maybe [EventTopic]) Source #

A list of Amazon SNS topic names that receive status messages from the specified Directory ID.

ResetUserPassword

resetUserPassword_directoryId :: Lens' ResetUserPassword Text Source #

Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.

resetUserPassword_userName :: Lens' ResetUserPassword Text Source #

The user name of the user whose password will be reset.

resetUserPassword_newPassword :: Lens' ResetUserPassword Text Source #

The new password that will be reset.

UpdateConditionalForwarder

updateConditionalForwarder_directoryId :: Lens' UpdateConditionalForwarder Text Source #

The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.

updateConditionalForwarder_remoteDomainName :: Lens' UpdateConditionalForwarder Text Source #

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

updateConditionalForwarder_dnsIpAddrs :: Lens' UpdateConditionalForwarder [Text] Source #

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

DeleteConditionalForwarder

deleteConditionalForwarder_directoryId :: Lens' DeleteConditionalForwarder Text Source #

The directory ID for which you are deleting the conditional forwarder.

deleteConditionalForwarder_remoteDomainName :: Lens' DeleteConditionalForwarder Text Source #

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

DisableLDAPS

disableLDAPS_directoryId :: Lens' DisableLDAPS Text Source #

The identifier of the directory.

disableLDAPS_type :: Lens' DisableLDAPS LDAPSType Source #

The type of LDAP security to enable. Currently only the value Client is supported.

DeleteLogSubscription

deleteLogSubscription_directoryId :: Lens' DeleteLogSubscription Text Source #

Identifier of the directory whose log subscription you want to delete.

EnableSso

enableSso_userName :: Lens' EnableSso (Maybe Text) Source #

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.

enableSso_password :: Lens' EnableSso (Maybe Text) Source #

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.

enableSso_directoryId :: Lens' EnableSso Text Source #

The identifier of the directory for which to enable single-sign on.

enableSsoResponse_httpStatus :: Lens' EnableSsoResponse Int Source #

The response's http status code.

CancelSchemaExtension

cancelSchemaExtension_directoryId :: Lens' CancelSchemaExtension Text Source #

The identifier of the directory whose schema extension will be canceled.

cancelSchemaExtension_schemaExtensionId :: Lens' CancelSchemaExtension Text Source #

The identifier of the schema extension that will be canceled.

ListLogSubscriptions

listLogSubscriptions_directoryId :: Lens' ListLogSubscriptions (Maybe Text) Source #

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.

listLogSubscriptions_nextToken :: Lens' ListLogSubscriptions (Maybe Text) Source #

The token for the next set of items to return.

listLogSubscriptions_limit :: Lens' ListLogSubscriptions (Maybe Natural) Source #

The maximum number of items returned.

listLogSubscriptionsResponse_logSubscriptions :: Lens' ListLogSubscriptionsResponse (Maybe [LogSubscription]) Source #

A list of active LogSubscription objects for calling the Amazon Web Services account.

EnableRadius

enableRadius_directoryId :: Lens' EnableRadius Text Source #

The identifier of the directory for which to enable MFA.

enableRadius_radiusSettings :: Lens' EnableRadius RadiusSettings Source #

A RadiusSettings object that contains information about the RADIUS server.

ListIpRoutes

listIpRoutes_nextToken :: Lens' ListIpRoutes (Maybe Text) Source #

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

listIpRoutes_limit :: Lens' ListIpRoutes (Maybe Natural) Source #

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

listIpRoutes_directoryId :: Lens' ListIpRoutes Text Source #

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

listIpRoutesResponse_nextToken :: Lens' ListIpRoutesResponse (Maybe Text) Source #

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.

AddTagsToResource

addTagsToResource_resourceId :: Lens' AddTagsToResource Text Source #

Identifier (ID) for the directory to which to add the tag.

addTagsToResource_tags :: Lens' AddTagsToResource [Tag] Source #

The tags to be assigned to the directory.

DescribeClientAuthenticationSettings

describeClientAuthenticationSettings_nextToken :: Lens' DescribeClientAuthenticationSettings (Maybe Text) Source #

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

describeClientAuthenticationSettings_limit :: Lens' DescribeClientAuthenticationSettings (Maybe Natural) Source #

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.

describeClientAuthenticationSettings_type :: Lens' DescribeClientAuthenticationSettings (Maybe ClientAuthenticationType) Source #

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.

describeClientAuthenticationSettings_directoryId :: Lens' DescribeClientAuthenticationSettings Text Source #

The identifier of the directory for which to retrieve information.

describeClientAuthenticationSettingsResponse_nextToken :: Lens' DescribeClientAuthenticationSettingsResponse (Maybe Text) Source #

The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

describeClientAuthenticationSettingsResponse_clientAuthenticationSettingsInfo :: Lens' DescribeClientAuthenticationSettingsResponse (Maybe [ClientAuthenticationSettingInfo]) Source #

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.

ListSchemaExtensions

listSchemaExtensions_nextToken :: Lens' ListSchemaExtensions (Maybe Text) Source #

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

listSchemaExtensions_limit :: Lens' ListSchemaExtensions (Maybe Natural) Source #

The maximum number of items to return.

listSchemaExtensions_directoryId :: Lens' ListSchemaExtensions Text Source #

The identifier of the directory from which to retrieve the schema extension information.

listSchemaExtensionsResponse_schemaExtensionsInfo :: Lens' ListSchemaExtensionsResponse (Maybe [SchemaExtensionInfo]) Source #

Information about the schema extensions applied to the directory.

listSchemaExtensionsResponse_nextToken :: Lens' ListSchemaExtensionsResponse (Maybe Text) Source #

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.

DisableRadius

disableRadius_directoryId :: Lens' DisableRadius Text Source #

The identifier of the directory for which to disable MFA.

ListCertificates

listCertificates_nextToken :: Lens' ListCertificates (Maybe Text) Source #

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.

listCertificates_limit :: Lens' ListCertificates (Maybe Natural) Source #

The number of items that should show up on one page

listCertificates_directoryId :: Lens' ListCertificates Text Source #

The identifier of the directory.

listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text) Source #

Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

listCertificatesResponse_certificatesInfo :: Lens' ListCertificatesResponse (Maybe [CertificateInfo]) Source #

A list of certificates with basic details including certificate ID, certificate common name, certificate state.

RejectSharedDirectory

rejectSharedDirectory_sharedDirectoryId :: Lens' RejectSharedDirectory Text Source #

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

rejectSharedDirectoryResponse_sharedDirectoryId :: Lens' RejectSharedDirectoryResponse (Maybe Text) Source #

Identifier of the shared directory in the directory consumer account.

UnshareDirectory

unshareDirectory_directoryId :: Lens' UnshareDirectory Text Source #

The identifier of the Managed Microsoft AD directory that you want to stop sharing.

unshareDirectory_unshareTarget :: Lens' UnshareDirectory UnshareTarget Source #

Identifier for the directory consumer account with whom the directory has to be unshared.

unshareDirectoryResponse_sharedDirectoryId :: Lens' UnshareDirectoryResponse (Maybe Text) Source #

Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).

RestoreFromSnapshot

restoreFromSnapshot_snapshotId :: Lens' RestoreFromSnapshot Text Source #

The identifier of the snapshot to restore from.

DescribeDomainControllers

describeDomainControllers_nextToken :: Lens' DescribeDomainControllers (Maybe Text) Source #

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

describeDomainControllers_domainControllerIds :: Lens' DescribeDomainControllers (Maybe [Text]) Source #

A list of identifiers for the domain controllers whose information will be provided.

describeDomainControllers_directoryId :: Lens' DescribeDomainControllers Text Source #

Identifier of the directory for which to retrieve the domain controller information.

describeDomainControllersResponse_nextToken :: Lens' DescribeDomainControllersResponse (Maybe Text) Source #

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.

DescribeSnapshots

describeSnapshots_directoryId :: Lens' DescribeSnapshots (Maybe Text) Source #

The identifier of the directory for which to retrieve snapshot information.

describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #

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

describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #

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.

describeSnapshots_limit :: Lens' DescribeSnapshots (Maybe Natural) Source #

The maximum number of objects to return.

describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #

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.

RemoveIpRoutes

removeIpRoutes_directoryId :: Lens' RemoveIpRoutes Text Source #

Identifier (ID) of the directory from which you want to remove the IP addresses.

removeIpRoutes_cidrIps :: Lens' RemoveIpRoutes [Text] Source #

IP address blocks that you want to remove.

DeleteSnapshot

deleteSnapshot_snapshotId :: Lens' DeleteSnapshot Text Source #

The identifier of the directory snapshot to be deleted.

deleteSnapshotResponse_snapshotId :: Lens' DeleteSnapshotResponse (Maybe Text) Source #

The identifier of the directory snapshot that was deleted.

DeregisterCertificate

StartSchemaExtension

startSchemaExtension_directoryId :: Lens' StartSchemaExtension Text Source #

The identifier of the directory for which the schema extension will be applied to.

startSchemaExtension_createSnapshotBeforeSchemaExtension :: Lens' StartSchemaExtension Bool Source #

If true, creates a snapshot of the directory before applying the schema extension.

startSchemaExtension_ldifContent :: Lens' StartSchemaExtension Text Source #

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.

startSchemaExtension_description :: Lens' StartSchemaExtension Text Source #

A description of the schema extension.

startSchemaExtensionResponse_schemaExtensionId :: Lens' StartSchemaExtensionResponse (Maybe Text) Source #

The identifier of the schema extension that will be applied.

CreateTrust

createTrust_conditionalForwarderIpAddrs :: Lens' CreateTrust (Maybe [Text]) Source #

The IP addresses of the remote DNS server associated with RemoteDomainName.

createTrust_trustType :: Lens' CreateTrust (Maybe TrustType) Source #

The trust relationship type. Forest is the default.

createTrust_selectiveAuth :: Lens' CreateTrust (Maybe SelectiveAuth) Source #

Optional parameter to enable selective authentication for the trust.

createTrust_directoryId :: Lens' CreateTrust Text Source #

The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.

createTrust_remoteDomainName :: Lens' CreateTrust Text Source #

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

createTrust_trustPassword :: Lens' CreateTrust Text Source #

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

createTrust_trustDirection :: Lens' CreateTrust TrustDirection Source #

The direction of the trust relationship.

createTrustResponse_trustId :: Lens' CreateTrustResponse (Maybe Text) Source #

A unique identifier for the trust relationship that was created.

DeleteDirectory

deleteDirectory_directoryId :: Lens' DeleteDirectory Text Source #

The identifier of the directory to delete.

CreateSnapshot

createSnapshot_name :: Lens' CreateSnapshot (Maybe Text) Source #

The descriptive name to apply to the snapshot.

createSnapshot_directoryId :: Lens' CreateSnapshot Text Source #

The identifier of the directory of which to take a snapshot.

createSnapshotResponse_snapshotId :: Lens' CreateSnapshotResponse (Maybe Text) Source #

The identifier of the snapshot that was created.

DescribeCertificate

describeCertificateResponse_certificate :: Lens' DescribeCertificateResponse (Maybe Certificate) Source #

Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.

EnableClientAuthentication

enableClientAuthentication_type :: Lens' EnableClientAuthentication ClientAuthenticationType Source #

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.

CreateComputer

createComputer_computerAttributes :: Lens' CreateComputer (Maybe [Attribute]) Source #

An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

createComputer_organizationalUnitDistinguishedName :: Lens' CreateComputer (Maybe Text) Source #

The fully-qualified distinguished name of the organizational unit to place the computer account in.

createComputer_directoryId :: Lens' CreateComputer Text Source #

The identifier of the directory in which to create the computer account.

createComputer_computerName :: Lens' CreateComputer Text Source #

The name of the computer account.

createComputer_password :: Lens' CreateComputer Text Source #

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.

createComputerResponse_computer :: Lens' CreateComputerResponse (Maybe Computer) Source #

A Computer object that represents the computer account.

DescribeSharedDirectories

describeSharedDirectories_sharedDirectoryIds :: Lens' DescribeSharedDirectories (Maybe [Text]) Source #

A list of identifiers of all shared directories in your account.

describeSharedDirectories_nextToken :: Lens' DescribeSharedDirectories (Maybe Text) Source #

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

describeSharedDirectories_limit :: Lens' DescribeSharedDirectories (Maybe Natural) Source #

The number of shared directories to return in the response object.

describeSharedDirectories_ownerDirectoryId :: Lens' DescribeSharedDirectories Text Source #

Returns the identifier of the directory in the directory owner account.

describeSharedDirectoriesResponse_nextToken :: Lens' DescribeSharedDirectoriesResponse (Maybe Text) Source #

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

EnableLDAPS

enableLDAPS_directoryId :: Lens' EnableLDAPS Text Source #

The identifier of the directory.

enableLDAPS_type :: Lens' EnableLDAPS LDAPSType Source #

The type of LDAP security to enable. Currently only the value Client is supported.

DisableSso

disableSso_userName :: Lens' DisableSso (Maybe Text) Source #

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.

disableSso_password :: Lens' DisableSso (Maybe Text) Source #

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.

disableSso_directoryId :: Lens' DisableSso Text Source #

The identifier of the directory for which to disable single-sign on.

VerifyTrust

verifyTrust_trustId :: Lens' VerifyTrust Text Source #

The unique Trust ID of the trust relationship to verify.

verifyTrustResponse_trustId :: Lens' VerifyTrustResponse (Maybe Text) Source #

The unique Trust ID of the trust relationship that was verified.

RemoveRegion

removeRegion_directoryId :: Lens' RemoveRegion Text Source #

The identifier of the directory for which you want to remove Region replication.

CreateConditionalForwarder

createConditionalForwarder_directoryId :: Lens' CreateConditionalForwarder Text Source #

The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.

createConditionalForwarder_remoteDomainName :: Lens' CreateConditionalForwarder Text Source #

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

createConditionalForwarder_dnsIpAddrs :: Lens' CreateConditionalForwarder [Text] Source #

The IP addresses of the remote DNS server associated with RemoteDomainName.

DescribeRegions

describeRegions_regionName :: Lens' DescribeRegions (Maybe Text) Source #

The name of the Region. For example, us-east-1.

describeRegions_nextToken :: Lens' DescribeRegions (Maybe Text) Source #

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

describeRegions_directoryId :: Lens' DescribeRegions Text Source #

The identifier of the directory.

describeRegionsResponse_nextToken :: Lens' DescribeRegionsResponse (Maybe Text) Source #

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.

describeRegionsResponse_regionsDescription :: Lens' DescribeRegionsResponse (Maybe [RegionDescription]) Source #

List of Region information related to the directory for each replicated Region.

AddRegion

addRegion_directoryId :: Lens' AddRegion Text Source #

The identifier of the directory to which you want to add Region replication.

addRegion_regionName :: Lens' AddRegion Text Source #

The name of the Region where you want to add domain controllers for replication. For example, us-east-1.

addRegionResponse_httpStatus :: Lens' AddRegionResponse Int Source #

The response's http status code.

GetDirectoryLimits

getDirectoryLimitsResponse_directoryLimits :: Lens' GetDirectoryLimitsResponse (Maybe DirectoryLimits) Source #

A DirectoryLimits object that contains the directory limits for the current Region.

UpdateRadius

updateRadius_directoryId :: Lens' UpdateRadius Text Source #

The identifier of the directory for which to update the RADIUS server information.

updateRadius_radiusSettings :: Lens' UpdateRadius RadiusSettings Source #

A RadiusSettings object that contains information about the RADIUS server.

Types

Attribute

attribute_value :: Lens' Attribute (Maybe Text) Source #

The value of the attribute.

attribute_name :: Lens' Attribute (Maybe Text) Source #

The name of the attribute.

Certificate

certificate_clientCertAuthSettings :: Lens' Certificate (Maybe ClientCertAuthSettings) Source #

A ClientCertAuthSettings object that contains client certificate authentication settings.

certificate_commonName :: Lens' Certificate (Maybe Text) Source #

The common name for the certificate.

certificate_certificateId :: Lens' Certificate (Maybe Text) Source #

The identifier of the certificate.

certificate_expiryDateTime :: Lens' Certificate (Maybe UTCTime) Source #

The date and time when the certificate will expire.

certificate_registeredDateTime :: Lens' Certificate (Maybe UTCTime) Source #

The date and time that the certificate was registered.

certificate_type :: Lens' Certificate (Maybe CertificateType) Source #

The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

certificate_stateReason :: Lens' Certificate (Maybe Text) Source #

Describes a state change for the certificate.

CertificateInfo

certificateInfo_commonName :: Lens' CertificateInfo (Maybe Text) Source #

The common name for the certificate.

certificateInfo_certificateId :: Lens' CertificateInfo (Maybe Text) Source #

The identifier of the certificate.

certificateInfo_expiryDateTime :: Lens' CertificateInfo (Maybe UTCTime) Source #

The date and time when the certificate will expire.

certificateInfo_type :: Lens' CertificateInfo (Maybe CertificateType) Source #

The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

ClientAuthenticationSettingInfo

clientAuthenticationSettingInfo_status :: Lens' ClientAuthenticationSettingInfo (Maybe ClientAuthenticationStatus) Source #

Whether the client authentication type is enabled or disabled for the specified directory.

clientAuthenticationSettingInfo_lastUpdatedDateTime :: Lens' ClientAuthenticationSettingInfo (Maybe UTCTime) Source #

The date and time when the status of the client authentication type was last updated.

clientAuthenticationSettingInfo_type :: Lens' ClientAuthenticationSettingInfo (Maybe ClientAuthenticationType) Source #

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.

ClientCertAuthSettings

clientCertAuthSettings_oCSPUrl :: Lens' ClientCertAuthSettings (Maybe Text) Source #

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.

Computer

computer_computerId :: Lens' Computer (Maybe Text) Source #

The identifier of the computer.

computer_computerAttributes :: Lens' Computer (Maybe [Attribute]) Source #

An array of Attribute objects containing the LDAP attributes that belong to the computer account.

ConditionalForwarder

conditionalForwarder_dnsIpAddrs :: Lens' ConditionalForwarder (Maybe [Text]) Source #

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.

conditionalForwarder_remoteDomainName :: Lens' ConditionalForwarder (Maybe Text) Source #

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

conditionalForwarder_replicationScope :: Lens' ConditionalForwarder (Maybe ReplicationScope) Source #

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.

DirectoryConnectSettings

directoryConnectSettings_vpcId :: Lens' DirectoryConnectSettings Text Source #

The identifier of the VPC in which the AD Connector is created.

directoryConnectSettings_subnetIds :: Lens' DirectoryConnectSettings [Text] Source #

A list of subnet identifiers in the VPC in which the AD Connector is created.

directoryConnectSettings_customerDnsIps :: Lens' DirectoryConnectSettings [Text] Source #

A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.

directoryConnectSettings_customerUserName :: Lens' DirectoryConnectSettings Text Source #

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:

  • Read users and groups
  • Create computer objects
  • Join computers to the domain

DirectoryConnectSettingsDescription

directoryConnectSettingsDescription_customerUserName :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #

The user name of the service account in your self-managed directory.

directoryConnectSettingsDescription_subnetIds :: Lens' DirectoryConnectSettingsDescription (Maybe [Text]) Source #

A list of subnet identifiers in the VPC that the AD Connector is in.

directoryConnectSettingsDescription_vpcId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #

The identifier of the VPC that the AD Connector is in.

directoryConnectSettingsDescription_securityGroupId :: Lens' DirectoryConnectSettingsDescription (Maybe Text) Source #

The security group identifier for the AD Connector directory.

DirectoryDescription

directoryDescription_edition :: Lens' DirectoryDescription (Maybe DirectoryEdition) Source #

The edition associated with this directory.

directoryDescription_radiusStatus :: Lens' DirectoryDescription (Maybe RadiusStatus) Source #

The status of the RADIUS MFA server connection.

directoryDescription_accessUrl :: Lens' DirectoryDescription (Maybe Text) Source #

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

directoryDescription_regionsInfo :: Lens' DirectoryDescription (Maybe RegionsInfo) Source #

Lists the Regions where the directory has replicated.

directoryDescription_desiredNumberOfDomainControllers :: Lens' DirectoryDescription (Maybe Natural) Source #

The desired number of domain controllers in the directory if the directory is Microsoft AD.

directoryDescription_radiusSettings :: Lens' DirectoryDescription (Maybe RadiusSettings) Source #

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

directoryDescription_launchTime :: Lens' DirectoryDescription (Maybe UTCTime) Source #

Specifies when the directory was created.

directoryDescription_alias :: Lens' DirectoryDescription (Maybe Text) Source #

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

directoryDescription_shareStatus :: Lens' DirectoryDescription (Maybe ShareStatus) Source #

Current directory status of the shared Managed Microsoft AD directory.

directoryDescription_name :: Lens' DirectoryDescription (Maybe Text) Source #

The fully qualified name of the directory.

directoryDescription_shareMethod :: Lens' DirectoryDescription (Maybe ShareMethod) Source #

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

directoryDescription_stageLastUpdatedDateTime :: Lens' DirectoryDescription (Maybe UTCTime) Source #

The date and time that the stage was last updated.

directoryDescription_ssoEnabled :: Lens' DirectoryDescription (Maybe Bool) Source #

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

directoryDescription_dnsIpAddrs :: Lens' DirectoryDescription (Maybe [Text]) Source #

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.

directoryDescription_vpcSettings :: Lens' DirectoryDescription (Maybe DirectoryVpcSettingsDescription) Source #

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.

directoryDescription_stageReason :: Lens' DirectoryDescription (Maybe Text) Source #

Additional information about the directory stage.

directoryDescription_connectSettings :: Lens' DirectoryDescription (Maybe DirectoryConnectSettingsDescription) Source #

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.

directoryDescription_ownerDirectoryDescription :: Lens' DirectoryDescription (Maybe OwnerDirectoryDescription) Source #

Describes the Managed Microsoft AD directory in the directory owner account.

directoryDescription_shareNotes :: Lens' DirectoryDescription (Maybe Text) Source #

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

DirectoryLimits

directoryLimits_connectedDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #

The current number of connected directories in the Region.

directoryLimits_cloudOnlyMicrosoftADLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #

Indicates if the Managed Microsoft AD directory limit has been reached.

directoryLimits_connectedDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source #

The maximum number of connected directories allowed in the Region.

directoryLimits_connectedDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #

Indicates if the connected directory limit has been reached.

directoryLimits_cloudOnlyMicrosoftADLimit :: Lens' DirectoryLimits (Maybe Natural) Source #

The maximum number of Managed Microsoft AD directories allowed in the region.

directoryLimits_cloudOnlyDirectoriesLimit :: Lens' DirectoryLimits (Maybe Natural) Source #

The maximum number of cloud directories allowed in the Region.

directoryLimits_cloudOnlyDirectoriesCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #

The current number of cloud directories in the Region.

directoryLimits_cloudOnlyDirectoriesLimitReached :: Lens' DirectoryLimits (Maybe Bool) Source #

Indicates if the cloud directory limit has been reached.

directoryLimits_cloudOnlyMicrosoftADCurrentCount :: Lens' DirectoryLimits (Maybe Natural) Source #

The current number of Managed Microsoft AD directories in the region.

DirectoryVpcSettings

directoryVpcSettings_vpcId :: Lens' DirectoryVpcSettings Text Source #

The identifier of the VPC in which to create the directory.

directoryVpcSettings_subnetIds :: Lens' DirectoryVpcSettings [Text] Source #

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.

DirectoryVpcSettingsDescription

directoryVpcSettingsDescription_subnetIds :: Lens' DirectoryVpcSettingsDescription (Maybe [Text]) Source #

The identifiers of the subnets for the directory servers.

directoryVpcSettingsDescription_vpcId :: Lens' DirectoryVpcSettingsDescription (Maybe Text) Source #

The identifier of the VPC that the directory is in.

directoryVpcSettingsDescription_securityGroupId :: Lens' DirectoryVpcSettingsDescription (Maybe Text) Source #

The domain controller security group identifier for the directory.

directoryVpcSettingsDescription_availabilityZones :: Lens' DirectoryVpcSettingsDescription (Maybe [Text]) Source #

The list of Availability Zones that the directory is in.

DomainController

domainController_directoryId :: Lens' DomainController (Maybe Text) Source #

Identifier of the directory where the domain controller resides.

domainController_vpcId :: Lens' DomainController (Maybe Text) Source #

The identifier of the VPC that contains the domain controller.

domainController_launchTime :: Lens' DomainController (Maybe UTCTime) Source #

Specifies when the domain controller was created.

domainController_subnetId :: Lens' DomainController (Maybe Text) Source #

Identifier of the subnet in the VPC that contains the domain controller.

domainController_availabilityZone :: Lens' DomainController (Maybe Text) Source #

The Availability Zone where the domain controller is located.

domainController_statusLastUpdatedDateTime :: Lens' DomainController (Maybe UTCTime) Source #

The date and time that the status was last updated.

domainController_statusReason :: Lens' DomainController (Maybe Text) Source #

A description of the domain controller state.

domainController_dnsIpAddr :: Lens' DomainController (Maybe Text) Source #

The IP address of the domain controller.

domainController_domainControllerId :: Lens' DomainController (Maybe Text) Source #

Identifies a specific domain controller in the directory.

EventTopic

eventTopic_status :: Lens' EventTopic (Maybe TopicStatus) Source #

The topic registration status.

eventTopic_directoryId :: Lens' EventTopic (Maybe Text) Source #

The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS topic.

eventTopic_topicName :: Lens' EventTopic (Maybe Text) Source #

The name of an Amazon SNS topic the receives status messages from the directory.

eventTopic_topicArn :: Lens' EventTopic (Maybe Text) Source #

The Amazon SNS topic ARN (Amazon Resource Name).

eventTopic_createdDateTime :: Lens' EventTopic (Maybe UTCTime) Source #

The date and time of when you associated your directory with the Amazon SNS topic.

IpRoute

ipRoute_cidrIp :: Lens' IpRoute (Maybe Text) Source #

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.

ipRoute_description :: Lens' IpRoute (Maybe Text) Source #

Description of the address block.

IpRouteInfo

ipRouteInfo_directoryId :: Lens' IpRouteInfo (Maybe Text) Source #

Identifier (ID) of the directory associated with the IP addresses.

ipRouteInfo_ipRouteStatusReason :: Lens' IpRouteInfo (Maybe Text) Source #

The reason for the IpRouteStatusMsg.

ipRouteInfo_addedDateTime :: Lens' IpRouteInfo (Maybe UTCTime) Source #

The date and time the address block was added to the directory.

ipRouteInfo_cidrIp :: Lens' IpRouteInfo (Maybe Text) Source #

IP address block in the IpRoute.

ipRouteInfo_description :: Lens' IpRouteInfo (Maybe Text) Source #

Description of the IpRouteInfo.

LDAPSSettingInfo

lDAPSSettingInfo_lastUpdatedDateTime :: Lens' LDAPSSettingInfo (Maybe UTCTime) Source #

The date and time when the LDAPS settings were last updated.

LogSubscription

logSubscription_directoryId :: Lens' LogSubscription (Maybe Text) Source #

Identifier (ID) of the directory that you want to associate with the log subscription.

logSubscription_subscriptionCreatedDateTime :: Lens' LogSubscription (Maybe UTCTime) Source #

The date and time that the log subscription was created.

OwnerDirectoryDescription

ownerDirectoryDescription_directoryId :: Lens' OwnerDirectoryDescription (Maybe Text) Source #

Identifier of the Managed Microsoft AD directory in the directory owner account.

ownerDirectoryDescription_radiusSettings :: Lens' OwnerDirectoryDescription (Maybe RadiusSettings) Source #

A RadiusSettings object that contains information about the RADIUS server.

ownerDirectoryDescription_dnsIpAddrs :: Lens' OwnerDirectoryDescription (Maybe [Text]) Source #

IP address of the directory’s domain controllers.

RadiusSettings

radiusSettings_radiusRetries :: Lens' RadiusSettings (Maybe Natural) Source #

The maximum number of times that communication with the RADIUS server is attempted.

radiusSettings_radiusServers :: Lens' RadiusSettings (Maybe [Text]) Source #

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.

radiusSettings_sharedSecret :: Lens' RadiusSettings (Maybe Text) Source #

Required for enabling RADIUS on the directory.

radiusSettings_radiusTimeout :: Lens' RadiusSettings (Maybe Natural) Source #

The amount of time, in seconds, to wait for the RADIUS server to respond.

radiusSettings_radiusPort :: Lens' RadiusSettings (Maybe Natural) Source #

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.

RegionDescription

regionDescription_status :: Lens' RegionDescription (Maybe DirectoryStage) Source #

The status of the replication process for the specified Region.

regionDescription_regionName :: Lens' RegionDescription (Maybe Text) Source #

The name of the Region. For example, us-east-1.

regionDescription_desiredNumberOfDomainControllers :: Lens' RegionDescription (Maybe Natural) Source #

The desired number of domain controllers in the specified Region for the specified directory.

regionDescription_regionType :: Lens' RegionDescription (Maybe RegionType) Source #

Specifies whether the Region is the primary Region or an additional Region.

regionDescription_launchTime :: Lens' RegionDescription (Maybe UTCTime) Source #

Specifies when the Region replication began.

regionDescription_lastUpdatedDateTime :: Lens' RegionDescription (Maybe UTCTime) Source #

The date and time that the Region description was last updated.

regionDescription_statusLastUpdatedDateTime :: Lens' RegionDescription (Maybe UTCTime) Source #

The date and time that the Region status was last updated.

RegionsInfo

regionsInfo_primaryRegion :: Lens' RegionsInfo (Maybe Text) Source #

The Region where the Managed Microsoft AD directory was originally created.

regionsInfo_additionalRegions :: Lens' RegionsInfo (Maybe [Text]) Source #

Lists the Regions where the directory has been replicated, excluding the primary Region.

SchemaExtensionInfo

schemaExtensionInfo_directoryId :: Lens' SchemaExtensionInfo (Maybe Text) Source #

The identifier of the directory to which the schema extension is applied.

schemaExtensionInfo_description :: Lens' SchemaExtensionInfo (Maybe Text) Source #

A description of the schema extension.

schemaExtensionInfo_endDateTime :: Lens' SchemaExtensionInfo (Maybe UTCTime) Source #

The date and time that the schema extension was completed.

schemaExtensionInfo_startDateTime :: Lens' SchemaExtensionInfo (Maybe UTCTime) Source #

The date and time that the schema extension started being applied to the directory.

ShareTarget

shareTarget_id :: Lens' ShareTarget Text Source #

Identifier of the directory consumer account.

shareTarget_type :: Lens' ShareTarget TargetType Source #

Type of identifier to be used in the Id field.

SharedDirectory

sharedDirectory_sharedAccountId :: Lens' SharedDirectory (Maybe Text) Source #

Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.

sharedDirectory_ownerAccountId :: Lens' SharedDirectory (Maybe Text) Source #

Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

sharedDirectory_lastUpdatedDateTime :: Lens' SharedDirectory (Maybe UTCTime) Source #

The date and time that the shared directory was last updated.

sharedDirectory_shareStatus :: Lens' SharedDirectory (Maybe ShareStatus) Source #

Current directory status of the shared Managed Microsoft AD directory.

sharedDirectory_shareMethod :: Lens' SharedDirectory (Maybe ShareMethod) Source #

The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (ORGANIZATIONS) or with any Amazon Web Services account by sending a shared directory request (HANDSHAKE).

sharedDirectory_ownerDirectoryId :: Lens' SharedDirectory (Maybe Text) Source #

Identifier of the directory in the directory owner account.

sharedDirectory_sharedDirectoryId :: Lens' SharedDirectory (Maybe Text) Source #

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

sharedDirectory_shareNotes :: Lens' SharedDirectory (Maybe Text) Source #

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

sharedDirectory_createdDateTime :: Lens' SharedDirectory (Maybe UTCTime) Source #

The date and time that the shared directory was created.

Snapshot

snapshot_directoryId :: Lens' Snapshot (Maybe Text) Source #

The directory identifier.

snapshot_startTime :: Lens' Snapshot (Maybe UTCTime) Source #

The date and time that the snapshot was taken.

snapshot_name :: Lens' Snapshot (Maybe Text) Source #

The descriptive name of the snapshot.

snapshot_snapshotId :: Lens' Snapshot (Maybe Text) Source #

The snapshot identifier.

SnapshotLimits

snapshotLimits_manualSnapshotsLimitReached :: Lens' SnapshotLimits (Maybe Bool) Source #

Indicates if the manual snapshot limit has been reached.

snapshotLimits_manualSnapshotsCurrentCount :: Lens' SnapshotLimits (Maybe Natural) Source #

The current number of manual snapshots of the directory.

snapshotLimits_manualSnapshotsLimit :: Lens' SnapshotLimits (Maybe Natural) Source #

The maximum number of manual snapshots allowed.

Tag

tag_key :: Lens' Tag Text Source #

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}_.:/=+\\-]*)$").

tag_value :: Lens' Tag Text Source #

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}_.:/=+\\-]*)$").

Trust

trust_directoryId :: Lens' Trust (Maybe Text) Source #

The Directory ID of the Amazon Web Services directory involved in the trust relationship.

trust_trustState :: Lens' Trust (Maybe TrustState) Source #

The trust relationship state.

trust_lastUpdatedDateTime :: Lens' Trust (Maybe UTCTime) Source #

The date and time that the trust relationship was last updated.

trust_trustDirection :: Lens' Trust (Maybe TrustDirection) Source #

The trust relationship direction.

trust_stateLastUpdatedDateTime :: Lens' Trust (Maybe UTCTime) Source #

The date and time that the TrustState was last updated.

trust_trustType :: Lens' Trust (Maybe TrustType) Source #

The trust relationship type. Forest is the default.

trust_trustStateReason :: Lens' Trust (Maybe Text) Source #

The reason for the TrustState.

trust_selectiveAuth :: Lens' Trust (Maybe SelectiveAuth) Source #

Current state of selective authentication for the trust.

trust_remoteDomainName :: Lens' Trust (Maybe Text) Source #

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

trust_trustId :: Lens' Trust (Maybe Text) Source #

The unique ID of the trust relationship.

trust_createdDateTime :: Lens' Trust (Maybe UTCTime) Source #

The date and time that the trust relationship was created.

UnshareTarget

unshareTarget_id :: Lens' UnshareTarget Text Source #

Identifier of the directory consumer account.

unshareTarget_type :: Lens' UnshareTarget TargetType Source #

Type of identifier to be used in the Id field.