Directory Service
Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see Directory Service and the Directory Service Administration Guide.
Amazon Web Services 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 Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
directoryservice(
config = list(),
credentials = list(),
endpoint = NULL,
region = NULL
)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.
credentials:
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
Optional credentials shorthand for the config parameter
creds:
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
Optional shorthand for complete URL to use for the constructed client.
Optional shorthand for AWS Region used in instantiating the client.
svc <- directoryservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
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 self-managed 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 a self-managed 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 Amazon Web Services 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 Amazon Web Services account |
| create_microsoft_ad | Creates a Microsoft AD directory in the Amazon Web Services Cloud |
| create_snapshot | Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud |
| create_trust | 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 Amazon Web Services directory |
| delete_directory | Deletes an 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 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 Amazon SNS topic |
| describe_certificate | Displays information about the certificate registered for secure LDAP or client certificate authentication |
| describe_client_authentication_settings | Retrieves information about the type of client authentication for the specified directory, if the type is specified |
| 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 Amazon 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_settings | Retrieves information about the configurable settings for the specified directory |
| 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 |
| describe_update_directory | Describes the updates of a directory for a particular update type |
| 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 Amazon Web Services 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 Amazon 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 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 Amazon Web Services account (directory owner) with another Amazon Web Services 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 Amazon Web Services directory |
| update_directory_setup | Updates the directory for a particular update type |
| 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_settings | Updates the configurable settings for the specified directory |
| update_trust | Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory |
| verify_trust | 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