ExAws.DirectoryService.Core
AWS Directory Service
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↑
Types ↑
create_directory_request :: [description: description, name: directory_name, password: password, short_name: directory_short_name, size: directory_size, vpc_settings: directory_vpc_settings]
subnet_ids :: [subnet_id]
snapshot_limits :: [manual_snapshots_current_count: limit, manual_snapshots_limit: limit, manual_snapshots_limit_reached: manual_snapshots_limit_reached]
describe_snapshots_result :: [next_token: next_token, snapshots: snapshots]
connected_directories_limit_reached :: boolean
directory_connect_settings_description :: [availability_zones: availability_zones, connect_ips: ip_addrs, customer_user_name: user_name, security_group_id: security_group_id, subnet_ids: subnet_ids, vpc_id: vpc_id]
directory_stage :: binary
directory_id :: binary
alias_name :: binary
radius_status :: binary
enable_sso_result :: []
client_exception :: [message: exception_message, request_id: request_id]
invalid_parameter_exception :: [message: exception_message, request_id: request_id]
snapshot_name :: binary
manual_snapshots_limit_reached :: boolean
service_exception :: [message: exception_message, request_id: request_id]
directory_vpc_settings :: [subnet_ids: subnet_ids, vpc_id: vpc_id]
dns_ip_addrs :: [ip_addr]
insufficient_permissions_exception :: [message: exception_message, request_id: request_id]
snapshot_type :: binary
directory_short_name :: binary
create_computer_result :: [{:computer, computer}]
start_time :: integer
directory_size :: binary
attribute_name :: binary
snapshot_limit_exceeded_exception :: [message: exception_message, request_id: request_id]
get_snapshot_limits_result :: [{:snapshot_limits, snapshot_limits}]
attribute :: [name: attribute_name, value: attribute_value]
connect_directory_request :: [connect_settings: directory_connect_settings, description: description, name: directory_name, password: connect_password, short_name: directory_short_name, size: directory_size]
connect_directory_result :: [{:directory_id, directory_id}]
invalid_next_token_exception :: [message: exception_message, request_id: request_id]
disable_radius_result :: []
create_snapshot_result :: [{:snapshot_id, snapshot_id}]
get_directory_limits_result :: [{:directory_limits, directory_limits}]
radius_timeout :: integer
create_directory_result :: [{:directory_id, directory_id}]
limit :: integer
disable_sso_result :: []
update_radius_request :: [directory_id: directory_id, radius_settings: radius_settings]
describe_directories_request :: [directory_ids: directory_ids, limit: limit, next_token: next_token]
directory_limit_exceeded_exception :: [message: exception_message, request_id: request_id]
directory_limits :: [cloud_only_directories_current_count: limit, cloud_only_directories_limit: limit, cloud_only_directories_limit_reached: cloud_only_directories_limit_reached, connected_directories_current_count: limit, connected_directories_limit: limit, connected_directories_limit_reached: connected_directories_limit_reached]
ip_addr :: binary
stage_reason :: binary
description :: binary
delete_snapshot_result :: [{:snapshot_id, snapshot_id}]
snapshot_ids :: [snapshot_id]
vpc_id :: binary
directory_type :: binary
snapshot_id :: binary
connect_password :: binary
unsupported_operation_exception :: [message: exception_message, request_id: request_id]
enable_sso_request :: [directory_id: directory_id, password: connect_password, user_name: user_name]
update_radius_result :: []
directory_connect_settings :: [customer_dns_ips: dns_ip_addrs, customer_user_name: user_name, subnet_ids: subnet_ids, vpc_id: vpc_id]
radius_display_label :: binary
computer_name :: binary
create_alias_result :: [alias: alias_name, directory_id: directory_id]
security_group_id :: binary
server :: binary
availability_zone :: binary
radius_retries :: integer
delete_directory_result :: [{:directory_id, directory_id}]
directory_vpc_settings_description :: [availability_zones: availability_zones, security_group_id: security_group_id, subnet_ids: subnet_ids, vpc_id: vpc_id]
describe_directories_result :: [directory_descriptions: directory_descriptions, next_token: next_token]
directory_name :: binary
subnet_id :: binary
enable_radius_request :: [directory_id: directory_id, radius_settings: radius_settings]
launch_time :: integer
password :: binary
radius_authentication_protocol :: binary
delete_snapshot_request :: [{:snapshot_id, snapshot_id}]
user_name :: binary
sid :: binary
cloud_only_directories_limit_reached :: boolean
sso_enabled :: boolean
entity_does_not_exist_exception :: [message: exception_message, request_id: request_id]
computer :: [computer_attributes: attributes, computer_id: sid, computer_name: computer_name]
create_computer_request :: [computer_attributes: attributes, computer_name: computer_name, directory_id: directory_id, organizational_unit_distinguished_name: organizational_unit_dn, password: computer_password]
organizational_unit_dn :: binary
exception_message :: binary
restore_from_snapshot_request :: [{:snapshot_id, snapshot_id}]
attributes :: [attribute]
disable_sso_request :: [directory_id: directory_id, password: connect_password, user_name: user_name]
create_alias_request :: [alias: alias_name, directory_id: directory_id]
disable_radius_request :: [{:directory_id, directory_id}]
computer_password :: binary
request_id :: binary
enable_radius_result :: []
attribute_value :: binary
access_url :: binary
delete_directory_request :: [{:directory_id, directory_id}]
radius_settings :: [authentication_protocol: radius_authentication_protocol, display_label: radius_display_label, radius_port: port_number, radius_retries: radius_retries, radius_servers: servers, radius_timeout: radius_timeout, shared_secret: radius_shared_secret, use_same_username: use_same_username]
describe_snapshots_request :: [directory_id: directory_id, limit: limit, next_token: next_token, snapshot_ids: snapshot_ids]
use_same_username :: boolean
directory_description :: [access_url: access_url, alias: alias_name, connect_settings: directory_connect_settings_description, description: description, directory_id: directory_id, dns_ip_addrs: dns_ip_addrs, launch_time: launch_time, name: directory_name, radius_settings: radius_settings, radius_status: radius_status, short_name: directory_short_name, size: directory_size, sso_enabled: sso_enabled, stage: directory_stage, stage_last_updated_date_time: last_updated_date_time, stage_reason: stage_reason, type: directory_type, vpc_settings: directory_vpc_settings_description]
snapshot :: [directory_id: directory_id, name: snapshot_name, snapshot_id: snapshot_id, start_time: start_time, status: snapshot_status, type: snapshot_type]
authentication_failed_exception :: [message: exception_message, request_id: request_id]
entity_already_exists_exception :: [message: exception_message, request_id: request_id]
next_token :: binary
port_number :: integer
last_updated_date_time :: integer
create_snapshot_request :: [directory_id: directory_id, name: snapshot_name]
snapshot_status :: binary
get_snapshot_limits_request :: [{:directory_id, directory_id}]
Functions
Specs:
- connect_directory(client :: ExAws.DirectoryService.t, input :: connect_directory_request) :: ExAws.Request.JSON.response_t
ConnectDirectory
Creates an AD Connector to connect an on-premises directory.
Specs:
- connect_directory!(client :: ExAws.DirectoryService.t, input :: connect_directory_request) :: ExAws.Request.JSON.success_t | no_return
Same as connect_directory/2
but raise on error.
Specs:
- create_alias(client :: ExAws.DirectoryService.t, input :: create_alias_request) :: ExAws.Request.JSON.response_t
CreateAlias
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.
**
Specs:
- create_alias!(client :: ExAws.DirectoryService.t, input :: create_alias_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_alias/2
but raise on error.
Specs:
- create_computer(client :: ExAws.DirectoryService.t, input :: create_computer_request) :: ExAws.Request.JSON.response_t
CreateComputer
Creates a computer account in the specified directory, and joins the computer to the directory.
Specs:
- create_computer!(client :: ExAws.DirectoryService.t, input :: create_computer_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_computer/2
but raise on error.
Specs:
- create_directory(client :: ExAws.DirectoryService.t, input :: create_directory_request) :: ExAws.Request.JSON.response_t
CreateDirectory
Creates a Simple AD directory.
Specs:
- create_directory!(client :: ExAws.DirectoryService.t, input :: create_directory_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_directory/2
but raise on error.
Specs:
- create_snapshot(client :: ExAws.DirectoryService.t, input :: create_snapshot_request) :: ExAws.Request.JSON.response_t
CreateSnapshot
Creates a snapshot of an existing directory.
You cannot take snapshots of extended or connected directories.
Specs:
- create_snapshot!(client :: ExAws.DirectoryService.t, input :: create_snapshot_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_snapshot/2
but raise on error.
Specs:
- delete_directory(client :: ExAws.DirectoryService.t, input :: delete_directory_request) :: ExAws.Request.JSON.response_t
DeleteDirectory
Deletes an AWS Directory Service directory.
Specs:
- delete_directory!(client :: ExAws.DirectoryService.t, input :: delete_directory_request) :: ExAws.Request.JSON.success_t | no_return
Same as delete_directory/2
but raise on error.
Specs:
- delete_snapshot(client :: ExAws.DirectoryService.t, input :: delete_snapshot_request) :: ExAws.Request.JSON.response_t
DeleteSnapshot
Deletes a directory snapshot.
Specs:
- delete_snapshot!(client :: ExAws.DirectoryService.t, input :: delete_snapshot_request) :: ExAws.Request.JSON.success_t | no_return
Same as delete_snapshot/2
but raise on error.
Specs:
- describe_directories(client :: ExAws.DirectoryService.t, input :: describe_directories_request) :: ExAws.Request.JSON.response_t
DescribeDirectories
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.
Specs:
- describe_directories!(client :: ExAws.DirectoryService.t, input :: describe_directories_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_directories/2
but raise on error.
Specs:
- describe_snapshots(client :: ExAws.DirectoryService.t, input :: describe_snapshots_request) :: ExAws.Request.JSON.response_t
DescribeSnapshots
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.
Specs:
- describe_snapshots!(client :: ExAws.DirectoryService.t, input :: describe_snapshots_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_snapshots/2
but raise on error.
Specs:
- disable_radius(client :: ExAws.DirectoryService.t, input :: disable_radius_request) :: ExAws.Request.JSON.response_t
DisableRadius
Disables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
Specs:
- disable_radius!(client :: ExAws.DirectoryService.t, input :: disable_radius_request) :: ExAws.Request.JSON.success_t | no_return
Same as disable_radius/2
but raise on error.
Specs:
- disable_sso(client :: ExAws.DirectoryService.t, input :: disable_sso_request) :: ExAws.Request.JSON.response_t
DisableSso
Disables single-sign on for a directory.
Specs:
- disable_sso!(client :: ExAws.DirectoryService.t, input :: disable_sso_request) :: ExAws.Request.JSON.success_t | no_return
Same as disable_sso/2
but raise on error.
Specs:
- enable_radius(client :: ExAws.DirectoryService.t, input :: enable_radius_request) :: ExAws.Request.JSON.response_t
EnableRadius
Enables multi-factor authentication (MFA) with Remote Authentication Dial In User Service (RADIUS) for an AD Connector directory.
Specs:
- enable_radius!(client :: ExAws.DirectoryService.t, input :: enable_radius_request) :: ExAws.Request.JSON.success_t | no_return
Same as enable_radius/2
but raise on error.
Specs:
- enable_sso(client :: ExAws.DirectoryService.t, input :: enable_sso_request) :: ExAws.Request.JSON.response_t
EnableSso
Enables single-sign on for a directory.
Specs:
- enable_sso!(client :: ExAws.DirectoryService.t, input :: enable_sso_request) :: ExAws.Request.JSON.success_t | no_return
Same as enable_sso/2
but raise on error.
Specs:
- get_directory_limits(client :: ExAws.DirectoryService.t, input :: get_directory_limits_request) :: ExAws.Request.JSON.response_t
GetDirectoryLimits
Obtains directory limit information for the current region.
Specs:
- get_directory_limits!(client :: ExAws.DirectoryService.t, input :: get_directory_limits_request) :: ExAws.Request.JSON.success_t | no_return
Same as get_directory_limits/2
but raise on error.
Specs:
- get_snapshot_limits(client :: ExAws.DirectoryService.t, input :: get_snapshot_limits_request) :: ExAws.Request.JSON.response_t
GetSnapshotLimits
Obtains the manual snapshot limits for a directory.
Specs:
- get_snapshot_limits!(client :: ExAws.DirectoryService.t, input :: get_snapshot_limits_request) :: ExAws.Request.JSON.success_t | no_return
Same as get_snapshot_limits/2
but raise on error.
Specs:
- restore_from_snapshot(client :: ExAws.DirectoryService.t, input :: restore_from_snapshot_request) :: ExAws.Request.JSON.response_t
RestoreFromSnapshot
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.
Specs:
- restore_from_snapshot!(client :: ExAws.DirectoryService.t, input :: restore_from_snapshot_request) :: ExAws.Request.JSON.success_t | no_return
Same as restore_from_snapshot/2
but raise on error.
Specs:
- update_radius(client :: ExAws.DirectoryService.t, input :: update_radius_request) :: ExAws.Request.JSON.response_t
UpdateRadius
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.
Specs:
- update_radius!(client :: ExAws.DirectoryService.t, input :: update_radius_request) :: ExAws.Request.JSON.success_t | no_return
Same as update_radius/2
but raise on error.