AcceptSharedDirectory

$result = $client->acceptSharedDirectory([/* ... */]);
$promise = $client->acceptSharedDirectoryAsync([/* ... */]);

Accepts a directory sharing request that was sent from the directory owner account.

Parameter Syntax

$result = $client->acceptSharedDirectory([
    'SharedDirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SharedDirectory' => [
        'CreatedDateTime' => <DateTime>,
        'LastUpdatedDateTime' => <DateTime>,
        'OwnerAccountId' => '<string>',
        'OwnerDirectoryId' => '<string>',
        'ShareMethod' => 'ORGANIZATIONS|HANDSHAKE',
        'ShareNotes' => '<string>',
        'ShareStatus' => 'Shared|PendingAcceptance|Rejected|Rejecting|RejectFailed|Sharing|ShareFailed|Deleted|Deleting',
        'SharedAccountId' => '<string>',
        'SharedDirectoryId' => '<string>',
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryAlreadySharedException:

The specified directory has already been shared with this Amazon Web Services account.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

AddIpRoutes

$result = $client->addIpRoutes([/* ... */]);
$promise = $client->addIpRoutesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addIpRoutes([
    'DirectoryId' => '<string>', // REQUIRED
    'IpRoutes' => [ // REQUIRED
        [
            'CidrIp' => '<string>',
            'Description' => '<string>',
        ],
        // ...
    ],
    'UpdateSecurityGroupForDirectoryControllers' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

EntityAlreadyExistsException:

The specified entity already exists.

InvalidParameterException:

One or more parameters are not valid.

DirectoryUnavailableException:

The specified directory is unavailable.

IpRouteLimitExceededException:

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

AddRegion

$result = $client->addRegion([/* ... */]);
$promise = $client->addRegionAsync([/* ... */]);

Adds two domain controllers in the specified Region for the specified directory.

Parameter Syntax

$result = $client->addRegion([
    'DirectoryId' => '<string>', // REQUIRED
    'RegionName' => '<string>', // REQUIRED
    'VPCSettings' => [ // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

InvalidParameterException:

One or more parameters are not valid.

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryAlreadyInRegionException:

The Region you specified is the same Region where the Managed Microsoft AD directory was created. Specify a different Region and try again.

UnsupportedOperationException:

The operation is not supported.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

RegionLimitExceededException:

You have reached the limit for maximum number of simultaneous Region replications per directory.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

AddTagsToResource

$result = $client->addTagsToResource([/* ... */]);
$promise = $client->addTagsToResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->addTagsToResource([
    'ResourceId' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

TagLimitExceededException:

The maximum allowed number of tags was exceeded.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CancelSchemaExtension

$result = $client->cancelSchemaExtension([/* ... */]);
$promise = $client->cancelSchemaExtensionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelSchemaExtension([
    'DirectoryId' => '<string>', // REQUIRED
    'SchemaExtensionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ConnectDirectory

$result = $client->connectDirectory([/* ... */]);
$promise = $client->connectDirectoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->connectDirectory([
    'ConnectSettings' => [ // REQUIRED
        'CustomerDnsIps' => ['<string>', ...], // REQUIRED
        'CustomerUserName' => '<string>', // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'VpcId' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'ShortName' => '<string>',
    'Size' => 'Small|Large', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
]

Result Details

Errors

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.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAlias([
    'Alias' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Alias' => '<string>',
    'DirectoryId' => '<string>',
]

Result Details

Errors

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateComputer

$result = $client->createComputer([/* ... */]);
$promise = $client->createComputerAsync([/* ... */]);

Creates an Active Directory computer object in the specified directory.

Parameter Syntax

$result = $client->createComputer([
    'ComputerAttributes' => [
        [
            'Name' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'ComputerName' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
    'OrganizationalUnitDistinguishedName' => '<string>',
    'Password' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Computer' => [
        'ComputerAttributes' => [
            [
                'Name' => '<string>',
                'Value' => '<string>',
            ],
            // ...
        ],
        'ComputerId' => '<string>',
        'ComputerName' => '<string>',
    ],
]

Result Details

Errors

AuthenticationFailedException:

An authentication error occurred.

DirectoryUnavailableException:

The specified directory is unavailable.

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateConditionalForwarder

$result = $client->createConditionalForwarder([/* ... */]);
$promise = $client->createConditionalForwarderAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createConditionalForwarder([
    'DirectoryId' => '<string>', // REQUIRED
    'DnsIpAddrs' => ['<string>', ...], // REQUIRED
    'RemoteDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryUnavailableException:

The specified directory is unavailable.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateDirectory

$result = $client->createDirectory([/* ... */]);
$promise = $client->createDirectoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createDirectory([
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'ShortName' => '<string>',
    'Size' => 'Small|Large', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcSettings' => [
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
]

Result Details

Errors

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.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateLogSubscription

$result = $client->createLogSubscription([/* ... */]);
$promise = $client->createLogSubscriptionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLogSubscription([
    'DirectoryId' => '<string>', // REQUIRED
    'LogGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

UnsupportedOperationException:

The operation is not supported.

InsufficientPermissionsException:

The account does not have sufficient permission to perform the operation.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateMicrosoftAD

$result = $client->createMicrosoftAD([/* ... */]);
$promise = $client->createMicrosoftADAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createMicrosoftAD([
    'Description' => '<string>',
    'Edition' => 'Enterprise|Standard',
    'Name' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'ShortName' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcSettings' => [ // REQUIRED
        'SubnetIds' => ['<string>', ...], // REQUIRED
        'VpcId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
]

Result Details

Errors

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.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.

CreateSnapshot

$result = $client->createSnapshot([/* ... */]);
$promise = $client->createSnapshotAsync([/* ... */]);

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

Parameter Syntax

$result = $client->createSnapshot([
    'DirectoryId' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'SnapshotId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

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.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

CreateTrust

$result = $client->createTrust([/* ... */]);
$promise = $client->createTrustAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTrust([
    'ConditionalForwarderIpAddrs' => ['<string>', ...],
    'DirectoryId' => '<string>', // REQUIRED
    'RemoteDomainName' => '<string>', // REQUIRED
    'SelectiveAuth' => 'Enabled|Disabled',
    'TrustDirection' => 'One-Way: Outgoing|One-Way: Incoming|Two-Way', // REQUIRED
    'TrustPassword' => '<string>', // REQUIRED
    'TrustType' => 'Forest|External',
]);

Parameter Details

Result Syntax

[
    'TrustId' => '<string>',
]

Result Details

Errors

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.

DeleteConditionalForwarder

$result = $client->deleteConditionalForwarder([/* ... */]);
$promise = $client->deleteConditionalForwarderAsync([/* ... */]);

Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.

Parameter Syntax

$result = $client->deleteConditionalForwarder([
    'DirectoryId' => '<string>', // REQUIRED
    'RemoteDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryUnavailableException:

The specified directory is unavailable.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DeleteDirectory

$result = $client->deleteDirectory([/* ... */]);
$promise = $client->deleteDirectoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteDirectory([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DeleteLogSubscription

$result = $client->deleteLogSubscription([/* ... */]);
$promise = $client->deleteLogSubscriptionAsync([/* ... */]);

Deletes the specified log subscription.

Parameter Syntax

$result = $client->deleteLogSubscription([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DeleteSnapshot

$result = $client->deleteSnapshot([/* ... */]);
$promise = $client->deleteSnapshotAsync([/* ... */]);

Deletes a directory snapshot.

Parameter Syntax

$result = $client->deleteSnapshot([
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SnapshotId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DeleteTrust

$result = $client->deleteTrust([/* ... */]);
$promise = $client->deleteTrustAsync([/* ... */]);

Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.

Parameter Syntax

$result = $client->deleteTrust([
    'DeleteAssociatedConditionalForwarder' => true || false,
    'TrustId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TrustId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.

DeregisterCertificate

$result = $client->deregisterCertificate([/* ... */]);
$promise = $client->deregisterCertificateAsync([/* ... */]);

Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.

Parameter Syntax

$result = $client->deregisterCertificate([
    'CertificateId' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

CertificateDoesNotExistException:

The certificate is not present in the system for describe or deregister activities.

CertificateInUseException:

The certificate is being used for the LDAP security connection and cannot be removed without disabling LDAP security.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DeregisterEventTopic

$result = $client->deregisterEventTopic([/* ... */]);
$promise = $client->deregisterEventTopicAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deregisterEventTopic([
    'DirectoryId' => '<string>', // REQUIRED
    'TopicName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeCertificate

$result = $client->describeCertificate([/* ... */]);
$promise = $client->describeCertificateAsync([/* ... */]);

Displays information about the certificate registered for secure LDAP or client certificate authentication.

Parameter Syntax

$result = $client->describeCertificate([
    'CertificateId' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Certificate' => [
        'CertificateId' => '<string>',
        'ClientCertAuthSettings' => [
            'OCSPUrl' => '<string>',
        ],
        'CommonName' => '<string>',
        'ExpiryDateTime' => <DateTime>,
        'RegisteredDateTime' => <DateTime>,
        'State' => 'Registering|Registered|RegisterFailed|Deregistering|Deregistered|DeregisterFailed',
        'StateReason' => '<string>',
        'Type' => 'ClientCertAuth|ClientLDAPS',
    ],
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

CertificateDoesNotExistException:

The certificate is not present in the system for describe or deregister activities.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeClientAuthenticationSettings

$result = $client->describeClientAuthenticationSettings([/* ... */]);
$promise = $client->describeClientAuthenticationSettingsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeClientAuthenticationSettings([
    'DirectoryId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'Type' => 'SmartCard|SmartCardOrPassword',
]);

Parameter Details

Result Syntax

[
    'ClientAuthenticationSettingsInfo' => [
        [
            'LastUpdatedDateTime' => <DateTime>,
            'Status' => 'Enabled|Disabled',
            'Type' => 'SmartCard|SmartCardOrPassword',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

AccessDeniedException:

You do not have sufficient access to perform this action.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeConditionalForwarders

$result = $client->describeConditionalForwarders([/* ... */]);
$promise = $client->describeConditionalForwardersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeConditionalForwarders([
    'DirectoryId' => '<string>', // REQUIRED
    'RemoteDomainNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ConditionalForwarders' => [
        [
            'DnsIpAddrs' => ['<string>', ...],
            'RemoteDomainName' => '<string>',
            'ReplicationScope' => 'Domain',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryUnavailableException:

The specified directory is unavailable.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeDirectories

$result = $client->describeDirectories([/* ... */]);
$promise = $client->describeDirectoriesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeDirectories([
    'DirectoryIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DirectoryDescriptions' => [
        [
            'AccessUrl' => '<string>',
            'Alias' => '<string>',
            'ConnectSettings' => [
                'AvailabilityZones' => ['<string>', ...],
                'ConnectIps' => ['<string>', ...],
                'CustomerUserName' => '<string>',
                'SecurityGroupId' => '<string>',
                'SubnetIds' => ['<string>', ...],
                'VpcId' => '<string>',
            ],
            'Description' => '<string>',
            'DesiredNumberOfDomainControllers' => <integer>,
            'DirectoryId' => '<string>',
            'DnsIpAddrs' => ['<string>', ...],
            'Edition' => 'Enterprise|Standard',
            'LaunchTime' => <DateTime>,
            'Name' => '<string>',
            'OsVersion' => 'SERVER_2012|SERVER_2019',
            'OwnerDirectoryDescription' => [
                'AccountId' => '<string>',
                'DirectoryId' => '<string>',
                'DnsIpAddrs' => ['<string>', ...],
                'RadiusSettings' => [
                    'AuthenticationProtocol' => 'PAP|CHAP|MS-CHAPv1|MS-CHAPv2',
                    'DisplayLabel' => '<string>',
                    'RadiusPort' => <integer>,
                    'RadiusRetries' => <integer>,
                    'RadiusServers' => ['<string>', ...],
                    'RadiusTimeout' => <integer>,
                    'SharedSecret' => '<string>',
                    'UseSameUsername' => true || false,
                ],
                'RadiusStatus' => 'Creating|Completed|Failed',
                'VpcSettings' => [
                    'AvailabilityZones' => ['<string>', ...],
                    'SecurityGroupId' => '<string>',
                    'SubnetIds' => ['<string>', ...],
                    'VpcId' => '<string>',
                ],
            ],
            'RadiusSettings' => [
                'AuthenticationProtocol' => 'PAP|CHAP|MS-CHAPv1|MS-CHAPv2',
                'DisplayLabel' => '<string>',
                'RadiusPort' => <integer>,
                'RadiusRetries' => <integer>,
                'RadiusServers' => ['<string>', ...],
                'RadiusTimeout' => <integer>,
                'SharedSecret' => '<string>',
                'UseSameUsername' => true || false,
            ],
            'RadiusStatus' => 'Creating|Completed|Failed',
            'RegionsInfo' => [
                'AdditionalRegions' => ['<string>', ...],
                'PrimaryRegion' => '<string>',
            ],
            'ShareMethod' => 'ORGANIZATIONS|HANDSHAKE',
            'ShareNotes' => '<string>',
            'ShareStatus' => 'Shared|PendingAcceptance|Rejected|Rejecting|RejectFailed|Sharing|ShareFailed|Deleted|Deleting',
            'ShortName' => '<string>',
            'Size' => 'Small|Large',
            'SsoEnabled' => true || false,
            'Stage' => 'Requested|Creating|Created|Active|Inoperable|Impaired|Restoring|RestoreFailed|Deleting|Deleted|Failed|Updating',
            'StageLastUpdatedDateTime' => <DateTime>,
            'StageReason' => '<string>',
            'Type' => 'SimpleAD|ADConnector|MicrosoftAD|SharedMicrosoftAD',
            'VpcSettings' => [
                'AvailabilityZones' => ['<string>', ...],
                'SecurityGroupId' => '<string>',
                'SubnetIds' => ['<string>', ...],
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

InvalidNextTokenException:

The NextToken value is not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeDirectoryDataAccess

$result = $client->describeDirectoryDataAccess([/* ... */]);
$promise = $client->describeDirectoryDataAccessAsync([/* ... */]);

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

Parameter Syntax

$result = $client->describeDirectoryDataAccess([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DataAccessStatus' => 'Disabled|Disabling|Enabled|Enabling|Failed',
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeDomainControllers

$result = $client->describeDomainControllers([/* ... */]);
$promise = $client->describeDomainControllersAsync([/* ... */]);

Provides information about any domain controllers in your directory.

Parameter Syntax

$result = $client->describeDomainControllers([
    'DirectoryId' => '<string>', // REQUIRED
    'DomainControllerIds' => ['<string>', ...],
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DomainControllers' => [
        [
            'AvailabilityZone' => '<string>',
            'DirectoryId' => '<string>',
            'DnsIpAddr' => '<string>',
            'DomainControllerId' => '<string>',
            'LaunchTime' => <DateTime>,
            'Status' => 'Creating|Active|Impaired|Restoring|Deleting|Deleted|Failed|Updating',
            'StatusLastUpdatedDateTime' => <DateTime>,
            'StatusReason' => '<string>',
            'SubnetId' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.

DescribeEventTopics

$result = $client->describeEventTopics([/* ... */]);
$promise = $client->describeEventTopicsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeEventTopics([
    'DirectoryId' => '<string>',
    'TopicNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'EventTopics' => [
        [
            'CreatedDateTime' => <DateTime>,
            'DirectoryId' => '<string>',
            'Status' => 'Registered|Topic not found|Failed|Deleted',
            'TopicArn' => '<string>',
            'TopicName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeLDAPSSettings

$result = $client->describeLDAPSSettings([/* ... */]);
$promise = $client->describeLDAPSSettingsAsync([/* ... */]);

Describes the status of LDAP security for the specified directory.

Parameter Syntax

$result = $client->describeLDAPSSettings([
    'DirectoryId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'Type' => 'Client',
]);

Parameter Details

Result Syntax

[
    'LDAPSSettingsInfo' => [
        [
            'LDAPSStatus' => 'Enabling|Enabled|EnableFailed|Disabled',
            'LDAPSStatusReason' => '<string>',
            'LastUpdatedDateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeRegions

$result = $client->describeRegions([/* ... */]);
$promise = $client->describeRegionsAsync([/* ... */]);

Provides information about the Regions that are configured for multi-Region replication.

Parameter Syntax

$result = $client->describeRegions([
    'DirectoryId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'RegionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RegionsDescription' => [
        [
            'DesiredNumberOfDomainControllers' => <integer>,
            'DirectoryId' => '<string>',
            'LastUpdatedDateTime' => <DateTime>,
            'LaunchTime' => <DateTime>,
            'RegionName' => '<string>',
            'RegionType' => 'Primary|Additional',
            'Status' => 'Requested|Creating|Created|Active|Inoperable|Impaired|Restoring|RestoreFailed|Deleting|Deleted|Failed|Updating',
            'StatusLastUpdatedDateTime' => <DateTime>,
            'VpcSettings' => [
                'SubnetIds' => ['<string>', ...],
                'VpcId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidNextTokenException:

The NextToken value is not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeSettings

$result = $client->describeSettings([/* ... */]);
$promise = $client->describeSettingsAsync([/* ... */]);

Retrieves information about the configurable settings for the specified directory.

Parameter Syntax

$result = $client->describeSettings([
    'DirectoryId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'Status' => 'Requested|Updating|Updated|Failed|Default',
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
    'NextToken' => '<string>',
    'SettingEntries' => [
        [
            'AllowedValues' => '<string>',
            'AppliedValue' => '<string>',
            'DataType' => '<string>',
            'LastRequestedDateTime' => <DateTime>,
            'LastUpdatedDateTime' => <DateTime>,
            'Name' => '<string>',
            'RequestDetailedStatus' => ['<string>', ...],
            'RequestStatus' => 'Requested|Updating|Updated|Failed|Default',
            'RequestStatusMessage' => '<string>',
            'RequestedValue' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

InvalidNextTokenException:

The NextToken value is not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeSharedDirectories

$result = $client->describeSharedDirectories([/* ... */]);
$promise = $client->describeSharedDirectoriesAsync([/* ... */]);

Returns the shared directories in your account.

Parameter Syntax

$result = $client->describeSharedDirectories([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'OwnerDirectoryId' => '<string>', // REQUIRED
    'SharedDirectoryIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SharedDirectories' => [
        [
            'CreatedDateTime' => <DateTime>,
            'LastUpdatedDateTime' => <DateTime>,
            'OwnerAccountId' => '<string>',
            'OwnerDirectoryId' => '<string>',
            'ShareMethod' => 'ORGANIZATIONS|HANDSHAKE',
            'ShareNotes' => '<string>',
            'ShareStatus' => 'Shared|PendingAcceptance|Rejected|Rejecting|RejectFailed|Sharing|ShareFailed|Deleted|Deleting',
            'SharedAccountId' => '<string>',
            'SharedDirectoryId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeSnapshots

$result = $client->describeSnapshots([/* ... */]);
$promise = $client->describeSnapshotsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeSnapshots([
    'DirectoryId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'SnapshotIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Snapshots' => [
        [
            'DirectoryId' => '<string>',
            'Name' => '<string>',
            'SnapshotId' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => 'Creating|Completed|Failed',
            'Type' => 'Auto|Manual',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

InvalidNextTokenException:

The NextToken value is not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DescribeTrusts

$result = $client->describeTrusts([/* ... */]);
$promise = $client->describeTrustsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeTrusts([
    'DirectoryId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'TrustIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Trusts' => [
        [
            'CreatedDateTime' => <DateTime>,
            'DirectoryId' => '<string>',
            'LastUpdatedDateTime' => <DateTime>,
            'RemoteDomainName' => '<string>',
            'SelectiveAuth' => 'Enabled|Disabled',
            'StateLastUpdatedDateTime' => <DateTime>,
            'TrustDirection' => 'One-Way: Outgoing|One-Way: Incoming|Two-Way',
            'TrustId' => '<string>',
            'TrustState' => 'Creating|Created|Verifying|VerifyFailed|Verified|Updating|UpdateFailed|Updated|Deleting|Deleted|Failed',
            'TrustStateReason' => '<string>',
            'TrustType' => 'Forest|External',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.

DescribeUpdateDirectory

$result = $client->describeUpdateDirectory([/* ... */]);
$promise = $client->describeUpdateDirectoryAsync([/* ... */]);

Describes the updates of a directory for a particular update type.

Parameter Syntax

$result = $client->describeUpdateDirectory([
    'DirectoryId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'RegionName' => '<string>',
    'UpdateType' => 'OS', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'UpdateActivities' => [
        [
            'InitiatedBy' => '<string>',
            'LastUpdatedDateTime' => <DateTime>,
            'NewValue' => [
                'OSUpdateSettings' => [
                    'OSVersion' => 'SERVER_2012|SERVER_2019',
                ],
            ],
            'PreviousValue' => [
                'OSUpdateSettings' => [
                    'OSVersion' => 'SERVER_2012|SERVER_2019',
                ],
            ],
            'Region' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => 'Updated|Updating|UpdateFailed',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

InvalidParameterException:

One or more parameters are not valid.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

InvalidNextTokenException:

The NextToken value is not valid.

DisableClientAuthentication

$result = $client->disableClientAuthentication([/* ... */]);
$promise = $client->disableClientAuthenticationAsync([/* ... */]);

Disables alternative client authentication methods for the specified directory.

Parameter Syntax

$result = $client->disableClientAuthentication([
    'DirectoryId' => '<string>', // REQUIRED
    'Type' => 'SmartCard|SmartCardOrPassword', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidClientAuthStatusException:

Client authentication is already enabled.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DisableDirectoryDataAccess

$result = $client->disableDirectoryDataAccess([/* ... */]);
$promise = $client->disableDirectoryDataAccessAsync([/* ... */]);

Deactivates access to directory data via the Directory Service Data API for the specified directory.

Parameter Syntax

$result = $client->disableDirectoryDataAccess([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

DirectoryUnavailableException:

The specified directory is unavailable.

UnsupportedOperationException:

The operation is not supported.

DirectoryInDesiredStateException:

The directory is already updated to desired update type settings.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DisableLDAPS

$result = $client->disableLDAPS([/* ... */]);
$promise = $client->disableLDAPSAsync([/* ... */]);

Deactivates LDAP secure calls for the specified directory.

Parameter Syntax

$result = $client->disableLDAPS([
    'DirectoryId' => '<string>', // REQUIRED
    'Type' => 'Client', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

InvalidLDAPSStatusException:

The LDAP activities could not be performed because they are limited by the LDAPS status.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DisableRadius

$result = $client->disableRadius([/* ... */]);
$promise = $client->disableRadiusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->disableRadius([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

DisableSso

$result = $client->disableSso([/* ... */]);
$promise = $client->disableSsoAsync([/* ... */]);

Disables single-sign on for a directory.

Parameter Syntax

$result = $client->disableSso([
    'DirectoryId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InsufficientPermissionsException:

The account does not have sufficient permission to perform the operation.

AuthenticationFailedException:

An authentication error occurred.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

EnableClientAuthentication

$result = $client->enableClientAuthentication([/* ... */]);
$promise = $client->enableClientAuthenticationAsync([/* ... */]);

Enables alternative client authentication methods for the specified directory.

Parameter Syntax

$result = $client->enableClientAuthentication([
    'DirectoryId' => '<string>', // REQUIRED
    'Type' => 'SmartCard|SmartCardOrPassword', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidClientAuthStatusException:

Client authentication is already enabled.

AccessDeniedException:

You do not have sufficient access to perform this action.

NoAvailableCertificateException:

Client authentication setup could not be completed because at least one valid certificate must be registered in the system.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

EnableDirectoryDataAccess

$result = $client->enableDirectoryDataAccess([/* ... */]);
$promise = $client->enableDirectoryDataAccessAsync([/* ... */]);

Enables access to directory data via the Directory Service Data API for the specified directory.

Parameter Syntax

$result = $client->enableDirectoryDataAccess([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

DirectoryUnavailableException:

The specified directory is unavailable.

UnsupportedOperationException:

The operation is not supported.

DirectoryInDesiredStateException:

The directory is already updated to desired update type settings.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

EnableLDAPS

$result = $client->enableLDAPS([/* ... */]);
$promise = $client->enableLDAPSAsync([/* ... */]);

Activates the switch for the specific directory to always use LDAP secure calls.

Parameter Syntax

$result = $client->enableLDAPS([
    'DirectoryId' => '<string>', // REQUIRED
    'Type' => 'Client', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

NoAvailableCertificateException:

Client authentication setup could not be completed because at least one valid certificate must be registered in the system.

InvalidLDAPSStatusException:

The LDAP activities could not be performed because they are limited by the LDAPS status.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

EnableRadius

$result = $client->enableRadius([/* ... */]);
$promise = $client->enableRadiusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->enableRadius([
    'DirectoryId' => '<string>', // REQUIRED
    'RadiusSettings' => [ // REQUIRED
        'AuthenticationProtocol' => 'PAP|CHAP|MS-CHAPv1|MS-CHAPv2',
        'DisplayLabel' => '<string>',
        'RadiusPort' => <integer>,
        'RadiusRetries' => <integer>,
        'RadiusServers' => ['<string>', ...],
        'RadiusTimeout' => <integer>,
        'SharedSecret' => '<string>',
        'UseSameUsername' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

EntityAlreadyExistsException:

The specified entity already exists.

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

EnableSso

$result = $client->enableSso([/* ... */]);
$promise = $client->enableSsoAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->enableSso([
    'DirectoryId' => '<string>', // REQUIRED
    'Password' => '<string>',
    'UserName' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InsufficientPermissionsException:

The account does not have sufficient permission to perform the operation.

AuthenticationFailedException:

An authentication error occurred.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

GetDirectoryLimits

$result = $client->getDirectoryLimits([/* ... */]);
$promise = $client->getDirectoryLimitsAsync([/* ... */]);

Obtains directory limit information for the current Region.

Parameter Syntax

$result = $client->getDirectoryLimits([
]);

Parameter Details

Result Syntax

[
    'DirectoryLimits' => [
        'CloudOnlyDirectoriesCurrentCount' => <integer>,
        'CloudOnlyDirectoriesLimit' => <integer>,
        'CloudOnlyDirectoriesLimitReached' => true || false,
        'CloudOnlyMicrosoftADCurrentCount' => <integer>,
        'CloudOnlyMicrosoftADLimit' => <integer>,
        'CloudOnlyMicrosoftADLimitReached' => true || false,
        'ConnectedDirectoriesCurrentCount' => <integer>,
        'ConnectedDirectoriesLimit' => <integer>,
        'ConnectedDirectoriesLimitReached' => true || false,
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

GetSnapshotLimits

$result = $client->getSnapshotLimits([/* ... */]);
$promise = $client->getSnapshotLimitsAsync([/* ... */]);

Obtains the manual snapshot limits for a directory.

Parameter Syntax

$result = $client->getSnapshotLimits([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SnapshotLimits' => [
        'ManualSnapshotsCurrentCount' => <integer>,
        'ManualSnapshotsLimit' => <integer>,
        'ManualSnapshotsLimitReached' => true || false,
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ListCertificates

$result = $client->listCertificates([/* ... */]);
$promise = $client->listCertificatesAsync([/* ... */]);

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

Parameter Syntax

$result = $client->listCertificates([
    'DirectoryId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'CertificatesInfo' => [
        [
            'CertificateId' => '<string>',
            'CommonName' => '<string>',
            'ExpiryDateTime' => <DateTime>,
            'State' => 'Registering|Registered|RegisterFailed|Deregistering|Deregistered|DeregisterFailed',
            'Type' => 'ClientCertAuth|ClientLDAPS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

InvalidNextTokenException:

The NextToken value is not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ListIpRoutes

$result = $client->listIpRoutes([/* ... */]);
$promise = $client->listIpRoutesAsync([/* ... */]);

Lists the address blocks that you have added to a directory.

Parameter Syntax

$result = $client->listIpRoutes([
    'DirectoryId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'IpRoutesInfo' => [
        [
            'AddedDateTime' => <DateTime>,
            'CidrIp' => '<string>',
            'Description' => '<string>',
            'DirectoryId' => '<string>',
            'IpRouteStatusMsg' => 'Adding|Added|Removing|Removed|AddFailed|RemoveFailed',
            'IpRouteStatusReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ListLogSubscriptions

$result = $client->listLogSubscriptions([/* ... */]);
$promise = $client->listLogSubscriptionsAsync([/* ... */]);

Lists the active log subscriptions for the Amazon Web Services account.

Parameter Syntax

$result = $client->listLogSubscriptions([
    'DirectoryId' => '<string>',
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LogSubscriptions' => [
        [
            'DirectoryId' => '<string>',
            'LogGroupName' => '<string>',
            'SubscriptionCreatedDateTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ListSchemaExtensions

$result = $client->listSchemaExtensions([/* ... */]);
$promise = $client->listSchemaExtensionsAsync([/* ... */]);

Lists all schema extensions applied to a Microsoft AD Directory.

Parameter Syntax

$result = $client->listSchemaExtensions([
    'DirectoryId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SchemaExtensionsInfo' => [
        [
            'Description' => '<string>',
            'DirectoryId' => '<string>',
            'EndDateTime' => <DateTime>,
            'SchemaExtensionId' => '<string>',
            'SchemaExtensionStatus' => 'Initializing|CreatingSnapshot|UpdatingSchema|Replicating|CancelInProgress|RollbackInProgress|Cancelled|Failed|Completed',
            'SchemaExtensionStatusReason' => '<string>',
            'StartDateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

InvalidNextTokenException:

The NextToken value is not valid.

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags on a directory.

Parameter Syntax

$result = $client->listTagsForResource([
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidNextTokenException:

The NextToken value is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RegisterCertificate

$result = $client->registerCertificate([/* ... */]);
$promise = $client->registerCertificateAsync([/* ... */]);

Registers a certificate for a secure LDAP or client certificate authentication.

Parameter Syntax

$result = $client->registerCertificate([
    'CertificateData' => '<string>', // REQUIRED
    'ClientCertAuthSettings' => [
        'OCSPUrl' => '<string>',
    ],
    'DirectoryId' => '<string>', // REQUIRED
    'Type' => 'ClientCertAuth|ClientLDAPS',
]);

Parameter Details

Result Syntax

[
    'CertificateId' => '<string>',
]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

InvalidCertificateException:

The certificate PEM that was provided has incorrect encoding.

CertificateLimitExceededException:

The certificate could not be added because the certificate limit has been reached.

CertificateAlreadyExistsException:

The certificate has already been registered into the system.

UnsupportedOperationException:

The operation is not supported.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RegisterEventTopic

$result = $client->registerEventTopic([/* ... */]);
$promise = $client->registerEventTopicAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerEventTopic([
    'DirectoryId' => '<string>', // REQUIRED
    'TopicName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RejectSharedDirectory

$result = $client->rejectSharedDirectory([/* ... */]);
$promise = $client->rejectSharedDirectoryAsync([/* ... */]);

Rejects a directory sharing request that was sent from the directory owner account.

Parameter Syntax

$result = $client->rejectSharedDirectory([
    'SharedDirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SharedDirectoryId' => '<string>',
]

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryAlreadySharedException:

The specified directory has already been shared with this Amazon Web Services account.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RemoveIpRoutes

$result = $client->removeIpRoutes([/* ... */]);
$promise = $client->removeIpRoutesAsync([/* ... */]);

Removes IP address blocks from a directory.

Parameter Syntax

$result = $client->removeIpRoutes([
    'CidrIps' => ['<string>', ...], // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

DirectoryUnavailableException:

The specified directory is unavailable.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RemoveRegion

$result = $client->removeRegion([/* ... */]);
$promise = $client->removeRegionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->removeRegion([
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RemoveTagsFromResource

$result = $client->removeTagsFromResource([/* ... */]);
$promise = $client->removeTagsFromResourceAsync([/* ... */]);

Removes tags from a directory.

Parameter Syntax

$result = $client->removeTagsFromResource([
    'ResourceId' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ResetUserPassword

$result = $client->resetUserPassword([/* ... */]);
$promise = $client->resetUserPasswordAsync([/* ... */]);

Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.

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.

Parameter Syntax

$result = $client->resetUserPassword([
    'DirectoryId' => '<string>', // REQUIRED
    'NewPassword' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

UserDoesNotExistException:

The user provided a username that does not exist in your directory.

InvalidPasswordException:

The new password provided by the user does not meet the password complexity requirements defined in your directory.

UnsupportedOperationException:

The operation is not supported.

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

RestoreFromSnapshot

$result = $client->restoreFromSnapshot([/* ... */]);
$promise = $client->restoreFromSnapshotAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->restoreFromSnapshot([
    'SnapshotId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

ShareDirectory

$result = $client->shareDirectory([/* ... */]);
$promise = $client->shareDirectoryAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->shareDirectory([
    'DirectoryId' => '<string>', // REQUIRED
    'ShareMethod' => 'ORGANIZATIONS|HANDSHAKE', // REQUIRED
    'ShareNotes' => '<string>',
    'ShareTarget' => [ // REQUIRED
        'Id' => '<string>', // REQUIRED
        'Type' => 'ACCOUNT', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'SharedDirectoryId' => '<string>',
]

Result Details

Errors

DirectoryAlreadySharedException:

The specified directory has already been shared with this Amazon Web Services account.

EntityDoesNotExistException:

The specified entity could not be found.

InvalidTargetException:

The specified shared target is not valid.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ShareLimitExceededException:

The maximum number of Amazon Web Services accounts that you can share with this directory has been reached.

OrganizationsException:

Exception encountered while trying to access your Amazon Web Services organization.

AccessDeniedException:

You do not have sufficient access to perform this action.

UnsupportedOperationException:

The operation is not supported.

ServiceException:

An exception has occurred in Directory Service.

StartSchemaExtension

$result = $client->startSchemaExtension([/* ... */]);
$promise = $client->startSchemaExtensionAsync([/* ... */]);

Applies a schema extension to a Microsoft AD directory.

Parameter Syntax

$result = $client->startSchemaExtension([
    'CreateSnapshotBeforeSchemaExtension' => true || false, // REQUIRED
    'Description' => '<string>', // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
    'LdifContent' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'SchemaExtensionId' => '<string>',
]

Result Details

Errors

DirectoryUnavailableException:

The specified directory is unavailable.

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

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.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnshareDirectory

$result = $client->unshareDirectory([/* ... */]);
$promise = $client->unshareDirectoryAsync([/* ... */]);

Stops the directory sharing between the directory owner and consumer accounts.

Parameter Syntax

$result = $client->unshareDirectory([
    'DirectoryId' => '<string>', // REQUIRED
    'UnshareTarget' => [ // REQUIRED
        'Id' => '<string>', // REQUIRED
        'Type' => 'ACCOUNT', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'SharedDirectoryId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidTargetException:

The specified shared target is not valid.

DirectoryNotSharedException:

The specified directory has not been shared with this Amazon Web Services account.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateConditionalForwarder

$result = $client->updateConditionalForwarder([/* ... */]);
$promise = $client->updateConditionalForwarderAsync([/* ... */]);

Updates a conditional forwarder that has been set up for your Amazon Web Services directory.

Parameter Syntax

$result = $client->updateConditionalForwarder([
    'DirectoryId' => '<string>', // REQUIRED
    'DnsIpAddrs' => ['<string>', ...], // REQUIRED
    'RemoteDomainName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryUnavailableException:

The specified directory is unavailable.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateDirectorySetup

$result = $client->updateDirectorySetup([/* ... */]);
$promise = $client->updateDirectorySetupAsync([/* ... */]);

Updates the directory for a particular update type.

Parameter Syntax

$result = $client->updateDirectorySetup([
    'CreateSnapshotBeforeUpdate' => true || false,
    'DirectoryId' => '<string>', // REQUIRED
    'OSUpdateSettings' => [
        'OSVersion' => 'SERVER_2012|SERVER_2019',
    ],
    'UpdateType' => 'OS', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

UnsupportedOperationException:

The operation is not supported.

DirectoryInDesiredStateException:

The directory is already updated to desired update type settings.

DirectoryUnavailableException:

The specified directory is unavailable.

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.

InvalidParameterException:

One or more parameters are not valid.

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

AccessDeniedException:

You do not have sufficient access to perform this action.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateNumberOfDomainControllers

$result = $client->updateNumberOfDomainControllers([/* ... */]);
$promise = $client->updateNumberOfDomainControllersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateNumberOfDomainControllers([
    'DesiredNumber' => <integer>, // REQUIRED
    'DirectoryId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

DirectoryUnavailableException:

The specified directory is unavailable.

DomainControllerLimitExceededException:

The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

InvalidParameterException:

One or more parameters are not valid.

UnsupportedOperationException:

The operation is not supported.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateRadius

$result = $client->updateRadius([/* ... */]);
$promise = $client->updateRadiusAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateRadius([
    'DirectoryId' => '<string>', // REQUIRED
    'RadiusSettings' => [ // REQUIRED
        'AuthenticationProtocol' => 'PAP|CHAP|MS-CHAPv1|MS-CHAPv2',
        'DisplayLabel' => '<string>',
        'RadiusPort' => <integer>,
        'RadiusRetries' => <integer>,
        'RadiusServers' => ['<string>', ...],
        'RadiusTimeout' => <integer>,
        'SharedSecret' => '<string>',
        'UseSameUsername' => true || false,
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidParameterException:

One or more parameters are not valid.

EntityDoesNotExistException:

The specified entity could not be found.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateSettings

$result = $client->updateSettings([/* ... */]);
$promise = $client->updateSettingsAsync([/* ... */]);

Updates the configurable settings for the specified directory.

Parameter Syntax

$result = $client->updateSettings([
    'DirectoryId' => '<string>', // REQUIRED
    'Settings' => [ // REQUIRED
        [
            'Name' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DirectoryId' => '<string>',
]

Result Details

Errors

DirectoryDoesNotExistException:

The specified directory does not exist in the system.

UnsupportedOperationException:

The operation is not supported.

DirectoryUnavailableException:

The specified directory is unavailable.

IncompatibleSettingsException:

The specified directory setting is not compatible with other settings.

UnsupportedSettingsException:

The specified directory setting is not supported.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UpdateTrust

$result = $client->updateTrust([/* ... */]);
$promise = $client->updateTrustAsync([/* ... */]);

Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.

Parameter Syntax

$result = $client->updateTrust([
    'SelectiveAuth' => 'Enabled|Disabled',
    'TrustId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'TrustId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

VerifyTrust

$result = $client->verifyTrust([/* ... */]);
$promise = $client->verifyTrustAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->verifyTrust([
    'TrustId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TrustId' => '<string>',
]

Result Details

Errors

EntityDoesNotExistException:

The specified entity could not be found.

InvalidParameterException:

One or more parameters are not valid.

ClientException:

A client exception has occurred.

ServiceException:

An exception has occurred in Directory Service.

UnsupportedOperationException:

The operation is not supported.