@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSDirectoryService extends Object implements AWSDirectoryService
AWSDirectoryService
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AcceptSharedDirectoryResult |
acceptSharedDirectory(AcceptSharedDirectoryRequest request)
Accepts a directory sharing request that was sent from the directory owner account.
|
AddIpRoutesResult |
addIpRoutes(AddIpRoutesRequest request)
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.
|
AddRegionResult |
addRegion(AddRegionRequest request)
Adds two domain controllers in the specified Region for the specified directory.
|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest request)
Adds or overwrites one or more tags for the specified directory.
|
CancelSchemaExtensionResult |
cancelSchemaExtension(CancelSchemaExtensionRequest request)
Cancels an in-progress schema extension to a Microsoft AD directory.
|
ConnectDirectoryResult |
connectDirectory(ConnectDirectoryRequest request)
Creates an AD Connector to connect to a self-managed directory.
|
CreateAliasResult |
createAlias(CreateAliasRequest request)
Creates an alias for a directory and assigns the alias to the directory.
|
CreateComputerResult |
createComputer(CreateComputerRequest request)
Creates an Active Directory computer object in the specified directory.
|
CreateConditionalForwarderResult |
createConditionalForwarder(CreateConditionalForwarderRequest request)
Creates a conditional forwarder associated with your Amazon Web Services directory.
|
CreateDirectoryResult |
createDirectory(CreateDirectoryRequest request)
Creates a Simple AD directory.
|
CreateLogSubscriptionResult |
createLogSubscription(CreateLogSubscriptionRequest request)
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.
|
CreateMicrosoftADResult |
createMicrosoftAD(CreateMicrosoftADRequest request)
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
|
CreateSnapshotResult |
createSnapshot(CreateSnapshotRequest request)
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
|
CreateTrustResult |
createTrust(CreateTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure trust relationships.
|
DeleteConditionalForwarderResult |
deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
|
DeleteDirectoryResult |
deleteDirectory(DeleteDirectoryRequest request)
Deletes an Directory Service directory.
|
DeleteLogSubscriptionResult |
deleteLogSubscription(DeleteLogSubscriptionRequest request)
Deletes the specified log subscription.
|
DeleteSnapshotResult |
deleteSnapshot(DeleteSnapshotRequest request)
Deletes a directory snapshot.
|
DeleteTrustResult |
deleteTrust(DeleteTrustRequest request)
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
|
DeregisterCertificateResult |
deregisterCertificate(DeregisterCertificateRequest request)
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
|
DeregisterEventTopicResult |
deregisterEventTopic(DeregisterEventTopicRequest request)
Removes the specified directory as a publisher to the specified Amazon SNS topic.
|
DescribeCertificateResult |
describeCertificate(DescribeCertificateRequest request)
Displays information about the certificate registered for secure LDAP or client certificate authentication.
|
DescribeClientAuthenticationSettingsResult |
describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)
Retrieves information about the type of client authentication for the specified directory, if the type is
specified.
|
DescribeConditionalForwardersResult |
describeConditionalForwarders(DescribeConditionalForwardersRequest request)
Obtains information about the conditional forwarders for this account.
|
DescribeDirectoriesResult |
describeDirectories()
Simplified method form for invoking the DescribeDirectories operation.
|
DescribeDirectoriesResult |
describeDirectories(DescribeDirectoriesRequest request)
Obtains information about the directories that belong to this account.
|
DescribeDomainControllersResult |
describeDomainControllers(DescribeDomainControllersRequest request)
Provides information about any domain controllers in your directory.
|
DescribeEventTopicsResult |
describeEventTopics(DescribeEventTopicsRequest request)
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
|
DescribeLDAPSSettingsResult |
describeLDAPSSettings(DescribeLDAPSSettingsRequest request)
Describes the status of LDAP security for the specified directory.
|
DescribeRegionsResult |
describeRegions(DescribeRegionsRequest request)
Provides information about the Regions that are configured for multi-Region replication.
|
DescribeSettingsResult |
describeSettings(DescribeSettingsRequest request)
Retrieves information about the configurable settings for the specified directory.
|
DescribeSharedDirectoriesResult |
describeSharedDirectories(DescribeSharedDirectoriesRequest request)
Returns the shared directories in your account.
|
DescribeSnapshotsResult |
describeSnapshots()
Simplified method form for invoking the DescribeSnapshots operation.
|
DescribeSnapshotsResult |
describeSnapshots(DescribeSnapshotsRequest request)
Obtains information about the directory snapshots that belong to this account.
|
DescribeTrustsResult |
describeTrusts(DescribeTrustsRequest request)
Obtains information about the trust relationships for this account.
|
DescribeUpdateDirectoryResult |
describeUpdateDirectory(DescribeUpdateDirectoryRequest request)
Describes the updates of a directory for a particular update type.
|
DisableClientAuthenticationResult |
disableClientAuthentication(DisableClientAuthenticationRequest request)
Disables alternative client authentication methods for the specified directory.
|
DisableLDAPSResult |
disableLDAPS(DisableLDAPSRequest request)
Deactivates LDAP secure calls for the specified directory.
|
DisableRadiusResult |
disableRadius(DisableRadiusRequest request)
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server
for an AD Connector or Microsoft AD directory.
|
DisableSsoResult |
disableSso(DisableSsoRequest request)
Disables single-sign on for a directory.
|
EnableClientAuthenticationResult |
enableClientAuthentication(EnableClientAuthenticationRequest request)
Enables alternative client authentication methods for the specified directory.
|
EnableLDAPSResult |
enableLDAPS(EnableLDAPSRequest request)
Activates the switch for the specific directory to always use LDAP secure calls.
|
EnableRadiusResult |
enableRadius(EnableRadiusRequest request)
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for
an AD Connector or Microsoft AD directory.
|
EnableSsoResult |
enableSso(EnableSsoRequest request)
Enables single sign-on for a directory.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDirectoryLimitsResult |
getDirectoryLimits()
Simplified method form for invoking the GetDirectoryLimits operation.
|
GetDirectoryLimitsResult |
getDirectoryLimits(GetDirectoryLimitsRequest request)
Obtains directory limit information for the current Region.
|
GetSnapshotLimitsResult |
getSnapshotLimits(GetSnapshotLimitsRequest request)
Obtains the manual snapshot limits for a directory.
|
ListCertificatesResult |
listCertificates(ListCertificatesRequest request)
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate
authentication.
|
ListIpRoutesResult |
listIpRoutes(ListIpRoutesRequest request)
Lists the address blocks that you have added to a directory.
|
ListLogSubscriptionsResult |
listLogSubscriptions(ListLogSubscriptionsRequest request)
Lists the active log subscriptions for the Amazon Web Services account.
|
ListSchemaExtensionsResult |
listSchemaExtensions(ListSchemaExtensionsRequest request)
Lists all schema extensions applied to a Microsoft AD Directory.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all tags on a directory.
|
RegisterCertificateResult |
registerCertificate(RegisterCertificateRequest request)
Registers a certificate for a secure LDAP or client certificate authentication.
|
RegisterEventTopicResult |
registerEventTopic(RegisterEventTopicRequest request)
Associates a directory with an Amazon SNS topic.
|
RejectSharedDirectoryResult |
rejectSharedDirectory(RejectSharedDirectoryRequest request)
Rejects a directory sharing request that was sent from the directory owner account.
|
RemoveIpRoutesResult |
removeIpRoutes(RemoveIpRoutesRequest request)
Removes IP address blocks from a directory.
|
RemoveRegionResult |
removeRegion(RemoveRegionRequest request)
Stops all replication and removes the domain controllers from the specified Region.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest request)
Removes tags from a directory.
|
ResetUserPasswordResult |
resetUserPassword(ResetUserPasswordRequest request)
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
|
RestoreFromSnapshotResult |
restoreFromSnapshot(RestoreFromSnapshotRequest request)
Restores a directory using an existing directory snapshot.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://ds.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSDirectoryService.setEndpoint(String) , sets the regional endpoint for this client's
service calls. |
ShareDirectoryResult |
shareDirectory(ShareDirectoryRequest request)
Shares a specified directory (
DirectoryId ) in your Amazon Web Services account (directory owner)
with another Amazon Web Services account (directory consumer). |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartSchemaExtensionResult |
startSchemaExtension(StartSchemaExtensionRequest request)
Applies a schema extension to a Microsoft AD directory.
|
UnshareDirectoryResult |
unshareDirectory(UnshareDirectoryRequest request)
Stops the directory sharing between the directory owner and consumer accounts.
|
UpdateConditionalForwarderResult |
updateConditionalForwarder(UpdateConditionalForwarderRequest request)
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
|
UpdateDirectorySetupResult |
updateDirectorySetup(UpdateDirectorySetupRequest request)
Updates the directory for a particular update type.
|
UpdateNumberOfDomainControllersResult |
updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)
Adds or removes domain controllers to or from the directory.
|
UpdateRadiusResult |
updateRadius(UpdateRadiusRequest request)
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or
Microsoft AD directory.
|
UpdateSettingsResult |
updateSettings(UpdateSettingsRequest request)
Updates the configurable settings for the specified directory.
|
UpdateTrustResult |
updateTrust(UpdateTrustRequest request)
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active
Directory.
|
VerifyTrustResult |
verifyTrust(VerifyTrustRequest request)
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
|
public void setEndpoint(String endpoint)
AWSDirectoryService
Callers can pass in just the endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://ds.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this
client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint
in interface AWSDirectoryService
endpoint
- The endpoint (ex: "ds.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://ds.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AWSDirectoryService
AWSDirectoryService.setEndpoint(String)
, sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion
in interface AWSDirectoryService
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AcceptSharedDirectoryResult acceptSharedDirectory(AcceptSharedDirectoryRequest request)
AWSDirectoryService
Accepts a directory sharing request that was sent from the directory owner account.
acceptSharedDirectory
in interface AWSDirectoryService
public AddIpRoutesResult addIpRoutes(AddIpRoutesRequest request)
AWSDirectoryService
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.
addIpRoutes
in interface AWSDirectoryService
public AddRegionResult addRegion(AddRegionRequest request)
AWSDirectoryService
Adds two domain controllers in the specified Region for the specified directory.
addRegion
in interface AWSDirectoryService
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
AWSDirectoryService
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.
addTagsToResource
in interface AWSDirectoryService
public CancelSchemaExtensionResult cancelSchemaExtension(CancelSchemaExtensionRequest request)
AWSDirectoryService
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
.
cancelSchemaExtension
in interface AWSDirectoryService
public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)
AWSDirectoryService
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.
connectDirectory
in interface AWSDirectoryService
request
- Contains the inputs for the ConnectDirectory operation.public CreateAliasResult createAlias(CreateAliasRequest request)
AWSDirectoryService
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.
createAlias
in interface AWSDirectoryService
request
- Contains the inputs for the CreateAlias operation.public CreateComputerResult createComputer(CreateComputerRequest request)
AWSDirectoryService
Creates an Active Directory computer object in the specified directory.
createComputer
in interface AWSDirectoryService
request
- Contains the inputs for the CreateComputer operation.public CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest request)
AWSDirectoryService
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.
createConditionalForwarder
in interface AWSDirectoryService
request
- 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.public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
AWSDirectoryService
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.
createDirectory
in interface AWSDirectoryService
request
- Contains the inputs for the CreateDirectory operation.public CreateLogSubscriptionResult createLogSubscription(CreateLogSubscriptionRequest request)
AWSDirectoryService
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.
createLogSubscription
in interface AWSDirectoryService
public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)
AWSDirectoryService
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.
createMicrosoftAD
in interface AWSDirectoryService
request
- Creates an Managed Microsoft AD directory.public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
AWSDirectoryService
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.
createSnapshot
in interface AWSDirectoryService
request
- Contains the inputs for the CreateSnapshot operation.public CreateTrustResult createTrust(CreateTrustRequest request)
AWSDirectoryService
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.
createTrust
in interface AWSDirectoryService
request
- 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.
public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
AWSDirectoryService
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
deleteConditionalForwarder
in interface AWSDirectoryService
request
- Deletes a conditional forwarder.public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
AWSDirectoryService
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.
deleteDirectory
in interface AWSDirectoryService
request
- Contains the inputs for the DeleteDirectory operation.public DeleteLogSubscriptionResult deleteLogSubscription(DeleteLogSubscriptionRequest request)
AWSDirectoryService
Deletes the specified log subscription.
deleteLogSubscription
in interface AWSDirectoryService
public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
AWSDirectoryService
Deletes a directory snapshot.
deleteSnapshot
in interface AWSDirectoryService
request
- Contains the inputs for the DeleteSnapshot operation.public DeleteTrustResult deleteTrust(DeleteTrustRequest request)
AWSDirectoryService
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
deleteTrust
in interface AWSDirectoryService
request
- Deletes the local side of an existing trust relationship between the Managed Microsoft AD directory and
the external domain.public DeregisterCertificateResult deregisterCertificate(DeregisterCertificateRequest request)
AWSDirectoryService
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
deregisterCertificate
in interface AWSDirectoryService
public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest request)
AWSDirectoryService
Removes the specified directory as a publisher to the specified Amazon SNS topic.
deregisterEventTopic
in interface AWSDirectoryService
request
- Removes the specified directory as a publisher to the specified Amazon SNS topic.public DescribeCertificateResult describeCertificate(DescribeCertificateRequest request)
AWSDirectoryService
Displays information about the certificate registered for secure LDAP or client certificate authentication.
describeCertificate
in interface AWSDirectoryService
public DescribeClientAuthenticationSettingsResult describeClientAuthenticationSettings(DescribeClientAuthenticationSettingsRequest request)
AWSDirectoryService
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.
describeClientAuthenticationSettings
in interface AWSDirectoryService
public DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest request)
AWSDirectoryService
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.
describeConditionalForwarders
in interface AWSDirectoryService
request
- Describes a conditional forwarder.public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)
AWSDirectoryService
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.
describeDirectories
in interface AWSDirectoryService
request
- Contains the inputs for the DescribeDirectories operation.public DescribeDirectoriesResult describeDirectories()
AWSDirectoryService
describeDirectories
in interface AWSDirectoryService
AWSDirectoryService.describeDirectories(DescribeDirectoriesRequest)
public DescribeDomainControllersResult describeDomainControllers(DescribeDomainControllersRequest request)
AWSDirectoryService
Provides information about any domain controllers in your directory.
describeDomainControllers
in interface AWSDirectoryService
public DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest request)
AWSDirectoryService
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.
describeEventTopics
in interface AWSDirectoryService
request
- Describes event topics.public DescribeLDAPSSettingsResult describeLDAPSSettings(DescribeLDAPSSettingsRequest request)
AWSDirectoryService
Describes the status of LDAP security for the specified directory.
describeLDAPSSettings
in interface AWSDirectoryService
public DescribeRegionsResult describeRegions(DescribeRegionsRequest request)
AWSDirectoryService
Provides information about the Regions that are configured for multi-Region replication.
describeRegions
in interface AWSDirectoryService
public DescribeSettingsResult describeSettings(DescribeSettingsRequest request)
AWSDirectoryService
Retrieves information about the configurable settings for the specified directory.
describeSettings
in interface AWSDirectoryService
public DescribeSharedDirectoriesResult describeSharedDirectories(DescribeSharedDirectoriesRequest request)
AWSDirectoryService
Returns the shared directories in your account.
describeSharedDirectories
in interface AWSDirectoryService
public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
AWSDirectoryService
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.
describeSnapshots
in interface AWSDirectoryService
request
- Contains the inputs for the DescribeSnapshots operation.public DescribeSnapshotsResult describeSnapshots()
AWSDirectoryService
describeSnapshots
in interface AWSDirectoryService
AWSDirectoryService.describeSnapshots(DescribeSnapshotsRequest)
public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)
AWSDirectoryService
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.
describeTrusts
in interface AWSDirectoryService
request
- 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.public DescribeUpdateDirectoryResult describeUpdateDirectory(DescribeUpdateDirectoryRequest request)
AWSDirectoryService
Describes the updates of a directory for a particular update type.
describeUpdateDirectory
in interface AWSDirectoryService
public DisableClientAuthenticationResult disableClientAuthentication(DisableClientAuthenticationRequest request)
AWSDirectoryService
Disables alternative client authentication methods for the specified directory.
disableClientAuthentication
in interface AWSDirectoryService
public DisableLDAPSResult disableLDAPS(DisableLDAPSRequest request)
AWSDirectoryService
Deactivates LDAP secure calls for the specified directory.
disableLDAPS
in interface AWSDirectoryService
public DisableRadiusResult disableRadius(DisableRadiusRequest request)
AWSDirectoryService
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
disableRadius
in interface AWSDirectoryService
request
- Contains the inputs for the DisableRadius operation.public DisableSsoResult disableSso(DisableSsoRequest request)
AWSDirectoryService
Disables single-sign on for a directory.
disableSso
in interface AWSDirectoryService
request
- Contains the inputs for the DisableSso operation.public EnableClientAuthenticationResult enableClientAuthentication(EnableClientAuthenticationRequest request)
AWSDirectoryService
Enables alternative client authentication methods for the specified directory.
enableClientAuthentication
in interface AWSDirectoryService
public EnableLDAPSResult enableLDAPS(EnableLDAPSRequest request)
AWSDirectoryService
Activates the switch for the specific directory to always use LDAP secure calls.
enableLDAPS
in interface AWSDirectoryService
public EnableRadiusResult enableRadius(EnableRadiusRequest request)
AWSDirectoryService
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
enableRadius
in interface AWSDirectoryService
request
- Contains the inputs for the EnableRadius operation.public EnableSsoResult enableSso(EnableSsoRequest request)
AWSDirectoryService
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.
enableSso
in interface AWSDirectoryService
request
- Contains the inputs for the EnableSso operation.public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)
AWSDirectoryService
Obtains directory limit information for the current Region.
getDirectoryLimits
in interface AWSDirectoryService
request
- Contains the inputs for the GetDirectoryLimits operation.public GetDirectoryLimitsResult getDirectoryLimits()
AWSDirectoryService
getDirectoryLimits
in interface AWSDirectoryService
AWSDirectoryService.getDirectoryLimits(GetDirectoryLimitsRequest)
public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)
AWSDirectoryService
Obtains the manual snapshot limits for a directory.
getSnapshotLimits
in interface AWSDirectoryService
request
- Contains the inputs for the GetSnapshotLimits operation.public ListCertificatesResult listCertificates(ListCertificatesRequest request)
AWSDirectoryService
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
listCertificates
in interface AWSDirectoryService
public ListIpRoutesResult listIpRoutes(ListIpRoutesRequest request)
AWSDirectoryService
Lists the address blocks that you have added to a directory.
listIpRoutes
in interface AWSDirectoryService
public ListLogSubscriptionsResult listLogSubscriptions(ListLogSubscriptionsRequest request)
AWSDirectoryService
Lists the active log subscriptions for the Amazon Web Services account.
listLogSubscriptions
in interface AWSDirectoryService
public ListSchemaExtensionsResult listSchemaExtensions(ListSchemaExtensionsRequest request)
AWSDirectoryService
Lists all schema extensions applied to a Microsoft AD Directory.
listSchemaExtensions
in interface AWSDirectoryService
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSDirectoryService
Lists all tags on a directory.
listTagsForResource
in interface AWSDirectoryService
public RegisterCertificateResult registerCertificate(RegisterCertificateRequest request)
AWSDirectoryService
Registers a certificate for a secure LDAP or client certificate authentication.
registerCertificate
in interface AWSDirectoryService
public RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest request)
AWSDirectoryService
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.
registerEventTopic
in interface AWSDirectoryService
request
- Registers a new event topic.public RejectSharedDirectoryResult rejectSharedDirectory(RejectSharedDirectoryRequest request)
AWSDirectoryService
Rejects a directory sharing request that was sent from the directory owner account.
rejectSharedDirectory
in interface AWSDirectoryService
public RemoveIpRoutesResult removeIpRoutes(RemoveIpRoutesRequest request)
AWSDirectoryService
Removes IP address blocks from a directory.
removeIpRoutes
in interface AWSDirectoryService
public RemoveRegionResult removeRegion(RemoveRegionRequest request)
AWSDirectoryService
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.
removeRegion
in interface AWSDirectoryService
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
AWSDirectoryService
Removes tags from a directory.
removeTagsFromResource
in interface AWSDirectoryService
public ResetUserPasswordResult resetUserPassword(ResetUserPasswordRequest request)
AWSDirectoryService
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.
resetUserPassword
in interface AWSDirectoryService
public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)
AWSDirectoryService
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.
restoreFromSnapshot
in interface AWSDirectoryService
request
- An object representing the inputs for the RestoreFromSnapshot operation.public ShareDirectoryResult shareDirectory(ShareDirectoryRequest request)
AWSDirectoryService
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.
shareDirectory
in interface AWSDirectoryService
public StartSchemaExtensionResult startSchemaExtension(StartSchemaExtensionRequest request)
AWSDirectoryService
Applies a schema extension to a Microsoft AD directory.
startSchemaExtension
in interface AWSDirectoryService
public UnshareDirectoryResult unshareDirectory(UnshareDirectoryRequest request)
AWSDirectoryService
Stops the directory sharing between the directory owner and consumer accounts.
unshareDirectory
in interface AWSDirectoryService
public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest request)
AWSDirectoryService
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
updateConditionalForwarder
in interface AWSDirectoryService
request
- Updates a conditional forwarder.public UpdateDirectorySetupResult updateDirectorySetup(UpdateDirectorySetupRequest request)
AWSDirectoryService
Updates the directory for a particular update type.
updateDirectorySetup
in interface AWSDirectoryService
public UpdateNumberOfDomainControllersResult updateNumberOfDomainControllers(UpdateNumberOfDomainControllersRequest request)
AWSDirectoryService
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.
updateNumberOfDomainControllers
in interface AWSDirectoryService
public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)
AWSDirectoryService
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
updateRadius
in interface AWSDirectoryService
request
- Contains the inputs for the UpdateRadius operation.public UpdateSettingsResult updateSettings(UpdateSettingsRequest request)
AWSDirectoryService
Updates the configurable settings for the specified directory.
updateSettings
in interface AWSDirectoryService
public UpdateTrustResult updateTrust(UpdateTrustRequest request)
AWSDirectoryService
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
updateTrust
in interface AWSDirectoryService
public VerifyTrustResult verifyTrust(VerifyTrustRequest request)
AWSDirectoryService
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.
verifyTrust
in interface AWSDirectoryService
request
- Initiates the verification of an existing trust relationship between an Managed Microsoft AD directory and
an external domain.public void shutdown()
AWSDirectoryService
shutdown
in interface AWSDirectoryService
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSDirectoryService
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSDirectoryService
request
- The originally executed request.