aws-elixir v0.1.0 AWS.DirectoryService

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.

Summary

Functions

Adds or overwrites one or more tags for the specified Amazon Directory Services directory. Each directory can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource

Creates an AD Connector to connect to an on-premises directory

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

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

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

Creates a Simple AD directory

Creates a Microsoft AD in the AWS cloud

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

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

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

Deletes an AWS Directory Service directory

Deletes a directory snapshot

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

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

Obtains information about the conditional forwarders for this account

Obtains information about the directories that belong to this account

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

Obtains information about the directory snapshots that belong to this account

Obtains information about the trust relationships for this account

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

Disables single-sign on for a directory

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

Enables single-sign on for a directory

Obtains directory limit information for the current region

Obtains the manual snapshot limits for a directory

Lists all tags on an Amazon Directory Services directory

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

Removes tags from an Amazon Directory Services directory

Restores a directory using an existing directory snapshot

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

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

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

Functions

add_tags_to_resource(client, input, options \\ [])

Adds or overwrites one or more tags for the specified Amazon Directory Services directory. Each directory can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

connect_directory(client, input, options \\ [])

Creates an AD Connector to connect to an on-premises directory.

create_alias(client, input, options \\ [])

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.
create_computer(client, input, options \\ [])

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

create_conditional_forwarder(client, input, options \\ [])

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.

create_directory(client, input, options \\ [])

Creates a Simple AD directory.

create_microsoft_a_d(client, input, options \\ [])

Creates a Microsoft AD in the AWS cloud.

create_snapshot(client, input, options \\ [])

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

You cannot take snapshots of AD Connector directories.
create_trust(client, input, options \\ [])

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.

delete_conditional_forwarder(client, input, options \\ [])

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

delete_directory(client, input, options \\ [])

Deletes an AWS Directory Service directory.

delete_snapshot(client, input, options \\ [])

Deletes a directory snapshot.

delete_trust(client, input, options \\ [])

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

deregister_event_topic(client, input, options \\ [])

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

describe_conditional_forwarders(client, input, options \\ [])

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.

describe_directories(client, input, options \\ [])

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.

describe_event_topics(client, input, options \\ [])

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.

describe_snapshots(client, input, options \\ [])

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.

describe_trusts(client, input, options \\ [])

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.

disable_radius(client, input, options \\ [])

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

disable_sso(client, input, options \\ [])

Disables single-sign on for a directory.

enable_radius(client, input, options \\ [])

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

enable_sso(client, input, options \\ [])

Enables single-sign on for a directory.

get_directory_limits(client, input, options \\ [])

Obtains directory limit information for the current region.

get_snapshot_limits(client, input, options \\ [])

Obtains the manual snapshot limits for a directory.

list_tags_for_resource(client, input, options \\ [])

Lists all tags on an Amazon Directory Services directory.

register_event_topic(client, input, options \\ [])

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.

remove_tags_from_resource(client, input, options \\ [])

Removes tags from an Amazon Directory Services directory.

restore_from_snapshot(client, input, options \\ [])

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.

update_conditional_forwarder(client, input, options \\ [])

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

update_radius(client, input, options \\ [])

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

verify_trust(client, input, options \\ [])

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.