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.
directoryservice(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
svc <- directoryservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string"
),
endpoint = "string",
region = "string"
)
)
| accept_shared_directory | Accepts a directory sharing request that was sent from the directory owner account |
| add_ip_routes | 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 |
| add_region | Adds two domain controllers in the specified Region for the specified directory |
| add_tags_to_resource | Adds or overwrites one or more tags for the specified directory |
| cancel_schema_extension | Cancels an in-progress schema extension to a Microsoft AD directory |
| connect_directory | Creates an AD Connector to connect to an on-premises directory |
| create_alias | Creates an alias for a directory and assigns the alias to the directory |
| create_computer | Creates an Active Directory computer object in the specified directory |
| create_conditional_forwarder | Creates a conditional forwarder associated with your AWS directory |
| create_directory | Creates a Simple AD directory |
| create_log_subscription | Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account |
| create_microsoft_ad | Creates a Microsoft AD directory in the AWS Cloud |
| create_snapshot | Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud |
| create_trust | AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships |
| delete_conditional_forwarder | Deletes a conditional forwarder that has been set up for your AWS directory |
| delete_directory | Deletes an AWS Directory Service directory |
| delete_log_subscription | Deletes the specified log subscription |
| delete_snapshot | Deletes a directory snapshot |
| delete_trust | Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain |
| deregister_certificate | Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication |
| deregister_event_topic | Removes the specified directory as a publisher to the specified SNS topic |
| describe_certificate | Displays information about the certificate registered for secure LDAP or client certificate authentication |
| describe_conditional_forwarders | Obtains information about the conditional forwarders for this account |
| describe_directories | Obtains information about the directories that belong to this account |
| describe_domain_controllers | Provides information about any domain controllers in your directory |
| describe_event_topics | Obtains information about which SNS topics receive status messages from the specified directory |
| describe_ldaps_settings | Describes the status of LDAP security for the specified directory |
| describe_regions | Provides information about the Regions that are configured for multi-Region replication |
| describe_shared_directories | Returns the shared directories in your account |
| describe_snapshots | Obtains information about the directory snapshots that belong to this account |
| describe_trusts | Obtains information about the trust relationships for this account |
| disable_client_authentication | Disables alternative client authentication methods for the specified directory |
| disable_ldaps | Deactivates LDAP secure calls for the specified directory |
| disable_radius | Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory |
| disable_sso | Disables single-sign on for a directory |
| enable_client_authentication | Enables alternative client authentication methods for the specified directory |
| enable_ldaps | Activates the switch for the specific directory to always use LDAP secure calls |
| enable_radius | Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory |
| enable_sso | Enables single sign-on for a directory |
| get_directory_limits | Obtains directory limit information for the current Region |
| get_snapshot_limits | Obtains the manual snapshot limits for a directory |
| list_certificates | For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication |
| list_ip_routes | Lists the address blocks that you have added to a directory |
| list_log_subscriptions | Lists the active log subscriptions for the AWS account |
| list_schema_extensions | Lists all schema extensions applied to a Microsoft AD Directory |
| list_tags_for_resource | Lists all tags on a directory |
| register_certificate | Registers a certificate for a secure LDAP or client certificate authentication |
| register_event_topic | Associates a directory with an SNS topic |
| reject_shared_directory | Rejects a directory sharing request that was sent from the directory owner account |
| remove_ip_routes | Removes IP address blocks from a directory |
| remove_region | Stops all replication and removes the domain controllers from the specified Region |
| remove_tags_from_resource | Removes tags from a directory |
| reset_user_password | Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory |
| restore_from_snapshot | Restores a directory using an existing directory snapshot |
| share_directory | Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer) |
| start_schema_extension | Applies a schema extension to a Microsoft AD directory |
| unshare_directory | Stops the directory sharing between the directory owner and consumer accounts |
| update_conditional_forwarder | Updates a conditional forwarder that has been set up for your AWS directory |
| update_number_of_domain_controllers | Adds or removes domain controllers to or from the directory |
| update_radius | Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory |
| update_trust | Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory |
| verify_trust | AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships |
if (FALSE) {
svc <- directoryservice()
svc$accept_shared_directory(
Foo = 123
)
}
Run the code above in your browser using DataLab