The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::DS - Perl Interface to AWS AWS Directory Service

SYNOPSIS

  use Paws;

  my $obj = Paws->service('DS');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service (https://aws.amazon.com/directoryservice/) and the AWS Directory Service Administration Guide (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html).

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16

METHODS

AcceptSharedDirectory

SharedDirectoryId => Str

Each argument is described in detail in: Paws::DS::AcceptSharedDirectory

Returns: a Paws::DS::AcceptSharedDirectoryResult instance

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

AddIpRoutes

DirectoryId => Str
IpRoutes => ArrayRef[Paws::DS::IpRoute]
[UpdateSecurityGroupForDirectoryControllers => Bool]

Each argument is described in detail in: Paws::DS::AddIpRoutes

Returns: a Paws::DS::AddIpRoutesResult instance

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. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

AddRegion

DirectoryId => Str
RegionName => Str
VPCSettings => Paws::DS::DirectoryVpcSettings

Each argument is described in detail in: Paws::DS::AddRegion

Returns: a Paws::DS::AddRegionResult instance

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

AddTagsToResource

ResourceId => Str
Tags => ArrayRef[Paws::DS::Tag]

Each argument is described in detail in: Paws::DS::AddTagsToResource

Returns: a Paws::DS::AddTagsToResourceResult instance

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.

CancelSchemaExtension

DirectoryId => Str
SchemaExtensionId => Str

Each argument is described in detail in: Paws::DS::CancelSchemaExtension

Returns: a Paws::DS::CancelSchemaExtensionResult instance

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.

ConnectDirectory

ConnectSettings => Paws::DS::DirectoryConnectSettings
Name => Str
Password => Str
Size => Str
[Description => Str]
[ShortName => Str]
[Tags => ArrayRef[Paws::DS::Tag]]

Each argument is described in detail in: Paws::DS::ConnectDirectory

Returns: a Paws::DS::ConnectDirectoryResult instance

Creates an AD Connector to connect to an on-premises 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

CreateAlias

Alias => Str
DirectoryId => Str

Each argument is described in detail in: Paws::DS::CreateAlias

Returns: a Paws::DS::CreateAliasResult instance

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

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

CreateComputer

ComputerName => Str
DirectoryId => Str
Password => Str
[ComputerAttributes => ArrayRef[Paws::DS::Attribute]]
[OrganizationalUnitDistinguishedName => Str]

Each argument is described in detail in: Paws::DS::CreateComputer

Returns: a Paws::DS::CreateComputerResult instance

Creates an Active Directory computer object in the specified directory.

CreateConditionalForwarder

DirectoryId => Str
DnsIpAddrs => ArrayRef[Str|Undef]
RemoteDomainName => Str

Each argument is described in detail in: Paws::DS::CreateConditionalForwarder

Returns: a Paws::DS::CreateConditionalForwarderResult instance

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

CreateDirectory

Name => Str
Password => Str
Size => Str
[Description => Str]
[ShortName => Str]
[Tags => ArrayRef[Paws::DS::Tag]]
[VpcSettings => Paws::DS::DirectoryVpcSettings]

Each argument is described in detail in: Paws::DS::CreateDirectory

Returns: a Paws::DS::CreateDirectoryResult instance

Creates a Simple AD directory. For more information, see Simple Active Directory (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

CreateLogSubscription

DirectoryId => Str
LogGroupName => Str

Each argument is described in detail in: Paws::DS::CreateLogSubscription

Returns: a Paws::DS::CreateLogSubscriptionResult instance

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.

CreateMicrosoftAD

Name => Str
Password => Str
VpcSettings => Paws::DS::DirectoryVpcSettings
[Description => Str]
[Edition => Str]
[ShortName => Str]
[Tags => ArrayRef[Paws::DS::Tag]]

Each argument is described in detail in: Paws::DS::CreateMicrosoftAD

Returns: a Paws::DS::CreateMicrosoftADResult instance

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

CreateSnapshot

DirectoryId => Str
[Name => Str]

Each argument is described in detail in: Paws::DS::CreateSnapshot

Returns: a Paws::DS::CreateSnapshotResult instance

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

You cannot take snapshots of AD Connector directories.

CreateTrust

DirectoryId => Str
RemoteDomainName => Str
TrustDirection => Str
TrustPassword => Str
[ConditionalForwarderIpAddrs => ArrayRef[Str|Undef]]
[SelectiveAuth => Str]
[TrustType => Str]

Each argument is described in detail in: Paws::DS::CreateTrust

Returns: a Paws::DS::CreateTrustResult instance

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

DeleteConditionalForwarder

DirectoryId => Str
RemoteDomainName => Str

Each argument is described in detail in: Paws::DS::DeleteConditionalForwarder

Returns: a Paws::DS::DeleteConditionalForwarderResult instance

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

DeleteDirectory

DirectoryId => Str

Each argument is described in detail in: Paws::DS::DeleteDirectory

Returns: a Paws::DS::DeleteDirectoryResult instance

Deletes an AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html).

DeleteLogSubscription

DirectoryId => Str

Each argument is described in detail in: Paws::DS::DeleteLogSubscription

Returns: a Paws::DS::DeleteLogSubscriptionResult instance

Deletes the specified log subscription.

DeleteSnapshot

SnapshotId => Str

Each argument is described in detail in: Paws::DS::DeleteSnapshot

Returns: a Paws::DS::DeleteSnapshotResult instance

Deletes a directory snapshot.

DeleteTrust

TrustId => Str
[DeleteAssociatedConditionalForwarder => Bool]

Each argument is described in detail in: Paws::DS::DeleteTrust

Returns: a Paws::DS::DeleteTrustResult instance

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

DeregisterCertificate

CertificateId => Str
DirectoryId => Str

Each argument is described in detail in: Paws::DS::DeregisterCertificate

Returns: a Paws::DS::DeregisterCertificateResult instance

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

DeregisterEventTopic

DirectoryId => Str
TopicName => Str

Each argument is described in detail in: Paws::DS::DeregisterEventTopic

Returns: a Paws::DS::DeregisterEventTopicResult instance

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

DescribeCertificate

CertificateId => Str
DirectoryId => Str

Each argument is described in detail in: Paws::DS::DescribeCertificate

Returns: a Paws::DS::DescribeCertificateResult instance

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

DescribeConditionalForwarders

DirectoryId => Str
[RemoteDomainNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DS::DescribeConditionalForwarders

Returns: a Paws::DS::DescribeConditionalForwardersResult instance

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.

DescribeDirectories

[DirectoryIds => ArrayRef[Str|Undef]]
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::DescribeDirectories

Returns: a Paws::DS::DescribeDirectoriesResult instance

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.

DescribeDomainControllers

DirectoryId => Str
[DomainControllerIds => ArrayRef[Str|Undef]]
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::DescribeDomainControllers

Returns: a Paws::DS::DescribeDomainControllersResult instance

Provides information about any domain controllers in your directory.

DescribeEventTopics

[DirectoryId => Str]
[TopicNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DS::DescribeEventTopics

Returns: a Paws::DS::DescribeEventTopicsResult instance

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

DescribeLDAPSSettings

DirectoryId => Str
[Limit => Int]
[NextToken => Str]
[Type => Str]

Each argument is described in detail in: Paws::DS::DescribeLDAPSSettings

Returns: a Paws::DS::DescribeLDAPSSettingsResult instance

Describes the status of LDAP security for the specified directory.

DescribeRegions

DirectoryId => Str
[NextToken => Str]
[RegionName => Str]

Each argument is described in detail in: Paws::DS::DescribeRegions

Returns: a Paws::DS::DescribeRegionsResult instance

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

DescribeSharedDirectories

OwnerDirectoryId => Str
[Limit => Int]
[NextToken => Str]
[SharedDirectoryIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DS::DescribeSharedDirectories

Returns: a Paws::DS::DescribeSharedDirectoriesResult instance

Returns the shared directories in your account.

DescribeSnapshots

[DirectoryId => Str]
[Limit => Int]
[NextToken => Str]
[SnapshotIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DS::DescribeSnapshots

Returns: a Paws::DS::DescribeSnapshotsResult instance

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.

DescribeTrusts

[DirectoryId => Str]
[Limit => Int]
[NextToken => Str]
[TrustIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::DS::DescribeTrusts

Returns: a Paws::DS::DescribeTrustsResult instance

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.

DisableClientAuthentication

DirectoryId => Str
Type => Str

Each argument is described in detail in: Paws::DS::DisableClientAuthentication

Returns: a Paws::DS::DisableClientAuthenticationResult instance

Disables alternative client authentication methods for the specified directory.

DisableLDAPS

DirectoryId => Str
Type => Str

Each argument is described in detail in: Paws::DS::DisableLDAPS

Returns: a Paws::DS::DisableLDAPSResult instance

Deactivates LDAP secure calls for the specified directory.

DisableRadius

DirectoryId => Str

Each argument is described in detail in: Paws::DS::DisableRadius

Returns: a Paws::DS::DisableRadiusResult instance

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

DisableSso

DirectoryId => Str
[Password => Str]
[UserName => Str]

Each argument is described in detail in: Paws::DS::DisableSso

Returns: a Paws::DS::DisableSsoResult instance

Disables single-sign on for a directory.

EnableClientAuthentication

DirectoryId => Str
Type => Str

Each argument is described in detail in: Paws::DS::EnableClientAuthentication

Returns: a Paws::DS::EnableClientAuthenticationResult instance

Enables alternative client authentication methods for the specified directory.

EnableLDAPS

DirectoryId => Str
Type => Str

Each argument is described in detail in: Paws::DS::EnableLDAPS

Returns: a Paws::DS::EnableLDAPSResult instance

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

EnableRadius

DirectoryId => Str
RadiusSettings => Paws::DS::RadiusSettings

Each argument is described in detail in: Paws::DS::EnableRadius

Returns: a Paws::DS::EnableRadiusResult instance

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

EnableSso

DirectoryId => Str
[Password => Str]
[UserName => Str]

Each argument is described in detail in: Paws::DS::EnableSso

Returns: a Paws::DS::EnableSsoResult instance

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

GetDirectoryLimits

Each argument is described in detail in: Paws::DS::GetDirectoryLimits

Returns: a Paws::DS::GetDirectoryLimitsResult instance

Obtains directory limit information for the current Region.

GetSnapshotLimits

DirectoryId => Str

Each argument is described in detail in: Paws::DS::GetSnapshotLimits

Returns: a Paws::DS::GetSnapshotLimitsResult instance

Obtains the manual snapshot limits for a directory.

ListCertificates

DirectoryId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::ListCertificates

Returns: a Paws::DS::ListCertificatesResult instance

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

ListIpRoutes

DirectoryId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::ListIpRoutes

Returns: a Paws::DS::ListIpRoutesResult instance

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

ListLogSubscriptions

[DirectoryId => Str]
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::ListLogSubscriptions

Returns: a Paws::DS::ListLogSubscriptionsResult instance

Lists the active log subscriptions for the AWS account.

ListSchemaExtensions

DirectoryId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::ListSchemaExtensions

Returns: a Paws::DS::ListSchemaExtensionsResult instance

Lists all schema extensions applied to a Microsoft AD Directory.

ListTagsForResource

ResourceId => Str
[Limit => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::DS::ListTagsForResource

Returns: a Paws::DS::ListTagsForResourceResult instance

Lists all tags on a directory.

RegisterCertificate

CertificateData => Str
DirectoryId => Str
[ClientCertAuthSettings => Paws::DS::ClientCertAuthSettings]
[Type => Str]

Each argument is described in detail in: Paws::DS::RegisterCertificate

Returns: a Paws::DS::RegisterCertificateResult instance

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

RegisterEventTopic

DirectoryId => Str
TopicName => Str

Each argument is described in detail in: Paws::DS::RegisterEventTopic

Returns: a Paws::DS::RegisterEventTopicResult instance

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

RejectSharedDirectory

SharedDirectoryId => Str

Each argument is described in detail in: Paws::DS::RejectSharedDirectory

Returns: a Paws::DS::RejectSharedDirectoryResult instance

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

RemoveIpRoutes

CidrIps => ArrayRef[Str|Undef]
DirectoryId => Str

Each argument is described in detail in: Paws::DS::RemoveIpRoutes

Returns: a Paws::DS::RemoveIpRoutesResult instance

Removes IP address blocks from a directory.

RemoveRegion

DirectoryId => Str

Each argument is described in detail in: Paws::DS::RemoveRegion

Returns: a Paws::DS::RemoveRegionResult instance

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.

RemoveTagsFromResource

ResourceId => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::DS::RemoveTagsFromResource

Returns: a Paws::DS::RemoveTagsFromResourceResult instance

Removes tags from a directory.

ResetUserPassword

DirectoryId => Str
NewPassword => Str
UserName => Str

Each argument is described in detail in: Paws::DS::ResetUserPassword

Returns: a Paws::DS::ResetUserPasswordResult instance

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

  • For AWS 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 AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created (https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html) in the AWS Directory Service Administration Guide.

RestoreFromSnapshot

SnapshotId => Str

Each argument is described in detail in: Paws::DS::RestoreFromSnapshot

Returns: a Paws::DS::RestoreFromSnapshotResult instance

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.

ShareDirectory

DirectoryId => Str
ShareMethod => Str
ShareTarget => Paws::DS::ShareTarget
[ShareNotes => Str]

Each argument is described in detail in: Paws::DS::ShareDirectory

Returns: a Paws::DS::ShareDirectoryResult instance

Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS 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 AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS 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.

StartSchemaExtension

CreateSnapshotBeforeSchemaExtension => Bool
Description => Str
DirectoryId => Str
LdifContent => Str

Each argument is described in detail in: Paws::DS::StartSchemaExtension

Returns: a Paws::DS::StartSchemaExtensionResult instance

Applies a schema extension to a Microsoft AD directory.

UnshareDirectory

DirectoryId => Str
UnshareTarget => Paws::DS::UnshareTarget

Each argument is described in detail in: Paws::DS::UnshareDirectory

Returns: a Paws::DS::UnshareDirectoryResult instance

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

UpdateConditionalForwarder

DirectoryId => Str
DnsIpAddrs => ArrayRef[Str|Undef]
RemoteDomainName => Str

Each argument is described in detail in: Paws::DS::UpdateConditionalForwarder

Returns: a Paws::DS::UpdateConditionalForwarderResult instance

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

UpdateNumberOfDomainControllers

DesiredNumber => Int
DirectoryId => Str

Each argument is described in detail in: Paws::DS::UpdateNumberOfDomainControllers

Returns: a Paws::DS::UpdateNumberOfDomainControllersResult instance

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.

UpdateRadius

DirectoryId => Str
RadiusSettings => Paws::DS::RadiusSettings

Each argument is described in detail in: Paws::DS::UpdateRadius

Returns: a Paws::DS::UpdateRadiusResult instance

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

UpdateTrust

TrustId => Str
[SelectiveAuth => Str]

Each argument is described in detail in: Paws::DS::UpdateTrust

Returns: a Paws::DS::UpdateTrustResult instance

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

VerifyTrust

TrustId => Str

Each argument is described in detail in: Paws::DS::VerifyTrust

Returns: a Paws::DS::VerifyTrustResult instance

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllDirectories(sub { },[DirectoryIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])

DescribeAllDirectories([DirectoryIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DirectoryDescriptions, passing the object as the first parameter, and the string 'DirectoryDescriptions' as the second parameter 

If not, it will return a a Paws::DS::DescribeDirectoriesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllDomainControllers(sub { },DirectoryId => Str, [DomainControllerIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])

DescribeAllDomainControllers(DirectoryId => Str, [DomainControllerIds => ArrayRef[Str|Undef], Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - DomainControllers, passing the object as the first parameter, and the string 'DomainControllers' as the second parameter 

If not, it will return a a Paws::DS::DescribeDomainControllersResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllSharedDirectories(sub { },OwnerDirectoryId => Str, [Limit => Int, NextToken => Str, SharedDirectoryIds => ArrayRef[Str|Undef]])

DescribeAllSharedDirectories(OwnerDirectoryId => Str, [Limit => Int, NextToken => Str, SharedDirectoryIds => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SharedDirectories, passing the object as the first parameter, and the string 'SharedDirectories' as the second parameter 

If not, it will return a a Paws::DS::DescribeSharedDirectoriesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllSnapshots(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str, SnapshotIds => ArrayRef[Str|Undef]])

DescribeAllSnapshots([DirectoryId => Str, Limit => Int, NextToken => Str, SnapshotIds => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Snapshots, passing the object as the first parameter, and the string 'Snapshots' as the second parameter 

If not, it will return a a Paws::DS::DescribeSnapshotsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllTrusts(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str, TrustIds => ArrayRef[Str|Undef]])

DescribeAllTrusts([DirectoryId => Str, Limit => Int, NextToken => Str, TrustIds => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Trusts, passing the object as the first parameter, and the string 'Trusts' as the second parameter 

If not, it will return a a Paws::DS::DescribeTrustsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllIpRoutes(sub { },DirectoryId => Str, [Limit => Int, NextToken => Str])

ListAllIpRoutes(DirectoryId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - IpRoutesInfo, passing the object as the first parameter, and the string 'IpRoutesInfo' as the second parameter 

If not, it will return a a Paws::DS::ListIpRoutesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLogSubscriptions(sub { },[DirectoryId => Str, Limit => Int, NextToken => Str])

ListAllLogSubscriptions([DirectoryId => Str, Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - LogSubscriptions, passing the object as the first parameter, and the string 'LogSubscriptions' as the second parameter 

If not, it will return a a Paws::DS::ListLogSubscriptionsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSchemaExtensions(sub { },DirectoryId => Str, [Limit => Int, NextToken => Str])

ListAllSchemaExtensions(DirectoryId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SchemaExtensionsInfo, passing the object as the first parameter, and the string 'SchemaExtensionsInfo' as the second parameter 

If not, it will return a a Paws::DS::ListSchemaExtensionsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTagsForResource(sub { },ResourceId => Str, [Limit => Int, NextToken => Str])

ListAllTagsForResource(ResourceId => Str, [Limit => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter 

If not, it will return a a Paws::DS::ListTagsForResourceResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues