DirectoryServiceClient Class

Member Function Documentation

DirectoryServiceClient::DirectoryServiceClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a DirectoryServiceClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

DirectoryServiceClient::DirectoryServiceClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads DirectoryServiceClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] AddIpRoutesResponse *DirectoryServiceClient::addIpRoutes(const AddIpRoutesRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an AddIpRoutesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. <i>AddIpRoutes</i> adds this address block. You can also use <i>AddIpRoutes</i> to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

</p

Before you call <i>AddIpRoutes</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>AddIpRoutes</i> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">AWS Directory Service API Permissions: Actions, Resources, and Conditions

[slot] AddTagsToResourceResponse *DirectoryServiceClient::addTagsToResource(const AddTagsToResourceRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an AddTagsToResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CancelSchemaExtensionResponse *DirectoryServiceClient::cancelSchemaExtension(const CancelSchemaExtensionRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CancelSchemaExtensionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; <code>Initializing</code>, <code>CreatingSnapshot</code>, and

[slot] ConnectDirectoryResponse *DirectoryServiceClient::connectDirectory(const ConnectDirectoryRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an ConnectDirectoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an AD Connector to connect to an on-premises

directory>

Before you call <i>ConnectDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>ConnectDirectory</i> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">AWS Directory Service API Permissions: Actions, Resources, and Conditions

[slot] CreateAliasResponse *DirectoryServiceClient::createAlias(const CreateAliasRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateAliasResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as

<code>http://&lt;alias&gt;.awsapps.com</code>> <b>

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely

[slot] CreateComputerResponse *DirectoryServiceClient::createComputer(const CreateComputerRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateComputerResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateConditionalForwarderResponse *DirectoryServiceClient::createConditionalForwarder(const CreateConditionalForwarderRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateConditionalForwarderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CreateDirectoryResponse *DirectoryServiceClient::createDirectory(const CreateDirectoryRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateDirectoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a Simple AD

directory>

Before you call <i>CreateDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateDirectory</i> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">AWS Directory Service API Permissions: Actions, Resources, and Conditions

[slot] CreateMicrosoftADResponse *DirectoryServiceClient::createMicrosoftAD(const CreateMicrosoftADRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateMicrosoftADResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a Microsoft AD in the AWS

cloud>

Before you call <i>CreateMicrosoftAD</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateMicrosoftAD</i> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">AWS Directory Service API Permissions: Actions, Resources, and Conditions

[slot] CreateSnapshotResponse *DirectoryServiceClient::createSnapshot(const CreateSnapshotRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateSnapshotResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

cloud> <note>

You cannot take snapshots of AD Connector

[slot] CreateTrustResponse *DirectoryServiceClient::createTrust(const CreateTrustRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an CreateTrustResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteConditionalForwarderResponse *DirectoryServiceClient::deleteConditionalForwarder(const DeleteConditionalForwarderRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DeleteConditionalForwarderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteDirectoryResponse *DirectoryServiceClient::deleteDirectory(const DeleteDirectoryRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DeleteDirectoryResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an AWS Directory Service

directory>

Before you call <i>DeleteDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>DeleteDirectory</i> operation, see <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html">AWS Directory Service API Permissions: Actions, Resources, and Conditions

[slot] DeleteSnapshotResponse *DirectoryServiceClient::deleteSnapshot(const DeleteSnapshotRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DeleteSnapshotResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes a directory

[slot] DeleteTrustResponse *DirectoryServiceClient::deleteTrust(const DeleteTrustRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DeleteTrustResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external

[slot] DeregisterEventTopicResponse *DirectoryServiceClient::deregisterEventTopic(const DeregisterEventTopicRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DeregisterEventTopicResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes the specified directory as a publisher to the specified SNS

[slot] DescribeConditionalForwardersResponse *DirectoryServiceClient::describeConditionalForwarders(const DescribeConditionalForwardersRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeConditionalForwardersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeDirectoriesResponse *DirectoryServiceClient::describeDirectories(const DescribeDirectoriesRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeDirectoriesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Obtains information about the directories that belong to this

account>

You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are

returned>

This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of

items>

You can also specify a maximum number of return results with the <i>Limit</i>

[slot] DescribeDomainControllersResponse *DirectoryServiceClient::describeDomainControllers(const DescribeDomainControllersRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeDomainControllersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Provides information about any domain controllers in your

[slot] DescribeEventTopicsResponse *DirectoryServiceClient::describeEventTopics(const DescribeEventTopicsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeEventTopicsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DescribeSnapshotsResponse *DirectoryServiceClient::describeSnapshots(const DescribeSnapshotsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeSnapshotsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Obtains information about the directory snapshots that belong to this

account>

This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of

items>

You can also specify a maximum number of return results with the <i>Limit</i>

[slot] DescribeTrustsResponse *DirectoryServiceClient::describeTrusts(const DescribeTrustsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DescribeTrustsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DisableRadiusResponse *DirectoryServiceClient::disableRadius(const DisableRadiusRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DisableRadiusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DisableSsoResponse *DirectoryServiceClient::disableSso(const DisableSsoRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an DisableSsoResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disables single-sign on for a

[slot] EnableRadiusResponse *DirectoryServiceClient::enableRadius(const EnableRadiusRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an EnableRadiusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] EnableSsoResponse *DirectoryServiceClient::enableSso(const EnableSsoRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an EnableSsoResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Enables single sign-on for a

[slot] GetDirectoryLimitsResponse *DirectoryServiceClient::getDirectoryLimits(const GetDirectoryLimitsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an GetDirectoryLimitsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Obtains directory limit information for the current

[slot] GetSnapshotLimitsResponse *DirectoryServiceClient::getSnapshotLimits(const GetSnapshotLimitsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an GetSnapshotLimitsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Obtains the manual snapshot limits for a

[slot] ListIpRoutesResponse *DirectoryServiceClient::listIpRoutes(const ListIpRoutesRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an ListIpRoutesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists the address blocks that you have added to a

[slot] ListSchemaExtensionsResponse *DirectoryServiceClient::listSchemaExtensions(const ListSchemaExtensionsRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an ListSchemaExtensionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all schema extensions applied to a Microsoft AD

[slot] ListTagsForResourceResponse *DirectoryServiceClient::listTagsForResource(const ListTagsForResourceRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an ListTagsForResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all tags on a

[slot] RegisterEventTopicResponse *DirectoryServiceClient::registerEventTopic(const RegisterEventTopicRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an RegisterEventTopicResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RemoveIpRoutesResponse *DirectoryServiceClient::removeIpRoutes(const RemoveIpRoutesRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an RemoveIpRoutesResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes IP address blocks from a

[slot] RemoveTagsFromResourceResponse *DirectoryServiceClient::removeTagsFromResource(const RemoveTagsFromResourceRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an RemoveTagsFromResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Removes tags from a

[slot] RestoreFromSnapshotResponse *DirectoryServiceClient::restoreFromSnapshot(const RestoreFromSnapshotRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an RestoreFromSnapshotResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is

[slot] StartSchemaExtensionResponse *DirectoryServiceClient::startSchemaExtension(const StartSchemaExtensionRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an StartSchemaExtensionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Applies a schema extension to a Microsoft AD

[slot] UpdateConditionalForwarderResponse *DirectoryServiceClient::updateConditionalForwarder(const UpdateConditionalForwarderRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an UpdateConditionalForwarderResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateNumberOfDomainControllersResponse *DirectoryServiceClient::updateNumberOfDomainControllers(const UpdateNumberOfDomainControllersRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an UpdateNumberOfDomainControllersResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateRadiusResponse *DirectoryServiceClient::updateRadius(const UpdateRadiusRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an UpdateRadiusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] VerifyTrustResponse *DirectoryServiceClient::verifyTrust(const VerifyTrustRequest &request)

Sends request to the DirectoryServiceClient service, and returns a pointer to an VerifyTrustResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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