Package com.amazonaws.services.directory

Class AbstractAWSDirectoryService

java.lang.Object
com.amazonaws.services.directory.AbstractAWSDirectoryService
All Implemented Interfaces:
AWSDirectoryService
Direct Known Subclasses:
AbstractAWSDirectoryServiceAsync
public class AbstractAWSDirectoryService extends Object implements AWSDirectoryService
Abstract implementation of AWSDirectoryService. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

  • Constructor Details

    • AbstractAWSDirectoryService

      protected AbstractAWSDirectoryService()

  • Method Details

    • setEndpoint

      public void setEndpoint(String endpoint)
      Description copied from interface: AWSDirectoryService
      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 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.

      Specified by:
      setEndpoint in interface AWSDirectoryService
      Parameters:
      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.

    • setRegion

      public void setRegion(Region region)
      Description copied from interface: AWSDirectoryService
      An alternative to 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.

      Specified by:
      setRegion in interface AWSDirectoryService
      Parameters:
      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.
      See Also:

    • connectDirectory

      public ConnectDirectoryResult connectDirectory(ConnectDirectoryRequest request)
      Description copied from interface: AWSDirectoryService

      Creates an AD Connector to connect to an on-premises directory.

      Specified by:
      connectDirectory in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the ConnectDirectory operation.
      Returns:
      Result of the ConnectDirectory operation returned by the service.

    • createAlias

      public CreateAliasResult createAlias(CreateAliasRequest request)
      Description copied from interface: 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.

      Specified by:
      createAlias in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the CreateAlias operation.
      Returns:
      Result of the CreateAlias operation returned by the service.

    • createComputer

      public CreateComputerResult createComputer(CreateComputerRequest request)
      Description copied from interface: AWSDirectoryService

      Creates a computer account in the specified directory, and joins the computer to the directory.

      Specified by:
      createComputer in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the CreateComputer operation.
      Returns:
      Result of the CreateComputer operation returned by the service.

    • createConditionalForwarder

      public CreateConditionalForwarderResult createConditionalForwarder(CreateConditionalForwarderRequest request)
      Description copied from interface: AWSDirectoryService

      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.

      Specified by:
      createConditionalForwarder in interface AWSDirectoryService
      Parameters:
      request - 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.
      Returns:
      Result of the CreateConditionalForwarder operation returned by the service.

    • createDirectory

      public CreateDirectoryResult createDirectory(CreateDirectoryRequest request)
      Description copied from interface: AWSDirectoryService

      Creates a Simple AD directory.

      Specified by:
      createDirectory in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the CreateDirectory operation.
      Returns:
      Result of the CreateDirectory operation returned by the service.

    • createMicrosoftAD

      public CreateMicrosoftADResult createMicrosoftAD(CreateMicrosoftADRequest request)
      Description copied from interface: AWSDirectoryService
      Creates a Microsoft AD in the AWS cloud.
      Specified by:
      createMicrosoftAD in interface AWSDirectoryService
      Parameters:
      request - Creates a Microsoft AD in the AWS cloud.
      Returns:
      Result of the CreateMicrosoftAD operation returned by the service.

    • createSnapshot

      public CreateSnapshotResult createSnapshot(CreateSnapshotRequest request)
      Description copied from interface: AWSDirectoryService

      Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

      You cannot take snapshots of AD Connector directories.

      Specified by:
      createSnapshot in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the CreateSnapshot operation.
      Returns:
      Result of the CreateSnapshot operation returned by the service.

    • createTrust

      public CreateTrustResult createTrust(CreateTrustRequest request)
      Description copied from interface: AWSDirectoryService

      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.

      Specified by:
      createTrust in interface AWSDirectoryService
      Parameters:
      request - 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.

      Returns:
      Result of the CreateTrust operation returned by the service.

    • deleteConditionalForwarder

      public DeleteConditionalForwarderResult deleteConditionalForwarder(DeleteConditionalForwarderRequest request)
      Description copied from interface: AWSDirectoryService

      Deletes a conditional forwarder that has been set up for your AWS directory.

      Specified by:
      deleteConditionalForwarder in interface AWSDirectoryService
      Parameters:
      request -
      Returns:
      Result of the DeleteConditionalForwarder operation returned by the service.

    • deleteDirectory

      public DeleteDirectoryResult deleteDirectory(DeleteDirectoryRequest request)
      Description copied from interface: AWSDirectoryService

      Deletes an AWS Directory Service directory.

      Specified by:
      deleteDirectory in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DeleteDirectory operation.
      Returns:
      Result of the DeleteDirectory operation returned by the service.

    • deleteSnapshot

      public DeleteSnapshotResult deleteSnapshot(DeleteSnapshotRequest request)
      Description copied from interface: AWSDirectoryService

      Deletes a directory snapshot.

      Specified by:
      deleteSnapshot in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DeleteSnapshot operation.
      Returns:
      Result of the DeleteSnapshot operation returned by the service.

    • deleteTrust

      public DeleteTrustResult deleteTrust(DeleteTrustRequest request)
      Description copied from interface: AWSDirectoryService
      Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.
      Specified by:
      deleteTrust in interface AWSDirectoryService
      Parameters:
      request - Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.
      Returns:
      Result of the DeleteTrust operation returned by the service.

    • deregisterEventTopic

      public DeregisterEventTopicResult deregisterEventTopic(DeregisterEventTopicRequest request)
      Description copied from interface: AWSDirectoryService

      Removes the specified directory as a publisher to the specified SNS topic.

      Specified by:
      deregisterEventTopic in interface AWSDirectoryService
      Parameters:
      request - Removes the specified directory as a publisher to the specified SNS topic.
      Returns:
      Result of the DeregisterEventTopic operation returned by the service.

    • describeConditionalForwarders

      public DescribeConditionalForwardersResult describeConditionalForwarders(DescribeConditionalForwardersRequest request)
      Description copied from interface: 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.

      Specified by:
      describeConditionalForwarders in interface AWSDirectoryService
      Parameters:
      request -
      Returns:
      Result of the DescribeConditionalForwarders operation returned by the service.

    • describeDirectories

      public DescribeDirectoriesResult describeDirectories(DescribeDirectoriesRequest request)
      Description copied from interface: 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.

      Specified by:
      describeDirectories in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DescribeDirectories operation.
      Returns:
      Result of the DescribeDirectories operation returned by the service.

    • describeDirectories

      public DescribeDirectoriesResult describeDirectories()
      Description copied from interface: AWSDirectoryService
      Simplified method form for invoking the DescribeDirectories operation.
      Specified by:
      describeDirectories in interface AWSDirectoryService
      See Also:

    • describeEventTopics

      public DescribeEventTopicsResult describeEventTopics(DescribeEventTopicsRequest request)
      Description copied from interface: AWSDirectoryService

      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.

      Specified by:
      describeEventTopics in interface AWSDirectoryService
      Parameters:
      request -
      Returns:
      Result of the DescribeEventTopics operation returned by the service.

    • describeSnapshots

      public DescribeSnapshotsResult describeSnapshots(DescribeSnapshotsRequest request)
      Description copied from interface: 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.

      Specified by:
      describeSnapshots in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DescribeSnapshots operation.
      Returns:
      Result of the DescribeSnapshots operation returned by the service.

    • describeSnapshots

      public DescribeSnapshotsResult describeSnapshots()
      Description copied from interface: AWSDirectoryService
      Simplified method form for invoking the DescribeSnapshots operation.
      Specified by:
      describeSnapshots in interface AWSDirectoryService
      See Also:

    • describeTrusts

      public DescribeTrustsResult describeTrusts(DescribeTrustsRequest request)
      Description copied from interface: 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.

      Specified by:
      describeTrusts in interface AWSDirectoryService
      Parameters:
      request - 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.
      Returns:
      Result of the DescribeTrusts operation returned by the service.

    • disableRadius

      public DisableRadiusResult disableRadius(DisableRadiusRequest request)
      Description copied from interface: AWSDirectoryService

      Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

      Specified by:
      disableRadius in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DisableRadius operation.
      Returns:
      Result of the DisableRadius operation returned by the service.

    • disableSso

      public DisableSsoResult disableSso(DisableSsoRequest request)
      Description copied from interface: AWSDirectoryService

      Disables single-sign on for a directory.

      Specified by:
      disableSso in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the DisableSso operation.
      Returns:
      Result of the DisableSso operation returned by the service.

    • enableRadius

      public EnableRadiusResult enableRadius(EnableRadiusRequest request)
      Description copied from interface: AWSDirectoryService

      Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

      Specified by:
      enableRadius in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the EnableRadius operation.
      Returns:
      Result of the EnableRadius operation returned by the service.

    • enableSso

      public EnableSsoResult enableSso(EnableSsoRequest request)
      Description copied from interface: AWSDirectoryService

      Enables single-sign on for a directory.

      Specified by:
      enableSso in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the EnableSso operation.
      Returns:
      Result of the EnableSso operation returned by the service.

    • getDirectoryLimits

      public GetDirectoryLimitsResult getDirectoryLimits(GetDirectoryLimitsRequest request)
      Description copied from interface: AWSDirectoryService

      Obtains directory limit information for the current region.

      Specified by:
      getDirectoryLimits in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the GetDirectoryLimits operation.
      Returns:
      Result of the GetDirectoryLimits operation returned by the service.

    • getDirectoryLimits

      public GetDirectoryLimitsResult getDirectoryLimits()
      Description copied from interface: AWSDirectoryService
      Simplified method form for invoking the GetDirectoryLimits operation.
      Specified by:
      getDirectoryLimits in interface AWSDirectoryService
      See Also:

    • getSnapshotLimits

      public GetSnapshotLimitsResult getSnapshotLimits(GetSnapshotLimitsRequest request)
      Description copied from interface: AWSDirectoryService

      Obtains the manual snapshot limits for a directory.

      Specified by:
      getSnapshotLimits in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the GetSnapshotLimits operation.
      Returns:
      Result of the GetSnapshotLimits operation returned by the service.

    • registerEventTopic

      public RegisterEventTopicResult registerEventTopic(RegisterEventTopicRequest request)
      Description copied from interface: AWSDirectoryService

      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.

      Specified by:
      registerEventTopic in interface AWSDirectoryService
      Parameters:
      request -
      Returns:
      Result of the RegisterEventTopic operation returned by the service.

    • restoreFromSnapshot

      public RestoreFromSnapshotResult restoreFromSnapshot(RestoreFromSnapshotRequest request)
      Description copied from interface: 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.

      Specified by:
      restoreFromSnapshot in interface AWSDirectoryService
      Parameters:
      request - An object representing the inputs for the RestoreFromSnapshot operation.
      Returns:
      Result of the RestoreFromSnapshot operation returned by the service.

    • updateConditionalForwarder

      public UpdateConditionalForwarderResult updateConditionalForwarder(UpdateConditionalForwarderRequest request)
      Description copied from interface: AWSDirectoryService

      Updates a conditional forwarder that has been set up for your AWS directory.

      Specified by:
      updateConditionalForwarder in interface AWSDirectoryService
      Parameters:
      request -
      Returns:
      Result of the UpdateConditionalForwarder operation returned by the service.

    • updateRadius

      public UpdateRadiusResult updateRadius(UpdateRadiusRequest request)
      Description copied from interface: AWSDirectoryService

      Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

      Specified by:
      updateRadius in interface AWSDirectoryService
      Parameters:
      request - Contains the inputs for the UpdateRadius operation.
      Returns:
      Result of the UpdateRadius operation returned by the service.

    • verifyTrust

      public VerifyTrustResult verifyTrust(VerifyTrustRequest request)
      Description copied from interface: AWSDirectoryService

      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.

      Specified by:
      verifyTrust in interface AWSDirectoryService
      Parameters:
      request - Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.
      Returns:
      Result of the VerifyTrust operation returned by the service.

    • shutdown

      public void shutdown()
      Description copied from interface: AWSDirectoryService
      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.
      Specified by:
      shutdown in interface AWSDirectoryService

    • getCachedResponseMetadata

      public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      Description copied from interface: AWSDirectoryService
      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.

      Specified by:
      getCachedResponseMetadata in interface AWSDirectoryService
      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.