"documentation":"<p>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. <i>AddIpRoutes</i> adds this address block. You can also use <i>AddIpRoutes</i> to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC. </p> <p>Before you call <i>AddIpRoutes</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>AddIpRoutes</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
"documentation":"<p>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.</p>"
},
"CancelSchemaExtension":{
"name":"CancelSchemaExtension",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelSchemaExtensionRequest"},
"output":{"shape":"CancelSchemaExtensionResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>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; <code>Initializing</code>, <code>CreatingSnapshot</code>, and <code>UpdatingSchema</code>.</p>"
"documentation":"<p>Creates an AD Connector to connect to a self-managed directory.</p> <p>Before you call <code>ConnectDirectory</code>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <code>ConnectDirectory</code> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
"documentation":"<p>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 <code>http://<alias>.awsapps.com</code>.</p> <important> <p>After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.</p> </important>"
"documentation":"<p>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.</p>"
"documentation":"<p>Creates a Simple AD directory. For more information, see <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html\">Simple Active Directory</a> in the <i>Directory Service Admin Guide</i>.</p> <p>Before you call <code>CreateDirectory</code>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <code>CreateDirectory</code> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html\">Managed Microsoft AD</a> in the <i>Directory Service Admin Guide</i>.</p> <p>Before you call <i>CreateMicrosoftAD</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateMicrosoftAD</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
"documentation":"<p>Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.</p> <note> <p>You cannot take snapshots of AD Connector directories.</p> </note>"
"documentation":"<p>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.</p> <p>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.</p>"
"documentation":"<p>Deletes an Directory Service directory.</p> <p>Before you call <code>DeleteDirectory</code>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <code>DeleteDirectory</code> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
"documentation":"<p>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 <code>SmartCard</code> is supported. </p>"
"documentation":"<p>Obtains information about the conditional forwarders for this account.</p> <p>If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.</p>"
"documentation":"<p>Obtains information about the directories that belong to this account.</p> <p>You can retrieve information about specific directories by passing the directory identifiers in the <code>DirectoryIds</code> parameter. Otherwise, all directories that belong to the current account are returned.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>DescribeDirectoriesResult.NextToken</code> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items.</p> <p>You can also specify a maximum number of return results with the <code>Limit</code> parameter.</p>"
"documentation":"<p>Obtains information about which Amazon SNS topics receive status messages from the specified directory.</p> <p>If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.</p>"
"documentation":"<p>Obtains information about the directory snapshots that belong to this account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items.</p> <p>You can also specify a maximum number of return results with the <i>Limit</i> parameter.</p>"
"documentation":"<p>Obtains information about the trust relationships for this account.</p> <p>If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.</p>"
"documentation":"<p>Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.</p>"
"documentation":"<p>Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Stops all replication and removes the domain controllers from the specified Region. You cannot remove the primary Region with this operation. Instead, use the <code>DeleteDirectory</code> API.</p>"
"documentation":"<p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory.</p> <p>You can reset the password for any user in your directory with the following exceptions:</p> <ul> <li> <p>For Simple AD, you cannot reset the password for any user that is a member of either the <b>Domain Admins</b> or <b>Enterprise Admins</b> group except for the administrator user.</p> </li> <li> <p>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 <b>Amazon Web Services Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD directory, see <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html\">What Gets Created</a> in the <i>Directory Service Administration Guide</i>.</p> </li> </ul>"
"documentation":"<p>Restores a directory using an existing directory snapshot.</p> <p>When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.</p> <p>This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete.</p>"
"documentation":"<p>Shares a specified directory (<code>DirectoryId</code>) 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.</p> <p>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.</p> <p>The <code>ShareMethod</code> parameter determines whether the specified directory can be shared between Amazon Web Services accounts inside the same Amazon Web Services organization (<code>ORGANIZATIONS</code>). It also determines whether you can share the directory with any other Amazon Web Services account either inside or outside of the organization (<code>HANDSHAKE</code>).</p> <p>The <code>ShareNotes</code> parameter is only used when <code>HANDSHAKE</code> is called, which sends a directory sharing request to the directory consumer. </p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.</p>"
"documentation":"<p>Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.</p> <p>This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.</p>"
"documentation":"<p>Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account. </p>"
}
}
},
"AcceptSharedDirectoryResult":{
"type":"structure",
"members":{
"SharedDirectory":{
"shape":"SharedDirectory",
"documentation":"<p>The shared directory in the directory consumer account.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>"
},
"ClientCertAuthSettings":{
"shape":"ClientCertAuthSettings",
"documentation":"<p>A <code>ClientCertAuthSettings</code> object that contains client certificate authentication settings.</p>"
"documentation":"<p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>"
"documentation":"<p>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. </p>"
},
"Status":{
"shape":"ClientAuthenticationStatus",
"documentation":"<p>Whether the client authentication type is enabled or disabled for the specified directory.</p>"
},
"LastUpdatedDateTime":{
"shape":"LastUpdatedDateTime",
"documentation":"<p>The date and time when the status of the client authentication type was last updated.</p>"
}
},
"documentation":"<p>Contains information about a client authentication method for a directory.</p>"
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Contains information about the client certificate authentication settings for the <code>RegisterCertificate</code> and <code>DescribeCertificate</code> operations. </p>"
"documentation":"<p>The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.</p>"
},
"DnsIpAddrs":{
"shape":"DnsIpAddrs",
"documentation":"<p>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.</p>"
"documentation":"<p>The replication scope of the conditional forwarder. The only allowed value is <code>Domain</code>, which will replicate the conditional forwarder to all of the domain controllers for your Amazon Web Services directory.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The requested alias.</p> <p>The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an <code>EntityAlreadyExistsException</code> error if the alias already exists.</p>"
"documentation":"<p>The name of the computer account.</p>"
},
"Password":{
"shape":"ComputerPassword",
"documentation":"<p>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.</p>"
},
"OrganizationalUnitDistinguishedName":{
"shape":"OrganizationalUnitDN",
"documentation":"<p>The fully-qualified distinguished name of the organizational unit to place the computer account in.</p>"
},
"ComputerAttributes":{
"shape":"Attributes",
"documentation":"<p>An array of <a>Attribute</a> objects that contain any LDAP attributes to apply to the computer account.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>CreateComputer</a> operation.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The password for the directory administrator. The directory creation process creates a directory administrator account with the user name <code>Administrator</code> and this password.</p> <p>If you need to change the password for the administrator account, you can use the <a>ResetUserPassword</a> API call.</p> <p>The regex pattern for this string is made up of the following conditions:</p> <ul> <li> <p>Length (?=^.{8,64}$) – Must be between 8 and 64 characters</p> </li> </ul> <p>AND any 3 of the following password complexity rules required by Active Directory:</p> <ul> <li> <p>Numbers and upper case and lowercase (?=.*\\d)(?=.*[A-Z])(?=.*[a-z])</p> </li> <li> <p>Numbers and special characters and lower case (?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])</p> </li> <li> <p>Special characters and upper case and lower case (?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])</p> </li> <li> <p>Numbers and upper case and special characters (?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s])</p> </li> </ul> <p>For additional information about how Active Directory passwords are enforced, see <a href=\"https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements\">Password must meet complexity requirements</a> on the Microsoft website.</p>"
"documentation":"<p>The fully qualified domain name for the Managed Microsoft AD directory, such as <code>corp.example.com</code>. This name will resolve inside your VPC only. It does not need to be publicly resolvable.</p>"
"documentation":"<p>The NetBIOS name for your domain, such as <code>CORP</code>. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, <code>CORP</code> for the directory DNS <code>corp.example.com</code>. </p>"
"documentation":"<p>The password for the default administrative user named <code>Admin</code>.</p> <p>If you need to change the password for the administrator account, you can use the <a>ResetUserPassword</a> API call.</p>"
"documentation":"<p>A description for the directory. This label will appear on the Amazon Web Services console <code>Directory Details</code> page after the directory is created.</p>"
"documentation":"<p>Managed Microsoft AD is available in two editions: <code>Standard</code> and <code>Enterprise</code>. <code>Enterprise</code> is the default.</p>"
"documentation":"<p>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.</p> <p>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.</p>"
"documentation":"<p>The identifier of the directory.</p>"
},
"CertificateId":{
"shape":"CertificateId",
"documentation":"<p>The identifier of the certificate.</p>"
}
}
},
"DescribeCertificateResult":{
"type":"structure",
"members":{
"Certificate":{
"shape":"Certificate",
"documentation":"<p>Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.</p>"
"documentation":"<p>The identifier of the directory for which to retrieve information.</p>"
},
"Type":{
"shape":"ClientAuthenticationType",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <i>DescribeClientAuthenticationSettingsResult.NextToken</i> value from a previous call to <a>DescribeClientAuthenticationSettings</a>. Pass null if this is the first call.</p>"
},
"Limit":{
"shape":"PageLimit",
"documentation":"<p>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. </p>"
}
}
},
"DescribeClientAuthenticationSettingsResult":{
"type":"structure",
"members":{
"ClientAuthenticationSettingsInfo":{
"shape":"ClientAuthenticationSettingsInfo",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.</p>"
"documentation":"<p>The directory ID for which to get the list of associated conditional forwarders.</p>"
},
"RemoteDomainNames":{
"shape":"RemoteDomainNames",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Describes a conditional forwarder.</p>"
},
"DescribeConditionalForwardersResult":{
"type":"structure",
"members":{
"ConditionalForwarders":{
"shape":"ConditionalForwarders",
"documentation":"<p>The list of conditional forwarders that have been created.</p>"
}
},
"documentation":"<p>The result of a DescribeConditionalForwarder request.</p>"
"documentation":"<p>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.</p> <p>An empty list results in an <code>InvalidParameterException</code> being thrown.</p>"
"documentation":"<p>The <code>DescribeDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeDirectories</a>. Pass null if this is the first call.</p>"
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>DescribeDirectories</a> operation.</p>"
"documentation":"<p>The list of <a>DirectoryDescription</a> objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <code>Limit</code> 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.</p>"
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <a>DescribeDirectories</a> to retrieve the next set of items.</p>"
"documentation":"<p>Identifier of the directory for which to retrieve the domain controller information.</p>"
},
"DomainControllerIds":{
"shape":"DomainControllerIds",
"documentation":"<p>A list of identifiers for the domain controllers whose information will be provided.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <i>DescribeDomainControllers.NextToken</i> value from a previous call to <a>DescribeDomainControllers</a>. Pass null if this is the first call. </p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of items to return.</p>"
}
}
},
"DescribeDomainControllersResult":{
"type":"structure",
"members":{
"DomainControllers":{
"shape":"DomainControllers",
"documentation":"<p>List of the <a>DomainController</a> objects that were retrieved.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <a>DescribeDomainControllers</a> retrieve the next set of items.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p> <p>An empty list results in an <code>InvalidParameterException</code> being thrown.</p>"
"documentation":"<p>The type of next token used for pagination.</p>"
},
"Limit":{
"shape":"PageLimit",
"documentation":"<p>Specifies the number of items that should be displayed on one page.</p>"
}
}
},
"DescribeLDAPSSettingsResult":{
"type":"structure",
"members":{
"LDAPSSettingsInfo":{
"shape":"LDAPSSettingsInfo",
"documentation":"<p>Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.</p>"
"documentation":"<p>The identifier of the directory.</p>"
},
"RegionName":{
"shape":"RegionName",
"documentation":"<p>The name of the Region. For example, <code>us-east-1</code>.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>DescribeRegionsResult.NextToken</code> value from a previous call to <a>DescribeRegions</a>. Pass null if this is the first call.</p>"
}
}
},
"DescribeRegionsResult":{
"type":"structure",
"members":{
"RegionsDescription":{
"shape":"RegionsDescription",
"documentation":"<p>List of Region information related to the directory for each replicated Region.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <a>DescribeRegions</a> to retrieve the next set of items.</p>"
"documentation":"<p>Returns the identifier of the directory in the directory owner account. </p>"
},
"SharedDirectoryIds":{
"shape":"DirectoryIds",
"documentation":"<p>A list of identifiers of all shared directories in your account. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>DescribeSharedDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeSharedDirectories</a>. Pass null if this is the first call. </p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The number of shared directories to return in the response object.</p>"
}
}
},
"DescribeSharedDirectoriesResult":{
"type":"structure",
"members":{
"SharedDirectories":{
"shape":"SharedDirectories",
"documentation":"<p>A list of all shared directories in your account.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, token that indicates that more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <a>DescribeSharedDirectories</a> to retrieve the next set of items.</p>"
"documentation":"<p>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 <i>Limit</i> and <i>NextToken</i> members.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to <a>DescribeSnapshots</a>. Pass null if this is the first call.</p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of objects to return.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>DescribeSnapshots</a> operation.</p>"
},
"DescribeSnapshotsResult":{
"type":"structure",
"members":{
"Snapshots":{
"shape":"Snapshots",
"documentation":"<p>The list of <a>Snapshot</a> objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <i>Limit</i> 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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value in the <i>NextToken</i> member of a subsequent call to <a>DescribeSnapshots</a>.</p>"
}
},
"documentation":"<p>Contains the results of the <a>DescribeSnapshots</a> operation.</p>"
"documentation":"<p>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.</p> <p>An empty list results in an <code>InvalidParameterException</code> being thrown.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <i>DescribeTrustsResult.NextToken</i> value from a previous call to <a>DescribeTrusts</a>. Pass null if this is the first call.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The list of Trust objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <i>Limit</i> 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.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <i>NextToken</i> parameter in a subsequent call to <a>DescribeTrusts</a> to retrieve the next set of items.</p>"
"documentation":"<p>The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.</p>",
"documentation":"<p>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:</p> <ul> <li> <p>Read users and groups</p> </li> <li> <p>Create computer objects</p> </li> <li> <p>Join computers to the domain</p> </li> </ul>"
"documentation":"<p>The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as <code>d-XXXXXXXXXX</code>.</p>"
"documentation":"<p>The access URL for the directory, such as <code>http://<alias>.awsapps.com</code>. If no alias has been created for the directory, <code><alias></code> is the directory identifier, such as <code>d-XXXXXXXXXX</code>.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by sending a shared directory request (<code>HANDSHAKE</code>).</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>A <a>DirectoryVpcSettingsDescription</a> 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.</p>"
"documentation":"<p>A <a>DirectoryConnectSettingsDescription</a> object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.</p>"
},
"RadiusSettings":{
"shape":"RadiusSettings",
"documentation":"<p>A <a>RadiusSettings</a> object that contains information about the RADIUS server configured for this directory.</p>"
},
"RadiusStatus":{
"shape":"RadiusStatus",
"documentation":"<p>The status of the RADIUS MFA server connection.</p>"
},
"StageReason":{
"shape":"StageReason",
"documentation":"<p>Additional information about the directory stage.</p>"
"documentation":"<p>The maximum number of directories in the region has been reached. You can use the <a>GetDirectoryLimits</a> operation to determine your directory limits in the region.</p>",
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p> <p>If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> 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.</p>"
"documentation":"<p>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 <i>UserName</i> parameter.</p>"
"documentation":"<p>Identifier of the directory where the domain controller resides.</p>"
},
"DomainControllerId":{
"shape":"DomainControllerId",
"documentation":"<p>Identifies a specific domain controller in the directory.</p>"
},
"DnsIpAddr":{
"shape":"IpAddr",
"documentation":"<p>The IP address of the domain controller.</p>"
},
"VpcId":{
"shape":"VpcId",
"documentation":"<p>The identifier of the VPC that contains the domain controller.</p>"
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>Identifier of the subnet in the VPC that contains the domain controller.</p>"
},
"AvailabilityZone":{
"shape":"AvailabilityZone",
"documentation":"<p>The Availability Zone where the domain controller is located.</p>"
},
"Status":{
"shape":"DomainControllerStatus",
"documentation":"<p>The status of the domain controller.</p>"
},
"StatusReason":{
"shape":"DomainControllerStatusReason",
"documentation":"<p>A description of the domain controller state.</p>"
},
"LaunchTime":{
"shape":"LaunchTime",
"documentation":"<p>Specifies when the domain controller was created.</p>"
},
"StatusLastUpdatedDateTime":{
"shape":"LastUpdatedDateTime",
"documentation":"<p>The date and time that the status was last updated.</p>"
}
},
"documentation":"<p>Contains information about the domain controllers for a specified directory.</p>"
},
"DomainControllerId":{
"type":"string",
"pattern":"^dc-[0-9a-f]{10}$"
},
"DomainControllerIds":{
"type":"list",
"member":{"shape":"DomainControllerId"}
},
"DomainControllerLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"RequestId":{"shape":"RequestId"}
},
"documentation":"<p>The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.</p>",
"documentation":"<p>The type of client authentication to enable. Currently only the value <code>SmartCard</code> 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. </p>"
"documentation":"<p>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.</p> <p>If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the <i>UserName</i> and <i>Password</i> 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.</p>"
"documentation":"<p>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 <i>UserName</i> parameter.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The identifier of the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>A token for requesting another page of certificates if the <code>NextToken</code> response element indicates that more certificates are available. Use the value of the returned <code>NextToken</code> element in your request until the token comes back as <code>null</code>. Pass <code>null</code> if this is the first call.</p>"
},
"Limit":{
"shape":"PageLimit",
"documentation":"<p>The number of items that should show up on one page</p>"
}
}
},
"ListCertificatesResult":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.</p>"
},
"CertificatesInfo":{
"shape":"CertificatesInfo",
"documentation":"<p>A list of certificates with basic details including certificate ID, certificate common name, certificate state.</p>"
"documentation":"<p>Identifier (ID) of the directory for which you want to retrieve the IP addresses.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <i>ListIpRoutes.NextToken</i> value from a previous call to <a>ListIpRoutes</a>. Pass null if this is the first call.</p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.</p>"
}
}
},
"ListIpRoutesResult":{
"type":"structure",
"members":{
"IpRoutesInfo":{
"shape":"IpRoutesInfo",
"documentation":"<p>A list of <a>IpRoute</a>s.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <i>NextToken</i> parameter in a subsequent call to <a>ListIpRoutes</a> to retrieve the next set of items.</p>"
"documentation":"<p>If a <i>DirectoryID</i> is provided, lists only the log subscription associated with that directory. If no <i>DirectoryId</i> 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.</p>"
"documentation":"<p>The identifier of the directory from which to retrieve the schema extension information.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>The <code>ListSchemaExtensions.NextToken</code> value from a previous call to <code>ListSchemaExtensions</code>. Pass null if this is the first call.</p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of items to return.</p>"
}
}
},
"ListSchemaExtensionsResult":{
"type":"structure",
"members":{
"SchemaExtensionsInfo":{
"shape":"SchemaExtensionsInfo",
"documentation":"<p>Information about the schema extensions applied to the directory.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <code>ListSchemaExtensions</code> to retrieve the next set of items.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>"
},
"ClientCertAuthSettings":{
"shape":"ClientCertAuthSettings",
"documentation":"<p>A <code>ClientCertAuthSettings</code> object that contains client certificate authentication settings.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.</p>"
}
}
},
"RejectSharedDirectoryResult":{
"type":"structure",
"members":{
"SharedDirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Identifier of the shared directory in the directory consumer account.</p>"
"documentation":"<p>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.</p>"
},
"ShareTarget":{
"shape":"ShareTarget",
"documentation":"<p>Identifier for the directory consumer account with whom the directory is to be shared.</p>"
"documentation":"<p>The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by sending a directory sharing request (<code>HANDSHAKE</code>).</p>"
"documentation":"<p>Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (<code>DirectoryId</code>).</p>"
"documentation":"<p>The method used when sharing a directory to determine whether the directory should be shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by sending a shared directory request (<code>HANDSHAKE</code>).</p>"
"documentation":"<p>Identifier of the directory consumer account that has access to the shared directory (<code>OwnerDirectoryId</code>) in the directory owner account.</p>"
},
"SharedDirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.</p>"
"documentation":"<p>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.</p>"
},
"CreatedDateTime":{
"shape":"CreatedDateTime",
"documentation":"<p>The date and time that the shared directory was created.</p>"
},
"LastUpdatedDateTime":{
"shape":"LastUpdatedDateTime",
"documentation":"<p>The date and time that the shared directory was last updated.</p>"
}
},
"documentation":"<p>Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.</p>"
"documentation":"<p>The maximum number of manual snapshots for the directory has been reached. You can use the <a>GetSnapshotLimits</a> operation to determine the snapshot limits for a directory.</p>",
"documentation":"<p>The identifier of the directory for which the schema extension will be applied to.</p>"
},
"CreateSnapshotBeforeSchemaExtension":{
"shape":"CreateSnapshotBeforeSchemaExtension",
"documentation":"<p>If true, creates a snapshot of the directory before applying the schema extension.</p>"
},
"LdifContent":{
"shape":"LdifContent",
"documentation":"<p>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.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A description of the schema extension.</p>"
}
}
},
"StartSchemaExtensionResult":{
"type":"structure",
"members":{
"SchemaExtensionId":{
"shape":"SchemaExtensionId",
"documentation":"<p>The identifier of the schema extension that will be applied.</p>"
"documentation":"<p>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}_.:/=+\\\\-]*)$\").</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>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}_.:/=+\\\\-]*)$\").</p>"
"documentation":"<p>Identifier for the directory consumer account with whom the directory has to be unshared.</p>"
}
}
},
"UnshareDirectoryResult":{
"type":"structure",
"members":{
"SharedDirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (<code>DirectoryId</code>).</p>"
}
}
},
"UnshareTarget":{
"type":"structure",
"required":[
"Id",
"Type"
],
"members":{
"Id":{
"shape":"TargetId",
"documentation":"<p>Identifier of the directory consumer account.</p>"
},
"Type":{
"shape":"TargetType",
"documentation":"<p>Type of identifier to be used in the <i>Id</i> field.</p>"
}
},
"documentation":"<p>Identifier that contains details about the directory consumer account with whom the directory is being unshared.</p>"
"documentation":"<p>Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and an external domain.</p>"
"documentation":"<fullname>Directory Service</fullname> <p>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 <a href=\"https://aws.amazon.com/directoryservice/\">Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">Directory Service Administration Guide</a>.</p> <note> <p>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 <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note>"