com.amazonaws.services.directory.AWSDirectoryService Maven / Gradle / Ivy
Show all versions of aws-java-sdk-directory Show documentation
/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights
* Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.directory;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.directory.model.*;
/**
* Interface for accessing Directory Service.
*
* AWS Directory Service
*
* This is the AWS Directory Service API Reference. This guide provides
* detailed information about AWS Directory Service operations, data types,
* parameters, and errors.
*
*/
public interface AWSDirectoryService {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "ds";
/**
* Overrides the default endpoint for this client
* ("https://ds.us-east-1.amazonaws.com"). Callers can use this method to
* control which AWS region they want to work with.
*
* 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 {@link 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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912
*
* 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.
*
* @param 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.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link 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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Adds or overwrites one or more tags for the specified Amazon Directory
* Services directory. Each directory can have a maximum of 10 tags. Each
* tag consists of a key and optional value. Tag keys must be unique per
* resource.
*
*
* @param addTagsToResourceRequest
* @return Result of the AddTagsToResource operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws TagLimitExceededException
* The maximum allowed number of tags was exceeded.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.AddTagsToResource
*/
AddTagsToResourceResult addTagsToResource(
AddTagsToResourceRequest addTagsToResourceRequest);
/**
*
* Creates an AD Connector to connect to an on-premises directory.
*
*
* @param connectDirectoryRequest
* Contains the inputs for the ConnectDirectory operation.
* @return Result of the ConnectDirectory operation returned by the service.
* @throws DirectoryLimitExceededException
* 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.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.ConnectDirectory
*/
ConnectDirectoryResult connectDirectory(
ConnectDirectoryRequest connectDirectoryRequest);
/**
*
* 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.
*
*
*
* @param createAliasRequest
* Contains the inputs for the CreateAlias operation.
* @return Result of the CreateAlias operation returned by the service.
* @throws EntityAlreadyExistsException
* The specified entity already exists.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.CreateAlias
*/
CreateAliasResult createAlias(CreateAliasRequest createAliasRequest);
/**
*
* Creates a computer account in the specified directory, and joins the
* computer to the directory.
*
*
* @param createComputerRequest
* Contains the inputs for the CreateComputer operation.
* @return Result of the CreateComputer operation returned by the service.
* @throws AuthenticationFailedException
* An authentication error occurred.
* @throws DirectoryUnavailableException
* The specified directory is unavailable or could not be found.
* @throws EntityAlreadyExistsException
* The specified entity already exists.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws UnsupportedOperationException
* The operation is not supported.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.CreateComputer
*/
CreateComputerResult createComputer(
CreateComputerRequest createComputerRequest);
/**
*
* Creates a conditional forwarder associated with your AWS directory.
* Conditional forwarders are required in order to set up a trust
* relationship with another domain. The conditional forwarder points to the
* trusted domain.
*
*
* @param createConditionalForwarderRequest
* Initiates the creation of a conditional forwarder for your AWS
* Directory Service for Microsoft Active Directory. Conditional
* forwarders are required in order to set up a trust relationship
* with another domain.
* @return Result of the CreateConditionalForwarder operation returned by
* the service.
* @throws EntityAlreadyExistsException
* The specified entity already exists.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws DirectoryUnavailableException
* The specified directory is unavailable or could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws UnsupportedOperationException
* The operation is not supported.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.CreateConditionalForwarder
*/
CreateConditionalForwarderResult createConditionalForwarder(
CreateConditionalForwarderRequest createConditionalForwarderRequest);
/**
*
* Creates a Simple AD directory.
*
*
* @param createDirectoryRequest
* Contains the inputs for the CreateDirectory operation.
* @return Result of the CreateDirectory operation returned by the service.
* @throws DirectoryLimitExceededException
* 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.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.CreateDirectory
*/
CreateDirectoryResult createDirectory(
CreateDirectoryRequest createDirectoryRequest);
/**
*
* Creates a Microsoft AD in the AWS cloud.
*
*
* @param createMicrosoftADRequest
* Creates a Microsoft AD in the AWS cloud.
* @return Result of the CreateMicrosoftAD operation returned by the
* service.
* @throws DirectoryLimitExceededException
* 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.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @throws UnsupportedOperationException
* The operation is not supported.
* @sample AWSDirectoryService.CreateMicrosoftAD
*/
CreateMicrosoftADResult createMicrosoftAD(
CreateMicrosoftADRequest createMicrosoftADRequest);
/**
*
* Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS
* cloud.
*
*
*
* You cannot take snapshots of AD Connector directories.
*
*
*
* @param createSnapshotRequest
* Contains the inputs for the CreateSnapshot operation.
* @return Result of the CreateSnapshot operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws SnapshotLimitExceededException
* 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.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.CreateSnapshot
*/
CreateSnapshotResult createSnapshot(
CreateSnapshotRequest createSnapshotRequest);
/**
*
* AWS Directory Service for Microsoft Active Directory allows you to
* configure trust relationships. For example, you can establish a trust
* between your Microsoft AD in the AWS cloud, and your existing on-premises
* 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 AWS side of a trust
* relationship between a Microsoft AD in the AWS cloud and an external
* domain.
*
*
* @param createTrustRequest
* AWS Directory Service for Microsoft Active Directory allows you to
* configure trust relationships. For example, you can establish a
* trust between your Microsoft AD in the AWS cloud, and your
* existing on-premises 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 AWS side of a trust
* relationship between a Microsoft AD in the AWS cloud and an
* external domain.
* @return Result of the CreateTrust operation returned by the service.
* @throws EntityAlreadyExistsException
* The specified entity already exists.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @throws UnsupportedOperationException
* The operation is not supported.
* @sample AWSDirectoryService.CreateTrust
*/
CreateTrustResult createTrust(CreateTrustRequest createTrustRequest);
/**
*
* Deletes a conditional forwarder that has been set up for your AWS
* directory.
*
*
* @param deleteConditionalForwarderRequest
* Deletes a conditional forwarder.
* @return Result of the DeleteConditionalForwarder operation returned by
* the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws DirectoryUnavailableException
* The specified directory is unavailable or could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws UnsupportedOperationException
* The operation is not supported.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DeleteConditionalForwarder
*/
DeleteConditionalForwarderResult deleteConditionalForwarder(
DeleteConditionalForwarderRequest deleteConditionalForwarderRequest);
/**
*
* Deletes an AWS Directory Service directory.
*
*
* @param deleteDirectoryRequest
* Contains the inputs for the DeleteDirectory operation.
* @return Result of the DeleteDirectory operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DeleteDirectory
*/
DeleteDirectoryResult deleteDirectory(
DeleteDirectoryRequest deleteDirectoryRequest);
/**
*
* Deletes a directory snapshot.
*
*
* @param deleteSnapshotRequest
* Contains the inputs for the DeleteSnapshot operation.
* @return Result of the DeleteSnapshot operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DeleteSnapshot
*/
DeleteSnapshotResult deleteSnapshot(
DeleteSnapshotRequest deleteSnapshotRequest);
/**
*
* Deletes an existing trust relationship between your Microsoft AD in the
* AWS cloud and an external domain.
*
*
* @param deleteTrustRequest
* Deletes the local side of an existing trust relationship between
* the Microsoft AD in the AWS cloud and the external domain.
* @return Result of the DeleteTrust operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @throws UnsupportedOperationException
* The operation is not supported.
* @sample AWSDirectoryService.DeleteTrust
*/
DeleteTrustResult deleteTrust(DeleteTrustRequest deleteTrustRequest);
/**
*
* Removes the specified directory as a publisher to the specified SNS
* topic.
*
*
* @param deregisterEventTopicRequest
* Removes the specified directory as a publisher to the specified
* SNS topic.
* @return Result of the DeregisterEventTopic operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DeregisterEventTopic
*/
DeregisterEventTopicResult deregisterEventTopic(
DeregisterEventTopicRequest deregisterEventTopicRequest);
/**
*
* 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.
*
*
* @param describeConditionalForwardersRequest
* Describes a conditional forwarder.
* @return Result of the DescribeConditionalForwarders operation returned by
* the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws DirectoryUnavailableException
* The specified directory is unavailable or could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws UnsupportedOperationException
* The operation is not supported.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DescribeConditionalForwarders
*/
DescribeConditionalForwardersResult describeConditionalForwarders(
DescribeConditionalForwardersRequest describeConditionalForwardersRequest);
/**
*
* 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.
*
*
* @param describeDirectoriesRequest
* Contains the inputs for the DescribeDirectories operation.
* @return Result of the DescribeDirectories operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws InvalidNextTokenException
* The NextToken value is not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DescribeDirectories
*/
DescribeDirectoriesResult describeDirectories(
DescribeDirectoriesRequest describeDirectoriesRequest);
/**
* Simplified method form for invoking the DescribeDirectories operation.
*
* @see #describeDirectories(DescribeDirectoriesRequest)
*/
DescribeDirectoriesResult describeDirectories();
/**
*
* Obtains information about which 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.
*
*
* @param describeEventTopicsRequest
* Describes event topics.
* @return Result of the DescribeEventTopics operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DescribeEventTopics
*/
DescribeEventTopicsResult describeEventTopics(
DescribeEventTopicsRequest describeEventTopicsRequest);
/**
*
* 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.
*
*
* @param describeSnapshotsRequest
* Contains the inputs for the DescribeSnapshots operation.
* @return Result of the DescribeSnapshots operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws InvalidNextTokenException
* The NextToken value is not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DescribeSnapshots
*/
DescribeSnapshotsResult describeSnapshots(
DescribeSnapshotsRequest describeSnapshotsRequest);
/**
* Simplified method form for invoking the DescribeSnapshots operation.
*
* @see #describeSnapshots(DescribeSnapshotsRequest)
*/
DescribeSnapshotsResult describeSnapshots();
/**
*
* 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.
*
*
* @param describeTrustsRequest
* Describes the trust relationships for a particular Microsoft AD in
* the AWS cloud. If no input parameters are are provided, such as
* directory ID or trust ID, this request describes all the trust
* relationships.
* @return Result of the DescribeTrusts operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidNextTokenException
* The NextToken value is not valid.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @throws UnsupportedOperationException
* The operation is not supported.
* @sample AWSDirectoryService.DescribeTrusts
*/
DescribeTrustsResult describeTrusts(
DescribeTrustsRequest describeTrustsRequest);
/**
*
* Disables multi-factor authentication (MFA) with the Remote Authentication
* Dial In User Service (RADIUS) server for an AD Connector directory.
*
*
* @param disableRadiusRequest
* Contains the inputs for the DisableRadius operation.
* @return Result of the DisableRadius operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DisableRadius
*/
DisableRadiusResult disableRadius(DisableRadiusRequest disableRadiusRequest);
/**
*
* Disables single-sign on for a directory.
*
*
* @param disableSsoRequest
* Contains the inputs for the DisableSso operation.
* @return Result of the DisableSso operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InsufficientPermissionsException
* The account does not have sufficient permission to perform the
* operation.
* @throws AuthenticationFailedException
* An authentication error occurred.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.DisableSso
*/
DisableSsoResult disableSso(DisableSsoRequest disableSsoRequest);
/**
*
* Enables multi-factor authentication (MFA) with the Remote Authentication
* Dial In User Service (RADIUS) server for an AD Connector directory.
*
*
* @param enableRadiusRequest
* Contains the inputs for the EnableRadius operation.
* @return Result of the EnableRadius operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws EntityAlreadyExistsException
* The specified entity already exists.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.EnableRadius
*/
EnableRadiusResult enableRadius(EnableRadiusRequest enableRadiusRequest);
/**
*
* Enables single-sign on for a directory.
*
*
* @param enableSsoRequest
* Contains the inputs for the EnableSso operation.
* @return Result of the EnableSso operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InsufficientPermissionsException
* The account does not have sufficient permission to perform the
* operation.
* @throws AuthenticationFailedException
* An authentication error occurred.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.EnableSso
*/
EnableSsoResult enableSso(EnableSsoRequest enableSsoRequest);
/**
*
* Obtains directory limit information for the current region.
*
*
* @param getDirectoryLimitsRequest
* Contains the inputs for the GetDirectoryLimits operation.
* @return Result of the GetDirectoryLimits operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.GetDirectoryLimits
*/
GetDirectoryLimitsResult getDirectoryLimits(
GetDirectoryLimitsRequest getDirectoryLimitsRequest);
/**
* Simplified method form for invoking the GetDirectoryLimits operation.
*
* @see #getDirectoryLimits(GetDirectoryLimitsRequest)
*/
GetDirectoryLimitsResult getDirectoryLimits();
/**
*
* Obtains the manual snapshot limits for a directory.
*
*
* @param getSnapshotLimitsRequest
* Contains the inputs for the GetSnapshotLimits operation.
* @return Result of the GetSnapshotLimits operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.GetSnapshotLimits
*/
GetSnapshotLimitsResult getSnapshotLimits(
GetSnapshotLimitsRequest getSnapshotLimitsRequest);
/**
*
* Lists all tags on an Amazon Directory Services directory.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidNextTokenException
* The NextToken value is not valid.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.ListTagsForResource
*/
ListTagsForResourceResult listTagsForResource(
ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Associates a directory with an SNS topic. This establishes the directory
* as a publisher to the specified 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.
*
*
* @param registerEventTopicRequest
* Registers a new event topic.
* @return Result of the RegisterEventTopic operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.RegisterEventTopic
*/
RegisterEventTopicResult registerEventTopic(
RegisterEventTopicRequest registerEventTopicRequest);
/**
*
* Removes tags from an Amazon Directory Services directory.
*
*
* @param removeTagsFromResourceRequest
* @return Result of the RemoveTagsFromResource operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.RemoveTagsFromResource
*/
RemoveTagsFromResourceResult removeTagsFromResource(
RemoveTagsFromResourceRequest removeTagsFromResourceRequest);
/**
*
* 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.
*
*
* @param restoreFromSnapshotRequest
* An object representing the inputs for the
* RestoreFromSnapshot operation.
* @return Result of the RestoreFromSnapshot operation returned by the
* service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.RestoreFromSnapshot
*/
RestoreFromSnapshotResult restoreFromSnapshot(
RestoreFromSnapshotRequest restoreFromSnapshotRequest);
/**
*
* Updates a conditional forwarder that has been set up for your AWS
* directory.
*
*
* @param updateConditionalForwarderRequest
* Updates a conditional forwarder.
* @return Result of the UpdateConditionalForwarder operation returned by
* the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws DirectoryUnavailableException
* The specified directory is unavailable or could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws UnsupportedOperationException
* The operation is not supported.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.UpdateConditionalForwarder
*/
UpdateConditionalForwarderResult updateConditionalForwarder(
UpdateConditionalForwarderRequest updateConditionalForwarderRequest);
/**
*
* Updates the Remote Authentication Dial In User Service (RADIUS) server
* information for an AD Connector directory.
*
*
* @param updateRadiusRequest
* Contains the inputs for the UpdateRadius operation.
* @return Result of the UpdateRadius operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @sample AWSDirectoryService.UpdateRadius
*/
UpdateRadiusResult updateRadius(UpdateRadiusRequest updateRadiusRequest);
/**
*
* AWS Directory Service for Microsoft Active Directory allows you to
* configure and verify trust relationships.
*
*
* This action verifies a trust relationship between your Microsoft AD in
* the AWS cloud and an external domain.
*
*
* @param verifyTrustRequest
* Initiates the verification of an existing trust relationship
* between a Microsoft AD in the AWS cloud and an external domain.
* @return Result of the VerifyTrust operation returned by the service.
* @throws EntityDoesNotExistException
* The specified entity could not be found.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws ClientException
* A client exception has occurred.
* @throws ServiceException
* An exception has occurred in AWS Directory Service.
* @throws UnsupportedOperationException
* The operation is not supported.
* @sample AWSDirectoryService.VerifyTrust
*/
VerifyTrustResult verifyTrust(VerifyTrustRequest verifyTrustRequest);
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request,
* typically used for debugging issues where a service isn't acting as
* expected. This data isn't considered part of the result data returned by
* an operation, so it's available through this separate, diagnostic
* interface.
*
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}