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 and the AWS Directory Service Administration Guide.
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.
METHODS
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.
I<AddIpRoutes> adds this address block. You can also use I<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.
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; C<Initializing>,
C<CreatingSnapshot>, and C<UpdatingSchema>.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.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.
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://E<lt>aliasE<gt>.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.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, 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.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.
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.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.
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], 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.
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.
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 Microsoft AD in the
AWS cloud and an external domain.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.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.
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.
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.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.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.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.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.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.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.
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.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 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.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
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