Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
Accepts a directory sharing request that was sent from the directory owner account.
', 'AddIpRoutes' => 'If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
', 'AddRegion' => 'Adds two domain controllers in the specified Region for the specified directory.
', 'AddTagsToResource' => 'Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
', 'CancelSchemaExtension' => 'Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
Creates an Active Directory computer object in the specified directory.
', 'CreateConditionalForwarder' => 'Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
', 'CreateDirectory' => 'Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
', 'CreateMicrosoftAD' => 'Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
', 'CreateSnapshot' => 'Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
You cannot take snapshots of AD Connector directories.
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. You can create either a forest trust or an external trust.
', 'DeleteConditionalForwarder' => 'Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
', 'DeleteDirectory' => 'Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
Deletes the specified log subscription.
', 'DeleteSnapshot' => 'Deletes a directory snapshot.
', 'DeleteTrust' => 'Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
', 'DeregisterCertificate' => 'Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
', 'DeregisterEventTopic' => 'Removes the specified directory as a publisher to the specified Amazon SNS topic.
', 'DescribeCertificate' => 'Displays information about the certificate registered for secure LDAP or client certificate authentication.
', 'DescribeClientAuthenticationSettings' => 'Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
', 'DescribeDirectories' => 'Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
Provides information about any domain controllers in your directory.
', 'DescribeEventTopics' => 'Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
', 'DescribeLDAPSSettings' => 'Describes the status of LDAP security for the specified directory.
', 'DescribeRegions' => 'Provides information about the Regions that are configured for multi-Region replication.
', 'DescribeSettings' => 'Retrieves information about the configurable settings for the specified directory.
', 'DescribeSharedDirectories' => 'Returns the shared directories in your account.
', 'DescribeSnapshots' => 'Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
', 'DescribeTrusts' => 'Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
', 'DescribeUpdateDirectory' => 'Describes the updates of a directory for a particular update type.
', 'DisableClientAuthentication' => 'Disables alternative client authentication methods for the specified directory.
', 'DisableLDAPS' => 'Deactivates LDAP secure calls for the specified directory.
', 'DisableRadius' => 'Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
', 'DisableSso' => 'Disables single-sign on for a directory.
', 'EnableClientAuthentication' => 'Enables alternative client authentication methods for the specified directory.
', 'EnableLDAPS' => 'Activates the switch for the specific directory to always use LDAP secure calls.
', 'EnableRadius' => 'Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
', 'EnableSso' => 'Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
', 'GetDirectoryLimits' => 'Obtains directory limit information for the current Region.
', 'GetSnapshotLimits' => 'Obtains the manual snapshot limits for a directory.
', 'ListCertificates' => 'For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
', 'ListIpRoutes' => 'Lists the address blocks that you have added to a directory.
', 'ListLogSubscriptions' => 'Lists the active log subscriptions for the Amazon Web Services account.
', 'ListSchemaExtensions' => 'Lists all schema extensions applied to a Microsoft AD Directory.
', 'ListTagsForResource' => 'Lists all tags on a directory.
', 'RegisterCertificate' => 'Registers a certificate for a secure LDAP or client certificate authentication.
', 'RegisterEventTopic' => 'Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
', 'RejectSharedDirectory' => 'Rejects a directory sharing request that was sent from the directory owner account.
', 'RemoveIpRoutes' => 'Removes IP address blocks from a directory.
', 'RemoveRegion' => 'Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the DeleteDirectory API.
Removes tags from a directory.
', 'ResetUserPassword' => 'Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.
Shares a specified directory (DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). With this operation you can use your directory from any Amazon Web Services account and from any Amazon VPC within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (ORGANIZATIONS). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.
Applies a schema extension to a Microsoft AD directory.
', 'UnshareDirectory' => 'Stops the directory sharing between the directory owner and consumer accounts.
', 'UpdateConditionalForwarder' => 'Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
', 'UpdateDirectorySetup' => 'Updates the directory for a particular update type.
', 'UpdateNumberOfDomainControllers' => 'Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
', 'UpdateRadius' => 'Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
', 'UpdateSettings' => 'Updates the configurable settings for the specified directory.
', 'UpdateTrust' => 'Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
', 'VerifyTrust' => 'Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
', ], 'shapes' => [ 'AcceptSharedDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptSharedDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => 'Client authentication is not available in this region at this time.
', 'refs' => [], ], 'AccessUrl' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$AccessUrl' => '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.
The date and time the address block was added to the directory.
', ], ], 'AdditionalRegions' => [ 'base' => NULL, 'refs' => [ 'RegionsInfo$AdditionalRegions' => 'Lists the Regions where the directory has been replicated, excluding the primary Region.
', ], ], 'AliasName' => [ 'base' => NULL, 'refs' => [ 'CreateAliasRequest$Alias' => '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.
The alias for the directory.
', 'DirectoryDescription$Alias' => 'The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.
Represents a named directory attribute.
', 'refs' => [ 'Attributes$member' => NULL, ], ], 'AttributeName' => [ 'base' => NULL, 'refs' => [ 'Attribute$Name' => 'The name of the attribute.
', ], ], 'AttributeValue' => [ 'base' => NULL, 'refs' => [ 'Attribute$Value' => 'The value of the attribute.
', ], ], 'Attributes' => [ 'base' => NULL, 'refs' => [ 'Computer$ComputerAttributes' => 'An array of Attribute objects containing the LDAP attributes that belong to the computer account.
', 'CreateComputerRequest$ComputerAttributes' => 'An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
', ], ], 'AuthenticationFailedException' => [ 'base' => 'An authentication error occurred.
', 'refs' => [], ], 'AvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'AvailabilityZones$member' => NULL, 'DomainController$AvailabilityZone' => 'The Availability Zone where the domain controller is located.
', ], ], 'AvailabilityZones' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettingsDescription$AvailabilityZones' => 'A list of the Availability Zones that the directory is in.
', 'DirectoryVpcSettingsDescription$AvailabilityZones' => 'The list of Availability Zones that the directory is in.
', ], ], 'CancelSchemaExtensionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CancelSchemaExtensionResult' => [ 'base' => NULL, 'refs' => [], ], 'Certificate' => [ 'base' => 'Information about the certificate.
', 'refs' => [ 'DescribeCertificateResult$Certificate' => 'Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.
', ], ], 'CertificateAlreadyExistsException' => [ 'base' => 'The certificate has already been registered into the system.
', 'refs' => [], ], 'CertificateCN' => [ 'base' => NULL, 'refs' => [ 'Certificate$CommonName' => 'The common name for the certificate.
', 'CertificateInfo$CommonName' => 'The common name for the certificate.
', ], ], 'CertificateData' => [ 'base' => NULL, 'refs' => [ 'RegisterCertificateRequest$CertificateData' => 'The certificate PEM string that needs to be registered.
', ], ], 'CertificateDoesNotExistException' => [ 'base' => 'The certificate is not present in the system for describe or deregister activities.
', 'refs' => [], ], 'CertificateExpiryDateTime' => [ 'base' => NULL, 'refs' => [ 'Certificate$ExpiryDateTime' => 'The date and time when the certificate will expire.
', 'CertificateInfo$ExpiryDateTime' => 'The date and time when the certificate will expire.
', ], ], 'CertificateId' => [ 'base' => NULL, 'refs' => [ 'Certificate$CertificateId' => 'The identifier of the certificate.
', 'CertificateInfo$CertificateId' => 'The identifier of the certificate.
', 'DeregisterCertificateRequest$CertificateId' => 'The identifier of the certificate.
', 'DescribeCertificateRequest$CertificateId' => 'The identifier of the certificate.
', 'RegisterCertificateResult$CertificateId' => 'The identifier of the certificate.
', ], ], 'CertificateInUseException' => [ 'base' => 'The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.
', 'refs' => [], ], 'CertificateInfo' => [ 'base' => 'Contains general information about a certificate.
', 'refs' => [ 'CertificatesInfo$member' => NULL, ], ], 'CertificateLimitExceededException' => [ 'base' => 'The certificate could not be added because the certificate limit has been reached.
', 'refs' => [], ], 'CertificateRegisteredDateTime' => [ 'base' => NULL, 'refs' => [ 'Certificate$RegisteredDateTime' => 'The date and time that the certificate was registered.
', ], ], 'CertificateState' => [ 'base' => NULL, 'refs' => [ 'Certificate$State' => 'The state of the certificate.
', 'CertificateInfo$State' => 'The state of the certificate.
', ], ], 'CertificateStateReason' => [ 'base' => NULL, 'refs' => [ 'Certificate$StateReason' => 'Describes a state change for the certificate.
', ], ], 'CertificateType' => [ 'base' => NULL, 'refs' => [ 'Certificate$Type' => 'The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.
A list of certificates with basic details including certificate ID, certificate common name, certificate state.
', ], ], 'CidrIp' => [ 'base' => NULL, 'refs' => [ 'CidrIps$member' => NULL, 'IpRoute$CidrIp' => '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.
', 'IpRouteInfo$CidrIp' => 'IP address block in the IpRoute.
', ], ], 'CidrIps' => [ 'base' => NULL, 'refs' => [ 'RemoveIpRoutesRequest$CidrIps' => 'IP address blocks that you want to remove.
', ], ], 'ClientAuthenticationSettingInfo' => [ 'base' => 'Contains information about a client authentication method for a directory.
', 'refs' => [ 'ClientAuthenticationSettingsInfo$member' => NULL, ], ], 'ClientAuthenticationSettingsInfo' => [ 'base' => NULL, 'refs' => [ 'DescribeClientAuthenticationSettingsResult$ClientAuthenticationSettingsInfo' => '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.
', ], ], 'ClientAuthenticationStatus' => [ 'base' => NULL, 'refs' => [ 'ClientAuthenticationSettingInfo$Status' => 'Whether the client authentication type is enabled or disabled for the specified directory.
', ], ], 'ClientAuthenticationType' => [ 'base' => NULL, 'refs' => [ 'ClientAuthenticationSettingInfo$Type' => '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.
', 'DescribeClientAuthenticationSettingsRequest$Type' => '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.
', 'DisableClientAuthenticationRequest$Type' => 'The type of client authentication to disable. Currently, only the parameter, SmartCard is supported.
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.
Contains information about the client certificate authentication settings for the RegisterCertificate and DescribeCertificate operations.
A ClientCertAuthSettings object that contains client certificate authentication settings.
A ClientCertAuthSettings object that contains client certificate authentication settings.
A client exception has occurred.
', 'refs' => [], ], 'CloudOnlyDirectoriesLimitReached' => [ 'base' => NULL, 'refs' => [ 'DirectoryLimits$CloudOnlyDirectoriesLimitReached' => 'Indicates if the cloud directory limit has been reached.
', 'DirectoryLimits$CloudOnlyMicrosoftADLimitReached' => 'Indicates if the Managed Microsoft AD directory limit has been reached.
', ], ], 'Computer' => [ 'base' => 'Contains information about a computer account in a directory.
', 'refs' => [ 'CreateComputerResult$Computer' => 'A Computer object that represents the computer account.
', ], ], 'ComputerName' => [ 'base' => NULL, 'refs' => [ 'Computer$ComputerName' => 'The computer name.
', 'CreateComputerRequest$ComputerName' => 'The name of the computer account.
', ], ], 'ComputerPassword' => [ 'base' => NULL, 'refs' => [ 'CreateComputerRequest$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.
', ], ], 'ConditionalForwarder' => [ 'base' => '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.
', 'refs' => [ 'ConditionalForwarders$member' => NULL, ], ], 'ConditionalForwarders' => [ 'base' => NULL, 'refs' => [ 'DescribeConditionalForwardersResult$ConditionalForwarders' => 'The list of conditional forwarders that have been created.
', ], ], 'ConnectDirectoryRequest' => [ 'base' => 'Contains the inputs for the ConnectDirectory operation.
', 'refs' => [], ], 'ConnectDirectoryResult' => [ 'base' => 'Contains the results of the ConnectDirectory operation.
', 'refs' => [], ], 'ConnectPassword' => [ 'base' => NULL, 'refs' => [ 'ConnectDirectoryRequest$Password' => 'The password for your self-managed user account.
', 'DisableSsoRequest$Password' => '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.
', 'EnableSsoRequest$Password' => '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.
', ], ], 'ConnectedDirectoriesLimitReached' => [ 'base' => NULL, 'refs' => [ 'DirectoryLimits$ConnectedDirectoriesLimitReached' => 'Indicates if the connected directory limit has been reached.
', ], ], 'CreateAliasRequest' => [ 'base' => 'Contains the inputs for the CreateAlias operation.
', 'refs' => [], ], 'CreateAliasResult' => [ 'base' => 'Contains the results of the CreateAlias operation.
', 'refs' => [], ], 'CreateComputerRequest' => [ 'base' => 'Contains the inputs for the CreateComputer operation.
', 'refs' => [], ], 'CreateComputerResult' => [ 'base' => 'Contains the results for the CreateComputer operation.
', 'refs' => [], ], 'CreateConditionalForwarderRequest' => [ 'base' => '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.
', 'refs' => [], ], 'CreateConditionalForwarderResult' => [ 'base' => 'The result of a CreateConditinalForwarder request.
', 'refs' => [], ], 'CreateDirectoryRequest' => [ 'base' => 'Contains the inputs for the CreateDirectory operation.
', 'refs' => [], ], 'CreateDirectoryResult' => [ 'base' => 'Contains the results of the CreateDirectory operation.
', 'refs' => [], ], 'CreateLogSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLogSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateMicrosoftADRequest' => [ 'base' => 'Creates an Managed Microsoft AD directory.
', 'refs' => [], ], 'CreateMicrosoftADResult' => [ 'base' => 'Result of a CreateMicrosoftAD request.
', 'refs' => [], ], 'CreateSnapshotBeforeSchemaExtension' => [ 'base' => NULL, 'refs' => [ 'StartSchemaExtensionRequest$CreateSnapshotBeforeSchemaExtension' => 'If true, creates a snapshot of the directory before applying the schema extension.
', ], ], 'CreateSnapshotBeforeUpdate' => [ 'base' => NULL, 'refs' => [ 'UpdateDirectorySetupRequest$CreateSnapshotBeforeUpdate' => 'The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.
', ], ], 'CreateSnapshotRequest' => [ 'base' => 'Contains the inputs for the CreateSnapshot operation.
', 'refs' => [], ], 'CreateSnapshotResult' => [ 'base' => 'Contains the results of the CreateSnapshot operation.
', 'refs' => [], ], 'CreateTrustRequest' => [ 'base' => '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.
', 'refs' => [], ], 'CreateTrustResult' => [ 'base' => 'The result of a CreateTrust request.
', 'refs' => [], ], 'CreatedDateTime' => [ 'base' => NULL, 'refs' => [ 'EventTopic$CreatedDateTime' => 'The date and time of when you associated your directory with the Amazon SNS topic.
', 'SharedDirectory$CreatedDateTime' => 'The date and time that the shared directory was created.
', 'Trust$CreatedDateTime' => 'The date and time that the trust relationship was created.
', ], ], 'CustomerId' => [ 'base' => NULL, 'refs' => [ 'OwnerDirectoryDescription$AccountId' => 'Identifier of the directory owner account.
', 'SharedDirectory$OwnerAccountId' => 'Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.
', 'SharedDirectory$SharedAccountId' => 'Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.
The user name of the user whose password will be reset.
', ], ], 'DeleteAssociatedConditionalForwarder' => [ 'base' => NULL, 'refs' => [ 'DeleteTrustRequest$DeleteAssociatedConditionalForwarder' => 'Delete a conditional forwarder as part of a DeleteTrustRequest.
', ], ], 'DeleteConditionalForwarderRequest' => [ 'base' => 'Deletes a conditional forwarder.
', 'refs' => [], ], 'DeleteConditionalForwarderResult' => [ 'base' => 'The result of a DeleteConditionalForwarder request.
', 'refs' => [], ], 'DeleteDirectoryRequest' => [ 'base' => 'Contains the inputs for the DeleteDirectory operation.
', 'refs' => [], ], 'DeleteDirectoryResult' => [ 'base' => 'Contains the results of the DeleteDirectory operation.
', 'refs' => [], ], 'DeleteLogSubscriptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLogSubscriptionResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSnapshotRequest' => [ 'base' => 'Contains the inputs for the DeleteSnapshot operation.
', 'refs' => [], ], 'DeleteSnapshotResult' => [ 'base' => 'Contains the results of the DeleteSnapshot operation.
', 'refs' => [], ], 'DeleteTrustRequest' => [ 'base' => 'Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and the external domain.
', 'refs' => [], ], 'DeleteTrustResult' => [ 'base' => 'The result of a DeleteTrust request.
', 'refs' => [], ], 'DeregisterCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterEventTopicRequest' => [ 'base' => 'Removes the specified directory as a publisher to the specified Amazon SNS topic.
', 'refs' => [], ], 'DeregisterEventTopicResult' => [ 'base' => 'The result of a DeregisterEventTopic request.
', 'refs' => [], ], 'DescribeCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClientAuthenticationSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeClientAuthenticationSettingsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConditionalForwardersRequest' => [ 'base' => 'Describes a conditional forwarder.
', 'refs' => [], ], 'DescribeConditionalForwardersResult' => [ 'base' => 'The result of a DescribeConditionalForwarder request.
', 'refs' => [], ], 'DescribeDirectoriesRequest' => [ 'base' => 'Contains the inputs for the DescribeDirectories operation.
', 'refs' => [], ], 'DescribeDirectoriesResult' => [ 'base' => 'Contains the results of the DescribeDirectories operation.
', 'refs' => [], ], 'DescribeDomainControllersRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDomainControllersResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeEventTopicsRequest' => [ 'base' => 'Describes event topics.
', 'refs' => [], ], 'DescribeEventTopicsResult' => [ 'base' => 'The result of a DescribeEventTopic request.
', 'refs' => [], ], 'DescribeLDAPSSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLDAPSSettingsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRegionsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSettingsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSharedDirectoriesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSharedDirectoriesResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeSnapshotsRequest' => [ 'base' => 'Contains the inputs for the DescribeSnapshots operation.
', 'refs' => [], ], 'DescribeSnapshotsResult' => [ 'base' => 'Contains the results of the DescribeSnapshots operation.
', 'refs' => [], ], 'DescribeTrustsRequest' => [ 'base' => '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.
', 'refs' => [], ], 'DescribeTrustsResult' => [ 'base' => 'The result of a DescribeTrust request.
', 'refs' => [], ], 'DescribeUpdateDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeUpdateDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'ConnectDirectoryRequest$Description' => 'A description for the directory.
', 'CreateDirectoryRequest$Description' => 'A description for the directory.
', 'CreateMicrosoftADRequest$Description' => 'A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.
The description for the directory.
', 'IpRoute$Description' => 'Description of the address block.
', 'IpRouteInfo$Description' => 'Description of the IpRouteInfo.
', 'SchemaExtensionInfo$Description' => 'A description of the schema extension.
', 'StartSchemaExtensionRequest$Description' => 'A description of the schema extension.
', ], ], 'DesiredNumberOfDomainControllers' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$DesiredNumberOfDomainControllers' => 'The desired number of domain controllers in the directory if the directory is Microsoft AD.
', 'RegionDescription$DesiredNumberOfDomainControllers' => 'The desired number of domain controllers in the specified Region for the specified directory.
', 'UpdateNumberOfDomainControllersRequest$DesiredNumber' => 'The number of domain controllers desired in the directory.
', ], ], 'DirectoryAlreadyInRegionException' => [ 'base' => 'The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.
', 'refs' => [], ], 'DirectoryAlreadySharedException' => [ 'base' => 'The specified directory has already been shared with this Amazon Web Services account.
', 'refs' => [], ], 'DirectoryConfigurationSettingAllowedValues' => [ 'base' => NULL, 'refs' => [ 'SettingEntry$AllowedValues' => 'The valid range of values for the directory setting. These values depend on the DataType of your directory.
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.
The date and time when the request to update a directory setting was last submitted.
', ], ], 'DirectoryConfigurationSettingLastUpdatedDateTime' => [ 'base' => NULL, 'refs' => [ 'SettingEntry$LastUpdatedDateTime' => 'The date and time when the directory setting was last updated.
', ], ], 'DirectoryConfigurationSettingName' => [ 'base' => NULL, 'refs' => [ 'Setting$Name' => 'The name of the directory setting. For example:
TLS_1_0
The name of the directory setting. For example:
TLS_1_0
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.
', ], ], 'DirectoryConfigurationSettingRequestStatusMessage' => [ 'base' => NULL, 'refs' => [ 'SettingEntry$RequestStatusMessage' => 'The last status message for the directory status request.
', ], ], 'DirectoryConfigurationSettingType' => [ 'base' => NULL, 'refs' => [ 'SettingEntry$Type' => 'The type, or category, of a directory setting. Similar settings have the same type. For example, Protocol, Cipher, or Certificate-Based Authentication.
The value of the directory setting for which to retrieve information. For example, for TLS_1_0, the valid values are: Enable and Disable.
The value of the directory setting that is applied to the directory.
', 'SettingEntry$RequestedValue' => 'The value that was last requested for the directory setting.
', ], ], 'DirectoryConfigurationStatus' => [ 'base' => NULL, 'refs' => [ 'DescribeSettingsRequest$Status' => 'The status of the directory settings for which to retrieve information.
', 'DirectoryConfigurationSettingRequestDetailedStatus$value' => NULL, 'SettingEntry$RequestStatus' => '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.
Contains information for the ConnectDirectory operation when an AD Connector directory is being created.
', 'refs' => [ 'ConnectDirectoryRequest$ConnectSettings' => 'A DirectoryConnectSettings object that contains additional information for the operation.
', ], ], 'DirectoryConnectSettingsDescription' => [ 'base' => 'Contains information about an AD Connector directory.
', 'refs' => [ 'DirectoryDescription$ConnectSettings' => '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' => [ 'base' => 'Contains information about an Directory Service directory.
', 'refs' => [ 'DirectoryDescriptions$member' => NULL, ], ], 'DirectoryDescriptions' => [ 'base' => 'A list of directory descriptions.
', 'refs' => [ 'DescribeDirectoriesResult$DirectoryDescriptions' => '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.
The specified directory does not exist in the system.
', 'refs' => [], ], 'DirectoryEdition' => [ 'base' => NULL, 'refs' => [ 'CreateMicrosoftADRequest$Edition' => 'Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
The edition associated with this directory.
', ], ], 'DirectoryId' => [ 'base' => NULL, 'refs' => [ 'AcceptSharedDirectoryRequest$SharedDirectoryId' => 'Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
', 'AddIpRoutesRequest$DirectoryId' => 'Identifier (ID) of the directory to which to add the address block.
', 'AddRegionRequest$DirectoryId' => 'The identifier of the directory to which you want to add Region replication.
', 'CancelSchemaExtensionRequest$DirectoryId' => 'The identifier of the directory whose schema extension will be canceled.
', 'ConnectDirectoryResult$DirectoryId' => 'The identifier of the new directory.
', 'CreateAliasRequest$DirectoryId' => 'The identifier of the directory for which to create the alias.
', 'CreateAliasResult$DirectoryId' => 'The identifier of the directory.
', 'CreateComputerRequest$DirectoryId' => 'The identifier of the directory in which to create the computer account.
', 'CreateConditionalForwarderRequest$DirectoryId' => 'The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.
', 'CreateDirectoryResult$DirectoryId' => 'The identifier of the directory that was created.
', 'CreateLogSubscriptionRequest$DirectoryId' => 'Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.
', 'CreateMicrosoftADResult$DirectoryId' => 'The identifier of the directory that was created.
', 'CreateSnapshotRequest$DirectoryId' => 'The identifier of the directory of which to take a snapshot.
', 'CreateTrustRequest$DirectoryId' => 'The Directory ID of the Managed Microsoft AD directory for which to establish the trust relationship.
', 'DeleteConditionalForwarderRequest$DirectoryId' => 'The directory ID for which you are deleting the conditional forwarder.
', 'DeleteDirectoryRequest$DirectoryId' => 'The identifier of the directory to delete.
', 'DeleteDirectoryResult$DirectoryId' => 'The directory identifier.
', 'DeleteLogSubscriptionRequest$DirectoryId' => 'Identifier of the directory whose log subscription you want to delete.
', 'DeregisterCertificateRequest$DirectoryId' => 'The identifier of the directory.
', 'DeregisterEventTopicRequest$DirectoryId' => 'The Directory ID to remove as a publisher. This directory will no longer send messages to the specified Amazon SNS topic.
', 'DescribeCertificateRequest$DirectoryId' => 'The identifier of the directory.
', 'DescribeClientAuthenticationSettingsRequest$DirectoryId' => 'The identifier of the directory for which to retrieve information.
', 'DescribeConditionalForwardersRequest$DirectoryId' => 'The directory ID for which to get the list of associated conditional forwarders.
', 'DescribeDomainControllersRequest$DirectoryId' => 'Identifier of the directory for which to retrieve the domain controller information.
', 'DescribeEventTopicsRequest$DirectoryId' => '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.
', 'DescribeLDAPSSettingsRequest$DirectoryId' => 'The identifier of the directory.
', 'DescribeRegionsRequest$DirectoryId' => 'The identifier of the directory.
', 'DescribeSettingsRequest$DirectoryId' => 'The identifier of the directory for which to retrieve information.
', 'DescribeSettingsResult$DirectoryId' => 'The identifier of the directory.
', 'DescribeSharedDirectoriesRequest$OwnerDirectoryId' => 'Returns the identifier of the directory in the directory owner account.
', 'DescribeSnapshotsRequest$DirectoryId' => 'The identifier of the directory for which to retrieve snapshot information.
', 'DescribeTrustsRequest$DirectoryId' => 'The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.
', 'DescribeUpdateDirectoryRequest$DirectoryId' => 'The unique identifier of the directory.
', 'DirectoryDescription$DirectoryId' => 'The directory identifier.
', 'DirectoryIds$member' => NULL, 'DisableClientAuthenticationRequest$DirectoryId' => 'The identifier of the directory
', 'DisableLDAPSRequest$DirectoryId' => 'The identifier of the directory.
', 'DisableRadiusRequest$DirectoryId' => 'The identifier of the directory for which to disable MFA.
', 'DisableSsoRequest$DirectoryId' => 'The identifier of the directory for which to disable single-sign on.
', 'DomainController$DirectoryId' => 'Identifier of the directory where the domain controller resides.
', 'EnableClientAuthenticationRequest$DirectoryId' => 'The identifier of the specified directory.
', 'EnableLDAPSRequest$DirectoryId' => 'The identifier of the directory.
', 'EnableRadiusRequest$DirectoryId' => 'The identifier of the directory for which to enable MFA.
', 'EnableSsoRequest$DirectoryId' => 'The identifier of the directory for which to enable single-sign on.
', 'EventTopic$DirectoryId' => 'The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS topic.
', 'GetSnapshotLimitsRequest$DirectoryId' => 'Contains the identifier of the directory to obtain the limits for.
', 'IpRouteInfo$DirectoryId' => 'Identifier (ID) of the directory associated with the IP addresses.
', 'ListCertificatesRequest$DirectoryId' => 'The identifier of the directory.
', 'ListIpRoutesRequest$DirectoryId' => 'Identifier (ID) of the directory for which you want to retrieve the IP addresses.
', 'ListLogSubscriptionsRequest$DirectoryId' => '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.
', 'ListSchemaExtensionsRequest$DirectoryId' => 'The identifier of the directory from which to retrieve the schema extension information.
', 'LogSubscription$DirectoryId' => 'Identifier (ID) of the directory that you want to associate with the log subscription.
', 'OwnerDirectoryDescription$DirectoryId' => 'Identifier of the Managed Microsoft AD directory in the directory owner account.
', 'RegionDescription$DirectoryId' => 'The identifier of the directory.
', 'RegisterCertificateRequest$DirectoryId' => 'The identifier of the directory.
', 'RegisterEventTopicRequest$DirectoryId' => 'The Directory ID that will publish status messages to the Amazon SNS topic.
', 'RejectSharedDirectoryRequest$SharedDirectoryId' => 'Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
', 'RejectSharedDirectoryResult$SharedDirectoryId' => 'Identifier of the shared directory in the directory consumer account.
', 'RemoveIpRoutesRequest$DirectoryId' => 'Identifier (ID) of the directory from which you want to remove the IP addresses.
', 'RemoveRegionRequest$DirectoryId' => 'The identifier of the directory for which you want to remove Region replication.
', 'ResetUserPasswordRequest$DirectoryId' => 'Identifier of the Managed Microsoft AD or Simple AD directory in which the user resides.
', 'SchemaExtensionInfo$DirectoryId' => 'The identifier of the directory to which the schema extension is applied.
', 'ShareDirectoryRequest$DirectoryId' => 'Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.
', 'ShareDirectoryResult$SharedDirectoryId' => 'Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).
Identifier of the directory in the directory owner account.
', 'SharedDirectory$SharedDirectoryId' => 'Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.
', 'Snapshot$DirectoryId' => 'The directory identifier.
', 'StartSchemaExtensionRequest$DirectoryId' => 'The identifier of the directory for which the schema extension will be applied to.
', 'Trust$DirectoryId' => 'The Directory ID of the Amazon Web Services directory involved in the trust relationship.
', 'UnshareDirectoryRequest$DirectoryId' => 'The identifier of the Managed Microsoft AD directory that you want to stop sharing.
', 'UnshareDirectoryResult$SharedDirectoryId' => 'Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).
The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.
', 'UpdateDirectorySetupRequest$DirectoryId' => 'The identifier of the directory on which you want to perform the update.
', 'UpdateNumberOfDomainControllersRequest$DirectoryId' => 'Identifier of the directory to which the domain controllers will be added or removed.
', 'UpdateRadiusRequest$DirectoryId' => 'The identifier of the directory for which to update the RADIUS server information.
', 'UpdateSettingsRequest$DirectoryId' => 'The identifier of the directory for which to update settings.
', 'UpdateSettingsResult$DirectoryId' => 'The identifier of the directory.
', ], ], 'DirectoryIds' => [ 'base' => 'A list of directory identifiers.
', 'refs' => [ 'DescribeDirectoriesRequest$DirectoryIds' => '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.
A list of identifiers of all shared directories in your account.
', ], ], 'DirectoryInDesiredStateException' => [ 'base' => 'The directory is already updated to desired update type settings.
', 'refs' => [], ], 'DirectoryLimitExceededException' => [ 'base' => '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.
', 'refs' => [], ], 'DirectoryLimits' => [ 'base' => 'Contains directory limit information for a Region.
', 'refs' => [ 'GetDirectoryLimitsResult$DirectoryLimits' => 'A DirectoryLimits object that contains the directory limits for the current Region.
', ], ], 'DirectoryName' => [ 'base' => NULL, 'refs' => [ 'ConnectDirectoryRequest$Name' => 'The fully qualified name of your self-managed directory, such as corp.example.com.
The fully qualified name for the directory, such as corp.example.com.
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.
The fully qualified name of the directory.
', ], ], 'DirectoryNotSharedException' => [ 'base' => 'The specified directory has not been shared with this Amazon Web Services account.
', 'refs' => [], ], 'DirectoryShortName' => [ 'base' => NULL, 'refs' => [ 'ConnectDirectoryRequest$ShortName' => 'The NetBIOS name of your self-managed directory, such as CORP.
The NetBIOS name of the directory, such as CORP.
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.
The short name of the directory.
', ], ], 'DirectorySize' => [ 'base' => NULL, 'refs' => [ 'ConnectDirectoryRequest$Size' => 'The size of the directory.
', 'CreateDirectoryRequest$Size' => 'The size of the directory.
', 'DirectoryDescription$Size' => 'The directory size.
', ], ], 'DirectoryStage' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$Stage' => 'The current stage of the directory.
', 'RegionDescription$Status' => 'The status of the replication process for the specified Region.
', ], ], 'DirectoryType' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$Type' => 'The directory size.
', ], ], 'DirectoryUnavailableException' => [ 'base' => 'The specified directory is unavailable or could not be found.
', 'refs' => [], ], 'DirectoryVpcSettings' => [ 'base' => 'Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
', 'refs' => [ 'AddRegionRequest$VPCSettings' => NULL, 'CreateDirectoryRequest$VpcSettings' => 'A DirectoryVpcSettings object that contains additional information for the operation.
', 'CreateMicrosoftADRequest$VpcSettings' => 'Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
', 'RegionDescription$VpcSettings' => NULL, ], ], 'DirectoryVpcSettingsDescription' => [ 'base' => 'Contains information about the directory.
', 'refs' => [ 'DirectoryDescription$VpcSettings' => '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.
', 'OwnerDirectoryDescription$VpcSettings' => 'Information about the VPC settings for the directory.
', ], ], 'DisableClientAuthenticationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableClientAuthenticationResult' => [ 'base' => NULL, 'refs' => [], ], 'DisableLDAPSRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableLDAPSResult' => [ 'base' => NULL, 'refs' => [], ], 'DisableRadiusRequest' => [ 'base' => 'Contains the inputs for the DisableRadius operation.
', 'refs' => [], ], 'DisableRadiusResult' => [ 'base' => 'Contains the results of the DisableRadius operation.
', 'refs' => [], ], 'DisableSsoRequest' => [ 'base' => 'Contains the inputs for the DisableSso operation.
', 'refs' => [], ], 'DisableSsoResult' => [ 'base' => 'Contains the results of the DisableSso operation.
', 'refs' => [], ], 'DnsIpAddrs' => [ 'base' => NULL, 'refs' => [ 'ConditionalForwarder$DnsIpAddrs' => '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.
', 'CreateConditionalForwarderRequest$DnsIpAddrs' => 'The IP addresses of the remote DNS server associated with RemoteDomainName.
', 'CreateTrustRequest$ConditionalForwarderIpAddrs' => 'The IP addresses of the remote DNS server associated with RemoteDomainName.
', 'DirectoryConnectSettings$CustomerDnsIps' => 'A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.
', 'DirectoryDescription$DnsIpAddrs' => '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.
', 'OwnerDirectoryDescription$DnsIpAddrs' => 'IP address of the directory’s domain controllers.
', 'UpdateConditionalForwarderRequest$DnsIpAddrs' => 'The updated IP addresses of the remote DNS server associated with the conditional forwarder.
', ], ], 'DomainController' => [ 'base' => 'Contains information about the domain controllers for a specified directory.
', 'refs' => [ 'DomainControllers$member' => NULL, ], ], 'DomainControllerId' => [ 'base' => NULL, 'refs' => [ 'DomainController$DomainControllerId' => 'Identifies a specific domain controller in the directory.
', 'DomainControllerIds$member' => NULL, ], ], 'DomainControllerIds' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainControllersRequest$DomainControllerIds' => 'A list of identifiers for the domain controllers whose information will be provided.
', ], ], 'DomainControllerLimitExceededException' => [ 'base' => 'The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.
', 'refs' => [], ], 'DomainControllerStatus' => [ 'base' => NULL, 'refs' => [ 'DomainController$Status' => 'The status of the domain controller.
', ], ], 'DomainControllerStatusReason' => [ 'base' => NULL, 'refs' => [ 'DomainController$StatusReason' => 'A description of the domain controller state.
', ], ], 'DomainControllers' => [ 'base' => NULL, 'refs' => [ 'DescribeDomainControllersResult$DomainControllers' => 'List of the DomainController objects that were retrieved.
', ], ], 'EnableClientAuthenticationRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableClientAuthenticationResult' => [ 'base' => NULL, 'refs' => [], ], 'EnableLDAPSRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableLDAPSResult' => [ 'base' => NULL, 'refs' => [], ], 'EnableRadiusRequest' => [ 'base' => 'Contains the inputs for the EnableRadius operation.
', 'refs' => [], ], 'EnableRadiusResult' => [ 'base' => 'Contains the results of the EnableRadius operation.
', 'refs' => [], ], 'EnableSsoRequest' => [ 'base' => 'Contains the inputs for the EnableSso operation.
', 'refs' => [], ], 'EnableSsoResult' => [ 'base' => 'Contains the results of the EnableSso operation.
', 'refs' => [], ], 'EndDateTime' => [ 'base' => NULL, 'refs' => [ 'SchemaExtensionInfo$EndDateTime' => 'The date and time that the schema extension was completed.
', ], ], 'EntityAlreadyExistsException' => [ 'base' => 'The specified entity already exists.
', 'refs' => [], ], 'EntityDoesNotExistException' => [ 'base' => 'The specified entity could not be found.
', 'refs' => [], ], 'EventTopic' => [ 'base' => 'Information about Amazon SNS topic and Directory Service directory associations.
', 'refs' => [ 'EventTopics$member' => NULL, ], ], 'EventTopics' => [ 'base' => NULL, 'refs' => [ 'DescribeEventTopicsResult$EventTopics' => 'A list of Amazon SNS topic names that receive status messages from the specified Directory ID.
', ], ], 'ExceptionMessage' => [ 'base' => 'The descriptive message for the exception.
', 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AuthenticationFailedException$Message' => 'The textual message for the exception.
', 'CertificateAlreadyExistsException$Message' => NULL, 'CertificateDoesNotExistException$Message' => NULL, 'CertificateInUseException$Message' => NULL, 'CertificateLimitExceededException$Message' => NULL, 'ClientException$Message' => NULL, 'DirectoryAlreadyInRegionException$Message' => NULL, 'DirectoryAlreadySharedException$Message' => NULL, 'DirectoryDoesNotExistException$Message' => NULL, 'DirectoryInDesiredStateException$Message' => NULL, 'DirectoryLimitExceededException$Message' => NULL, 'DirectoryNotSharedException$Message' => NULL, 'DirectoryUnavailableException$Message' => NULL, 'DomainControllerLimitExceededException$Message' => NULL, 'EntityAlreadyExistsException$Message' => NULL, 'EntityDoesNotExistException$Message' => NULL, 'IncompatibleSettingsException$Message' => NULL, 'InsufficientPermissionsException$Message' => NULL, 'InvalidCertificateException$Message' => NULL, 'InvalidClientAuthStatusException$Message' => NULL, 'InvalidLDAPSStatusException$Message' => NULL, 'InvalidNextTokenException$Message' => NULL, 'InvalidParameterException$Message' => NULL, 'InvalidPasswordException$Message' => NULL, 'InvalidTargetException$Message' => NULL, 'IpRouteLimitExceededException$Message' => NULL, 'NoAvailableCertificateException$Message' => NULL, 'OrganizationsException$Message' => NULL, 'RegionLimitExceededException$Message' => NULL, 'ServiceException$Message' => NULL, 'ShareLimitExceededException$Message' => NULL, 'SnapshotLimitExceededException$Message' => NULL, 'TagLimitExceededException$Message' => NULL, 'UnsupportedOperationException$Message' => NULL, 'UnsupportedSettingsException$Message' => NULL, 'UserDoesNotExistException$Message' => NULL, ], ], 'GetDirectoryLimitsRequest' => [ 'base' => 'Contains the inputs for the GetDirectoryLimits operation.
', 'refs' => [], ], 'GetDirectoryLimitsResult' => [ 'base' => 'Contains the results of the GetDirectoryLimits operation.
', 'refs' => [], ], 'GetSnapshotLimitsRequest' => [ 'base' => 'Contains the inputs for the GetSnapshotLimits operation.
', 'refs' => [], ], 'GetSnapshotLimitsResult' => [ 'base' => 'Contains the results of the GetSnapshotLimits operation.
', 'refs' => [], ], 'IncompatibleSettingsException' => [ 'base' => 'The specified directory setting is not compatible with other settings.
', 'refs' => [], ], 'InitiatedBy' => [ 'base' => NULL, 'refs' => [ 'UpdateInfoEntry$InitiatedBy' => 'This specifies if the update was initiated by the customer or by the service team.
', ], ], 'InsufficientPermissionsException' => [ 'base' => 'The account does not have sufficient permission to perform the operation.
', 'refs' => [], ], 'InvalidCertificateException' => [ 'base' => 'The certificate PEM that was provided has incorrect encoding.
', 'refs' => [], ], 'InvalidClientAuthStatusException' => [ 'base' => 'Client authentication is already enabled.
', 'refs' => [], ], 'InvalidLDAPSStatusException' => [ 'base' => 'The LDAP activities could not be performed because they are limited by the LDAPS status.
', 'refs' => [], ], 'InvalidNextTokenException' => [ 'base' => 'The NextToken value is not valid.
One or more parameters are not valid.
', 'refs' => [], ], 'InvalidPasswordException' => [ 'base' => 'The new password provided by the user does not meet the password complexity requirements defined in your directory.
', 'refs' => [], ], 'InvalidTargetException' => [ 'base' => 'The specified shared target is not valid.
', 'refs' => [], ], 'IpAddr' => [ 'base' => NULL, 'refs' => [ 'DnsIpAddrs$member' => NULL, 'DomainController$DnsIpAddr' => 'The IP address of the domain controller.
', 'IpAddrs$member' => NULL, ], ], 'IpAddrs' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettingsDescription$ConnectIps' => 'The IP addresses of the AD Connector servers.
', ], ], 'IpRoute' => [ 'base' => 'IP address block. This is often the address block of the DNS server used for your self-managed domain.
', 'refs' => [ 'IpRoutes$member' => NULL, ], ], 'IpRouteInfo' => [ 'base' => 'Information about one or more IP address blocks.
', 'refs' => [ 'IpRoutesInfo$member' => NULL, ], ], 'IpRouteLimitExceededException' => [ 'base' => 'The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.
', 'refs' => [], ], 'IpRouteStatusMsg' => [ 'base' => NULL, 'refs' => [ 'IpRouteInfo$IpRouteStatusMsg' => 'The status of the IP address block.
', ], ], 'IpRouteStatusReason' => [ 'base' => NULL, 'refs' => [ 'IpRouteInfo$IpRouteStatusReason' => 'The reason for the IpRouteStatusMsg.
', ], ], 'IpRoutes' => [ 'base' => NULL, 'refs' => [ 'AddIpRoutesRequest$IpRoutes' => '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.
', ], ], 'IpRoutesInfo' => [ 'base' => NULL, 'refs' => [ 'ListIpRoutesResult$IpRoutesInfo' => 'A list of IpRoutes.
', ], ], 'LDAPSSettingInfo' => [ 'base' => 'Contains general information about the LDAPS settings.
', 'refs' => [ 'LDAPSSettingsInfo$member' => NULL, ], ], 'LDAPSSettingsInfo' => [ 'base' => NULL, 'refs' => [ 'DescribeLDAPSSettingsResult$LDAPSSettingsInfo' => 'Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.
', ], ], 'LDAPSStatus' => [ 'base' => NULL, 'refs' => [ 'LDAPSSettingInfo$LDAPSStatus' => 'The state of the LDAPS settings.
', ], ], 'LDAPSStatusReason' => [ 'base' => NULL, 'refs' => [ 'LDAPSSettingInfo$LDAPSStatusReason' => 'Describes a state change for LDAPS.
', ], ], 'LDAPSType' => [ 'base' => NULL, 'refs' => [ 'DescribeLDAPSSettingsRequest$Type' => 'The type of LDAP security to enable. Currently only the value Client is supported.
The type of LDAP security to enable. Currently only the value Client is supported.
The type of LDAP security to enable. Currently only the value Client is supported.
The date and time when the status of the client authentication type was last updated.
', 'DirectoryDescription$StageLastUpdatedDateTime' => 'The date and time that the stage was last updated.
', 'DomainController$StatusLastUpdatedDateTime' => 'The date and time that the status was last updated.
', 'LDAPSSettingInfo$LastUpdatedDateTime' => 'The date and time when the LDAPS settings were last updated.
', 'RegionDescription$LastUpdatedDateTime' => 'The date and time that the Region description was last updated.
', 'SharedDirectory$LastUpdatedDateTime' => 'The date and time that the shared directory was last updated.
', 'Trust$LastUpdatedDateTime' => 'The date and time that the trust relationship was last updated.
', 'UpdateInfoEntry$LastUpdatedDateTime' => 'The last updated date and time of a particular directory setting.
', ], ], 'LaunchTime' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$LaunchTime' => 'Specifies when the directory was created.
', 'DomainController$LaunchTime' => 'Specifies when the domain controller was created.
', 'RegionDescription$LaunchTime' => 'Specifies when the Region replication began.
', ], ], 'LdifContent' => [ 'base' => NULL, 'refs' => [ 'StartSchemaExtensionRequest$LdifContent' => '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.
', ], ], 'Limit' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectoriesRequest$Limit' => '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.
', 'DescribeDomainControllersRequest$Limit' => 'The maximum number of items to return.
', 'DescribeSharedDirectoriesRequest$Limit' => 'The number of shared directories to return in the response object.
', 'DescribeSnapshotsRequest$Limit' => 'The maximum number of objects to return.
', 'DescribeTrustsRequest$Limit' => 'The maximum number of objects to return.
', 'DirectoryLimits$CloudOnlyDirectoriesLimit' => 'The maximum number of cloud directories allowed in the Region.
', 'DirectoryLimits$CloudOnlyDirectoriesCurrentCount' => 'The current number of cloud directories in the Region.
', 'DirectoryLimits$CloudOnlyMicrosoftADLimit' => 'The maximum number of Managed Microsoft AD directories allowed in the region.
', 'DirectoryLimits$CloudOnlyMicrosoftADCurrentCount' => 'The current number of Managed Microsoft AD directories in the region.
', 'DirectoryLimits$ConnectedDirectoriesLimit' => 'The maximum number of connected directories allowed in the Region.
', 'DirectoryLimits$ConnectedDirectoriesCurrentCount' => 'The current number of connected directories in the Region.
', 'ListIpRoutesRequest$Limit' => 'Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.
', 'ListLogSubscriptionsRequest$Limit' => 'The maximum number of items returned.
', 'ListSchemaExtensionsRequest$Limit' => 'The maximum number of items to return.
', 'ListTagsForResourceRequest$Limit' => 'Reserved for future use.
', 'SnapshotLimits$ManualSnapshotsLimit' => 'The maximum number of manual snapshots allowed.
', 'SnapshotLimits$ManualSnapshotsCurrentCount' => 'The current number of manual snapshots of the directory.
', ], ], 'ListCertificatesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCertificatesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListIpRoutesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListIpRoutesResult' => [ 'base' => NULL, 'refs' => [], ], 'ListLogSubscriptionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListLogSubscriptionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaExtensionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListSchemaExtensionsResult' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'LogGroupName' => [ 'base' => NULL, 'refs' => [ 'CreateLogSubscriptionRequest$LogGroupName' => 'The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
', 'LogSubscription$LogGroupName' => 'The name of the log group.
', ], ], 'LogSubscription' => [ 'base' => 'Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.
', 'refs' => [ 'LogSubscriptions$member' => NULL, ], ], 'LogSubscriptions' => [ 'base' => NULL, 'refs' => [ 'ListLogSubscriptionsResult$LogSubscriptions' => 'A list of active LogSubscription objects for calling the Amazon Web Services account.
', ], ], 'ManualSnapshotsLimitReached' => [ 'base' => NULL, 'refs' => [ 'SnapshotLimits$ManualSnapshotsLimitReached' => 'Indicates if the manual snapshot limit has been reached.
', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeClientAuthenticationSettingsRequest$NextToken' => 'The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to DescribeClientAuthenticationSettings. Pass null if this is the first call.
', 'DescribeClientAuthenticationSettingsResult$NextToken' => 'The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.
', 'DescribeDirectoriesRequest$NextToken' => 'The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
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.
The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.
', 'DescribeDomainControllersResult$NextToken' => '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.
The type of next token used for pagination.
', 'DescribeLDAPSSettingsResult$NextToken' => 'The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.
', 'DescribeRegionsRequest$NextToken' => 'The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions. Pass null if this is the first call.
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.
The DescribeSettingsResult.NextToken value from a previous call to DescribeSettings. Pass null if this is the first call.
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.
The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.
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.
The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
', 'DescribeSnapshotsResult$NextToken' => 'If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
', 'DescribeTrustsRequest$NextToken' => 'The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
', 'DescribeTrustsResult$NextToken' => '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.
', 'DescribeUpdateDirectoryRequest$NextToken' => ' The DescribeUpdateDirectoryResult. NextToken value from a previous call to DescribeUpdateDirectory. Pass null if this is the first call.
If not null, more results are available. Pass this value for the NextToken parameter.
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.
Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.
', 'ListIpRoutesRequest$NextToken' => 'The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.
', 'ListIpRoutesResult$NextToken' => '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.
', 'ListLogSubscriptionsRequest$NextToken' => 'The token for the next set of items to return.
', 'ListLogSubscriptionsResult$NextToken' => 'The token for the next set of items to return.
', 'ListSchemaExtensionsRequest$NextToken' => 'The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.
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.
Reserved for future use.
', 'ListTagsForResourceResult$NextToken' => 'Reserved for future use.
', ], ], 'NoAvailableCertificateException' => [ 'base' => 'Client authentication setup could not be completed because at least one valid certificate must be registered in the system.
', 'refs' => [], ], 'Notes' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$ShareNotes' => '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.
', 'ShareDirectoryRequest$ShareNotes' => '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$ShareNotes' => '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.
', ], ], 'OCSPUrl' => [ 'base' => NULL, 'refs' => [ 'ClientCertAuthSettings$OCSPUrl' => '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.
', ], ], 'OSUpdateSettings' => [ 'base' => 'OS version that the directory needs to be updated to.
', 'refs' => [ 'UpdateDirectorySetupRequest$OSUpdateSettings' => 'The settings for the OS update that needs to be performed on the directory.
', 'UpdateValue$OSUpdateSettings' => 'The OS update related settings.
', ], ], 'OSVersion' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$OsVersion' => 'The operating system (OS) version of the directory.
', 'OSUpdateSettings$OSVersion' => 'OS version that the directory needs to be updated to.
', ], ], 'OrganizationalUnitDN' => [ 'base' => NULL, 'refs' => [ 'CreateComputerRequest$OrganizationalUnitDistinguishedName' => 'The fully-qualified distinguished name of the organizational unit to place the computer account in.
', ], ], 'OrganizationsException' => [ 'base' => 'Exception encountered while trying to access your Amazon Web Services organization.
', 'refs' => [], ], 'OwnerDirectoryDescription' => [ 'base' => 'Describes the directory owner account details that have been shared to the directory consumer account.
', 'refs' => [ 'DirectoryDescription$OwnerDirectoryDescription' => 'Describes the Managed Microsoft AD directory in the directory owner account.
', ], ], 'PageLimit' => [ 'base' => NULL, 'refs' => [ 'DescribeClientAuthenticationSettingsRequest$Limit' => '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.
', 'DescribeLDAPSSettingsRequest$Limit' => 'Specifies the number of items that should be displayed on one page.
', 'ListCertificatesRequest$Limit' => 'The number of items that should show up on one page
', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'CreateDirectoryRequest$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:
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.
', 'CreateMicrosoftADRequest$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.
', ], ], 'PortNumber' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$RadiusPort' => '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.
', ], ], 'RadiusAuthenticationProtocol' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$AuthenticationProtocol' => 'The protocol specified for your RADIUS endpoints.
', ], ], 'RadiusDisplayLabel' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$DisplayLabel' => 'Not currently used.
', ], ], 'RadiusRetries' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$RadiusRetries' => 'The maximum number of times that communication with the RADIUS server is attempted.
', ], ], 'RadiusSettings' => [ 'base' => 'Contains information about a Remote Authentication Dial In User Service (RADIUS) server.
', 'refs' => [ 'DirectoryDescription$RadiusSettings' => 'A RadiusSettings object that contains information about the RADIUS server configured for this directory.
', 'EnableRadiusRequest$RadiusSettings' => 'A RadiusSettings object that contains information about the RADIUS server.
', 'OwnerDirectoryDescription$RadiusSettings' => 'A RadiusSettings object that contains information about the RADIUS server.
', 'UpdateRadiusRequest$RadiusSettings' => 'A RadiusSettings object that contains information about the RADIUS server.
', ], ], 'RadiusSharedSecret' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$SharedSecret' => 'Required for enabling RADIUS on the directory.
', ], ], 'RadiusStatus' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$RadiusStatus' => 'The status of the RADIUS MFA server connection.
', 'OwnerDirectoryDescription$RadiusStatus' => 'Information about the status of the RADIUS server.
', ], ], 'RadiusTimeout' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$RadiusTimeout' => 'The amount of time, in seconds, to wait for the RADIUS server to respond.
', ], ], 'RegionDescription' => [ 'base' => 'The replicated Region information for a directory.
', 'refs' => [ 'RegionsDescription$member' => NULL, ], ], 'RegionLimitExceededException' => [ 'base' => 'You have reached the limit for maximum number of simultaneous Region replications per directory.
', 'refs' => [], ], 'RegionName' => [ 'base' => NULL, 'refs' => [ 'AddRegionRequest$RegionName' => 'The name of the Region where you want to add domain controllers for replication. For example, us-east-1.
The name of the Region. For example, us-east-1.
The name of the Region.
', 'DirectoryConfigurationSettingRequestDetailedStatus$key' => NULL, 'RegionDescription$RegionName' => 'The name of the Region. For example, us-east-1.
The Region where the Managed Microsoft AD directory was originally created.
', 'UpdateInfoEntry$Region' => 'The name of the Region.
', ], ], 'RegionType' => [ 'base' => NULL, 'refs' => [ 'RegionDescription$RegionType' => 'Specifies whether the Region is the primary Region or an additional Region.
', ], ], 'RegionsDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeRegionsResult$RegionsDescription' => 'List of Region information related to the directory for each replicated Region.
', ], ], 'RegionsInfo' => [ 'base' => 'Provides information about the Regions that are configured for multi-Region replication.
', 'refs' => [ 'DirectoryDescription$RegionsInfo' => 'Lists the Regions where the directory has replicated.
', ], ], 'RegisterCertificateRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterCertificateResult' => [ 'base' => NULL, 'refs' => [], ], 'RegisterEventTopicRequest' => [ 'base' => 'Registers a new event topic.
', 'refs' => [], ], 'RegisterEventTopicResult' => [ 'base' => 'The result of a RegisterEventTopic request.
', 'refs' => [], ], 'RejectSharedDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'RejectSharedDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoteDomainName' => [ 'base' => NULL, 'refs' => [ 'ConditionalForwarder$RemoteDomainName' => 'The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
', 'CreateConditionalForwarderRequest$RemoteDomainName' => 'The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
', 'CreateTrustRequest$RemoteDomainName' => 'The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
', 'DeleteConditionalForwarderRequest$RemoteDomainName' => 'The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
', 'RemoteDomainNames$member' => NULL, 'Trust$RemoteDomainName' => 'The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
', 'UpdateConditionalForwarderRequest$RemoteDomainName' => 'The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
', ], ], 'RemoteDomainNames' => [ 'base' => NULL, 'refs' => [ 'DescribeConditionalForwardersRequest$RemoteDomainNames' => '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.
', ], ], 'RemoveIpRoutesRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveIpRoutesResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRegionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveRegionResult' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'RemoveTagsFromResourceResult' => [ 'base' => NULL, 'refs' => [], ], 'ReplicationScope' => [ 'base' => NULL, 'refs' => [ 'ConditionalForwarder$ReplicationScope' => '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.
The Amazon Web Services request identifier.
', 'refs' => [ 'AccessDeniedException$RequestId' => NULL, 'AuthenticationFailedException$RequestId' => 'The identifier of the request that caused the exception.
', 'CertificateAlreadyExistsException$RequestId' => NULL, 'CertificateDoesNotExistException$RequestId' => NULL, 'CertificateInUseException$RequestId' => NULL, 'CertificateLimitExceededException$RequestId' => NULL, 'ClientException$RequestId' => NULL, 'DirectoryAlreadyInRegionException$RequestId' => NULL, 'DirectoryAlreadySharedException$RequestId' => NULL, 'DirectoryDoesNotExistException$RequestId' => NULL, 'DirectoryInDesiredStateException$RequestId' => NULL, 'DirectoryLimitExceededException$RequestId' => NULL, 'DirectoryNotSharedException$RequestId' => NULL, 'DirectoryUnavailableException$RequestId' => NULL, 'DomainControllerLimitExceededException$RequestId' => NULL, 'EntityAlreadyExistsException$RequestId' => NULL, 'EntityDoesNotExistException$RequestId' => NULL, 'IncompatibleSettingsException$RequestId' => NULL, 'InsufficientPermissionsException$RequestId' => NULL, 'InvalidCertificateException$RequestId' => NULL, 'InvalidClientAuthStatusException$RequestId' => NULL, 'InvalidLDAPSStatusException$RequestId' => NULL, 'InvalidNextTokenException$RequestId' => NULL, 'InvalidParameterException$RequestId' => NULL, 'InvalidPasswordException$RequestId' => NULL, 'InvalidTargetException$RequestId' => NULL, 'IpRouteLimitExceededException$RequestId' => NULL, 'NoAvailableCertificateException$RequestId' => NULL, 'OrganizationsException$RequestId' => NULL, 'RegionLimitExceededException$RequestId' => NULL, 'ServiceException$RequestId' => NULL, 'ShareLimitExceededException$RequestId' => NULL, 'SnapshotLimitExceededException$RequestId' => NULL, 'TagLimitExceededException$RequestId' => NULL, 'UnsupportedOperationException$RequestId' => NULL, 'UnsupportedSettingsException$RequestId' => NULL, 'UpdateTrustResult$RequestId' => NULL, 'UserDoesNotExistException$RequestId' => NULL, ], ], 'ResetUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetUserPasswordResult' => [ 'base' => NULL, 'refs' => [], ], 'ResourceId' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceRequest$ResourceId' => 'Identifier (ID) for the directory to which to add the tag.
', 'ListTagsForResourceRequest$ResourceId' => 'Identifier (ID) of the directory for which you want to retrieve tags.
', 'RemoveTagsFromResourceRequest$ResourceId' => 'Identifier (ID) of the directory from which to remove the tag.
', ], ], 'RestoreFromSnapshotRequest' => [ 'base' => 'An object representing the inputs for the RestoreFromSnapshot operation.
', 'refs' => [], ], 'RestoreFromSnapshotResult' => [ 'base' => 'Contains the results of the RestoreFromSnapshot operation.
', 'refs' => [], ], 'SID' => [ 'base' => NULL, 'refs' => [ 'Computer$ComputerId' => 'The identifier of the computer.
', ], ], 'SchemaExtensionId' => [ 'base' => NULL, 'refs' => [ 'CancelSchemaExtensionRequest$SchemaExtensionId' => 'The identifier of the schema extension that will be canceled.
', 'SchemaExtensionInfo$SchemaExtensionId' => 'The identifier of the schema extension.
', 'StartSchemaExtensionResult$SchemaExtensionId' => 'The identifier of the schema extension that will be applied.
', ], ], 'SchemaExtensionInfo' => [ 'base' => 'Information about a schema extension.
', 'refs' => [ 'SchemaExtensionsInfo$member' => NULL, ], ], 'SchemaExtensionStatus' => [ 'base' => NULL, 'refs' => [ 'SchemaExtensionInfo$SchemaExtensionStatus' => 'The current status of the schema extension.
', ], ], 'SchemaExtensionStatusReason' => [ 'base' => NULL, 'refs' => [ 'SchemaExtensionInfo$SchemaExtensionStatusReason' => 'The reason for the SchemaExtensionStatus.
Information about the schema extensions applied to the directory.
', ], ], 'SecurityGroupId' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettingsDescription$SecurityGroupId' => 'The security group identifier for the AD Connector directory.
', 'DirectoryVpcSettingsDescription$SecurityGroupId' => 'The domain controller security group identifier for the directory.
', ], ], 'SelectiveAuth' => [ 'base' => NULL, 'refs' => [ 'CreateTrustRequest$SelectiveAuth' => 'Optional parameter to enable selective authentication for the trust.
', 'Trust$SelectiveAuth' => 'Current state of selective authentication for the trust.
', 'UpdateTrustRequest$SelectiveAuth' => 'Updates selective authentication for the trust.
', ], ], 'Server' => [ 'base' => NULL, 'refs' => [ 'Servers$member' => NULL, ], ], 'Servers' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$RadiusServers' => '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.
', ], ], 'ServiceException' => [ 'base' => 'An exception has occurred in Directory Service.
', 'refs' => [], ], 'Setting' => [ 'base' => 'Contains information about the configurable settings for a directory.
', 'refs' => [ 'Settings$member' => NULL, ], ], 'SettingEntries' => [ 'base' => NULL, 'refs' => [ 'DescribeSettingsResult$SettingEntries' => '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.
Contains information about the specified configurable setting for a directory.
', 'refs' => [ 'SettingEntries$member' => NULL, ], ], 'Settings' => [ 'base' => NULL, 'refs' => [ 'UpdateSettingsRequest$Settings' => 'The list of Setting objects.
', ], ], 'ShareDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ShareDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'ShareLimitExceededException' => [ 'base' => 'The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.
', 'refs' => [], ], 'ShareMethod' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$ShareMethod' => '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).
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).
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).
Current directory status of the shared Managed Microsoft AD directory.
', 'SharedDirectory$ShareStatus' => 'Current directory status of the shared Managed Microsoft AD directory.
', ], ], 'ShareTarget' => [ 'base' => 'Identifier that contains details about the directory consumer account.
', 'refs' => [ 'ShareDirectoryRequest$ShareTarget' => 'Identifier for the directory consumer account with whom the directory is to be shared.
', ], ], 'SharedDirectories' => [ 'base' => NULL, 'refs' => [ 'DescribeSharedDirectoriesResult$SharedDirectories' => 'A list of all shared directories in your account.
', ], ], 'SharedDirectory' => [ 'base' => 'Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.
', 'refs' => [ 'AcceptSharedDirectoryResult$SharedDirectory' => 'The shared directory in the directory consumer account.
', 'SharedDirectories$member' => NULL, ], ], 'Snapshot' => [ 'base' => 'Describes a directory snapshot.
', 'refs' => [ 'Snapshots$member' => NULL, ], ], 'SnapshotId' => [ 'base' => NULL, 'refs' => [ 'CreateSnapshotResult$SnapshotId' => 'The identifier of the snapshot that was created.
', 'DeleteSnapshotRequest$SnapshotId' => 'The identifier of the directory snapshot to be deleted.
', 'DeleteSnapshotResult$SnapshotId' => 'The identifier of the directory snapshot that was deleted.
', 'RestoreFromSnapshotRequest$SnapshotId' => 'The identifier of the snapshot to restore from.
', 'Snapshot$SnapshotId' => 'The snapshot identifier.
', 'SnapshotIds$member' => NULL, ], ], 'SnapshotIds' => [ 'base' => 'A list of directory snapshot identifiers.
', 'refs' => [ 'DescribeSnapshotsRequest$SnapshotIds' => '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.
', ], ], 'SnapshotLimitExceededException' => [ 'base' => '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.
', 'refs' => [], ], 'SnapshotLimits' => [ 'base' => 'Contains manual snapshot limit information for a directory.
', 'refs' => [ 'GetSnapshotLimitsResult$SnapshotLimits' => 'A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
', ], ], 'SnapshotName' => [ 'base' => NULL, 'refs' => [ 'CreateSnapshotRequest$Name' => 'The descriptive name to apply to the snapshot.
', 'Snapshot$Name' => 'The descriptive name of the snapshot.
', ], ], 'SnapshotStatus' => [ 'base' => NULL, 'refs' => [ 'Snapshot$Status' => 'The snapshot status.
', ], ], 'SnapshotType' => [ 'base' => NULL, 'refs' => [ 'Snapshot$Type' => 'The snapshot type.
', ], ], 'Snapshots' => [ 'base' => 'A list of descriptions of directory snapshots.
', 'refs' => [ 'DescribeSnapshotsResult$Snapshots' => '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.
', ], ], 'SsoEnabled' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$SsoEnabled' => 'Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.
', ], ], 'StageReason' => [ 'base' => NULL, 'refs' => [ 'DirectoryDescription$StageReason' => 'Additional information about the directory stage.
', ], ], 'StartDateTime' => [ 'base' => NULL, 'refs' => [ 'SchemaExtensionInfo$StartDateTime' => 'The date and time that the schema extension started being applied to the directory.
', 'UpdateInfoEntry$StartTime' => ' The start time of the UpdateDirectorySetup for the particular type.
The date and time that the snapshot was taken.
', ], ], 'StateLastUpdatedDateTime' => [ 'base' => NULL, 'refs' => [ 'RegionDescription$StatusLastUpdatedDateTime' => 'The date and time that the Region status was last updated.
', 'Trust$StateLastUpdatedDateTime' => 'The date and time that the TrustState was last updated.
', ], ], 'SubnetId' => [ 'base' => NULL, 'refs' => [ 'DomainController$SubnetId' => 'Identifier of the subnet in the VPC that contains the domain controller.
', 'SubnetIds$member' => NULL, ], ], 'SubnetIds' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettings$SubnetIds' => 'A list of subnet identifiers in the VPC in which the AD Connector is created.
', 'DirectoryConnectSettingsDescription$SubnetIds' => 'A list of subnet identifiers in the VPC that the AD Connector is in.
', 'DirectoryVpcSettings$SubnetIds' => '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$SubnetIds' => 'The identifiers of the subnets for the directory servers.
', ], ], 'SubscriptionCreatedDateTime' => [ 'base' => NULL, 'refs' => [ 'LogSubscription$SubscriptionCreatedDateTime' => 'The date and time that the log subscription was created.
', ], ], 'Tag' => [ 'base' => 'Metadata assigned to a directory consisting of a key-value pair.
', 'refs' => [ 'Tags$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ '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}_.:/=+\\\\-]*)$").
', 'TagKeys$member' => NULL, ], ], 'TagKeys' => [ 'base' => NULL, 'refs' => [ 'RemoveTagsFromResourceRequest$TagKeys' => 'The tag key (name) of the tag to be removed.
', ], ], 'TagLimitExceededException' => [ 'base' => 'The maximum allowed number of tags was exceeded.
', 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ '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}_.:/=+\\\\-]*)$").
', ], ], 'Tags' => [ 'base' => NULL, 'refs' => [ 'AddTagsToResourceRequest$Tags' => 'The tags to be assigned to the directory.
', 'ConnectDirectoryRequest$Tags' => 'The tags to be assigned to AD Connector.
', 'CreateDirectoryRequest$Tags' => 'The tags to be assigned to the Simple AD directory.
', 'CreateMicrosoftADRequest$Tags' => 'The tags to be assigned to the Managed Microsoft AD directory.
', 'ListTagsForResourceResult$Tags' => 'List of tags returned by the ListTagsForResource operation.
', ], ], 'TargetId' => [ 'base' => NULL, 'refs' => [ 'ShareTarget$Id' => 'Identifier of the directory consumer account.
', 'UnshareTarget$Id' => 'Identifier of the directory consumer account.
', ], ], 'TargetType' => [ 'base' => NULL, 'refs' => [ 'ShareTarget$Type' => 'Type of identifier to be used in the Id field.
Type of identifier to be used in the Id field.
', ], ], 'TopicArn' => [ 'base' => NULL, 'refs' => [ 'EventTopic$TopicArn' => 'The Amazon SNS topic ARN (Amazon Resource Name).
', ], ], 'TopicName' => [ 'base' => NULL, 'refs' => [ 'DeregisterEventTopicRequest$TopicName' => 'The name of the Amazon SNS topic from which to remove the directory as a publisher.
', 'EventTopic$TopicName' => 'The name of an Amazon SNS topic the receives status messages from the directory.
', 'RegisterEventTopicRequest$TopicName' => '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.
', 'TopicNames$member' => NULL, ], ], 'TopicNames' => [ 'base' => NULL, 'refs' => [ 'DescribeEventTopicsRequest$TopicNames' => '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.
The topic registration status.
', ], ], 'Trust' => [ 'base' => 'Describes a trust relationship between an Managed Microsoft AD directory and an external domain.
', 'refs' => [ 'Trusts$member' => NULL, ], ], 'TrustDirection' => [ 'base' => NULL, 'refs' => [ 'CreateTrustRequest$TrustDirection' => 'The direction of the trust relationship.
', 'Trust$TrustDirection' => 'The trust relationship direction.
', ], ], 'TrustId' => [ 'base' => NULL, 'refs' => [ 'CreateTrustResult$TrustId' => 'A unique identifier for the trust relationship that was created.
', 'DeleteTrustRequest$TrustId' => 'The Trust ID of the trust relationship to be deleted.
', 'DeleteTrustResult$TrustId' => 'The Trust ID of the trust relationship that was deleted.
', 'Trust$TrustId' => 'The unique ID of the trust relationship.
', 'TrustIds$member' => NULL, 'UpdateTrustRequest$TrustId' => 'Identifier of the trust relationship.
', 'UpdateTrustResult$TrustId' => 'Identifier of the trust relationship.
', 'VerifyTrustRequest$TrustId' => 'The unique Trust ID of the trust relationship to verify.
', 'VerifyTrustResult$TrustId' => 'The unique Trust ID of the trust relationship that was verified.
', ], ], 'TrustIds' => [ 'base' => NULL, 'refs' => [ 'DescribeTrustsRequest$TrustIds' => '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.
The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
', ], ], 'TrustState' => [ 'base' => NULL, 'refs' => [ 'Trust$TrustState' => 'The trust relationship state.
', ], ], 'TrustStateReason' => [ 'base' => NULL, 'refs' => [ 'Trust$TrustStateReason' => 'The reason for the TrustState.
', ], ], 'TrustType' => [ 'base' => NULL, 'refs' => [ 'CreateTrustRequest$TrustType' => 'The trust relationship type. Forest is the default.
The trust relationship type. Forest is the default.
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.
', ], ], 'UnshareDirectoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'UnshareDirectoryResult' => [ 'base' => NULL, 'refs' => [], ], 'UnshareTarget' => [ 'base' => 'Identifier that contains details about the directory consumer account with whom the directory is being unshared.
', 'refs' => [ 'UnshareDirectoryRequest$UnshareTarget' => 'Identifier for the directory consumer account with whom the directory has to be unshared.
', ], ], 'UnsupportedOperationException' => [ 'base' => 'The operation is not supported.
', 'refs' => [], ], 'UnsupportedSettingsException' => [ 'base' => 'The specified directory setting is not supported.
', 'refs' => [], ], 'UpdateActivities' => [ 'base' => NULL, 'refs' => [ 'DescribeUpdateDirectoryResult$UpdateActivities' => 'The list of update activities on a directory for the requested update type.
', ], ], 'UpdateConditionalForwarderRequest' => [ 'base' => 'Updates a conditional forwarder.
', 'refs' => [], ], 'UpdateConditionalForwarderResult' => [ 'base' => 'The result of an UpdateConditionalForwarder request.
', 'refs' => [], ], 'UpdateDirectorySetupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectorySetupResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateInfoEntry' => [ 'base' => 'An entry of update information related to a requested update type.
', 'refs' => [ 'UpdateActivities$member' => NULL, ], ], 'UpdateNumberOfDomainControllersRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNumberOfDomainControllersResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateRadiusRequest' => [ 'base' => 'Contains the inputs for the UpdateRadius operation.
', 'refs' => [], ], 'UpdateRadiusResult' => [ 'base' => 'Contains the results of the UpdateRadius operation.
', 'refs' => [], ], 'UpdateSecurityGroupForDirectoryControllers' => [ 'base' => NULL, 'refs' => [ 'AddIpRoutesRequest$UpdateSecurityGroupForDirectoryControllers' => '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.
', ], ], 'UpdateSettingsRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSettingsResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateStatus' => [ 'base' => NULL, 'refs' => [ 'UpdateInfoEntry$Status' => 'The status of the update performed on the directory.
', ], ], 'UpdateStatusReason' => [ 'base' => NULL, 'refs' => [ 'UpdateInfoEntry$StatusReason' => 'The reason for the current status of the update type activity.
', ], ], 'UpdateTrustRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateTrustResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateType' => [ 'base' => NULL, 'refs' => [ 'DescribeUpdateDirectoryRequest$UpdateType' => 'The type of updates you want to describe for the directory.
', 'UpdateDirectorySetupRequest$UpdateType' => 'The type of update that needs to be performed on the directory. For example, OS.
', ], ], 'UpdateValue' => [ 'base' => ' The value for a given type of UpdateSettings.
The new value of the target setting.
', 'UpdateInfoEntry$PreviousValue' => 'The old value of the target setting.
', ], ], 'UseSameUsername' => [ 'base' => NULL, 'refs' => [ 'RadiusSettings$UseSameUsername' => 'Not currently used.
', ], ], 'UserDoesNotExistException' => [ 'base' => 'The user provided a username that does not exist in your directory.
', 'refs' => [], ], 'UserName' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettings$CustomerUserName' => '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
The user name of the service account in your self-managed directory.
', 'DisableSsoRequest$UserName' => '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.
', 'EnableSsoRequest$UserName' => '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.
', ], ], 'UserPassword' => [ 'base' => NULL, 'refs' => [ 'ResetUserPasswordRequest$NewPassword' => 'The new password that will be reset.
', ], ], 'VerifyTrustRequest' => [ 'base' => 'Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.
', 'refs' => [], ], 'VerifyTrustResult' => [ 'base' => 'Result of a VerifyTrust request.
', 'refs' => [], ], 'VpcId' => [ 'base' => NULL, 'refs' => [ 'DirectoryConnectSettings$VpcId' => 'The identifier of the VPC in which the AD Connector is created.
', 'DirectoryConnectSettingsDescription$VpcId' => 'The identifier of the VPC that the AD Connector is in.
', 'DirectoryVpcSettings$VpcId' => 'The identifier of the VPC in which to create the directory.
', 'DirectoryVpcSettingsDescription$VpcId' => 'The identifier of the VPC that the directory is in.
', 'DomainController$VpcId' => 'The identifier of the VPC that contains the domain controller.
', ], ], ],];