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
This is the AWS Directory Service API Reference. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors.
METHODS
ConnectDirectory(ConnectSettings => Paws::DS::DirectoryConnectSettings, Name => Str, Password => Str, Size => Str, [Description => Str, ShortName => Str])
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.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 C<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 a computer account in the specified directory, and joins the
computer to the directory.CreateDirectory(Name => Str, Password => Str, Size => Str, [Description => Str, ShortName => Str, 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.CreateMicrosoftAD(Name => Str, Password => Str, VpcSettings => Paws::DS::DirectoryVpcSettings, [Description => Str, ShortName => Str])
Each argument is described in detail in: Paws::DS::CreateMicrosoftAD
Returns: a Paws::DS::CreateMicrosoftADResult instance
Creates a Microsoft AD in the AWS cloud.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 directory.You cannot take snapshots of AD Connector directories.
CreateTrust(DirectoryId => Str, RemoteDomainName => Str, TrustDirection => Str, TrustPassword => 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 Microsoft AD in the AWS cloud, and your existing
on-premises Microsoft Active Directory. This would allow you to provide
users and groups access to resources in either domain, with a single
set of credentials.This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.
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.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)
Each argument is described in detail in: Paws::DS::DeleteTrust
Returns: a Paws::DS::DeleteTrustResult instance
Deletes an existing trust relationship between your Microsoft AD in the
AWS cloud and an external domain.DescribeDirectories([DirectoryIds => ArrayRef[Str], 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.
DescribeSnapshots([DirectoryId => Str, Limit => Int, NextToken => Str, SnapshotIds => ArrayRef[Str]])
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]])
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.
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
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.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
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.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.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.
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 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 Microsoft AD in the AWS cloud and an external domain.
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