You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DirectoryService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



261
262
263
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 261

def initialize(*args)
  super
end

Instance Method Details

#accept_shared_directory(params = {}) ⇒ Types::AcceptSharedDirectoryResult

Accepts a directory sharing request that was sent from the directory owner account.

Examples:

Request syntax with placeholder values


resp = client.accept_shared_directory({
  shared_directory_id: "DirectoryId", # required
})

Response structure


resp.shared_directory. #=> String
resp.shared_directory.owner_directory_id #=> String
resp.shared_directory.share_method #=> String, one of "ORGANIZATIONS", "HANDSHAKE"
resp.shared_directory. #=> String
resp.shared_directory.shared_directory_id #=> String
resp.shared_directory.share_status #=> String, one of "Shared", "PendingAcceptance", "Rejected", "Rejecting", "RejectFailed", "Sharing", "ShareFailed", "Deleted", "Deleting"
resp.shared_directory.share_notes #=> String
resp.shared_directory.created_date_time #=> Time
resp.shared_directory.last_updated_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :shared_directory_id (required, String) —

    Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

Returns:

See Also:



300
301
302
303
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 300

def accept_shared_directory(params = {}, options = {})
  req = build_request(:accept_shared_directory, params)
  req.send_request(options)
end

#add_ip_routes(params = {}) ⇒ Struct

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. AddIpRoutes adds this address block. You can also use 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.

Examples:

Request syntax with placeholder values


resp = client.add_ip_routes({
  directory_id: "DirectoryId", # required
  ip_routes: [ # required
    {
      cidr_ip: "CidrIp",
      description: "Description",
    },
  ],
  update_security_group_for_directory_controllers: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier (ID) of the directory to which to add the address block.

  • :ip_routes (required, Array<Types::IpRoute>) —

    IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

  • :update_security_group_for_directory_controllers (Boolean) —

    If set to true, updates the inbound and outbound rules of the security group that has the description: "AWS created security group for directory ID directory controllers." Following are the new rules:

    Inbound:

    • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

    • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

    • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

    • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

    • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

    • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0

    • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0

    • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

    • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

    • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

    • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

    Outbound:

    • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

    ^

    These security rules impact an internal network interface that is not exposed publicly.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



403
404
405
406
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 403

def add_ip_routes(params = {}, options = {})
  req = build_request(:add_ip_routes, params)
  req.send_request(options)
end

#add_tags_to_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.add_tags_to_resource({
  resource_id: "ResourceId", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Identifier (ID) for the directory to which to add the tag.

  • :tags (required, Array<Types::Tag>) —

    The tags to be assigned to the directory.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



436
437
438
439
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 436

def add_tags_to_resource(params = {}, options = {})
  req = build_request(:add_tags_to_resource, params)
  req.send_request(options)
end

#cancel_schema_extension(params = {}) ⇒ Struct

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; Initializing, CreatingSnapshot, and UpdatingSchema.

Examples:

Request syntax with placeholder values


resp = client.cancel_schema_extension({
  directory_id: "DirectoryId", # required
  schema_extension_id: "SchemaExtensionId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory whose schema extension will be canceled.

  • :schema_extension_id (required, String) —

    The identifier of the schema extension that will be canceled.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



467
468
469
470
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 467

def cancel_schema_extension(params = {}, options = {})
  req = build_request(:cancel_schema_extension, params)
  req.send_request(options)
end

#connect_directory(params = {}) ⇒ Types::ConnectDirectoryResult

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.

Examples:

Request syntax with placeholder values


resp = client.connect_directory({
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "ConnectPassword", # required
  description: "Description",
  size: "Small", # required, accepts Small, Large
  connect_settings: { # required
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
    customer_dns_ips: ["IpAddr"], # required
    customer_user_name: "UserName", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The fully qualified name of the on-premises directory, such as corp.example.com.

  • :short_name (String) —

    The NetBIOS name of the on-premises directory, such as CORP.

  • :password (required, String) —

    The password for the on-premises user account.

  • :description (String) —

    A description for the directory.

  • :size (required, String) —

    The size of the directory.

  • :connect_settings (required, Types::DirectoryConnectSettings) —

    A DirectoryConnectSettings object that contains additional information for the operation.

  • :tags (Array<Types::Tag>) —

    The tags to be assigned to AD Connector.

Returns:

See Also:



541
542
543
544
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 541

def connect_directory(params = {}, options = {})
  req = build_request(:connect_directory, params)
  req.send_request(options)
end

#create_alias(params = {}) ⇒ Types::CreateAliasResult

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.

Examples:

Request syntax with placeholder values


resp = client.create_alias({
  directory_id: "DirectoryId", # required
  alias: "AliasName", # required
})

Response structure


resp.directory_id #=> String
resp.alias #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to create the alias.

  • :alias (required, String) —

    The requested alias.

    The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

Returns:

See Also:



584
585
586
587
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 584

def create_alias(params = {}, options = {})
  req = build_request(:create_alias, params)
  req.send_request(options)
end

#create_computer(params = {}) ⇒ Types::CreateComputerResult

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

Examples:

Request syntax with placeholder values


resp = client.create_computer({
  directory_id: "DirectoryId", # required
  computer_name: "ComputerName", # required
  password: "ComputerPassword", # required
  organizational_unit_distinguished_name: "OrganizationalUnitDN",
  computer_attributes: [
    {
      name: "AttributeName",
      value: "AttributeValue",
    },
  ],
})

Response structure


resp.computer.computer_id #=> String
resp.computer.computer_name #=> String
resp.computer.computer_attributes #=> Array
resp.computer.computer_attributes[0].name #=> String
resp.computer.computer_attributes[0].value #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory in which to create the computer account.

  • :computer_name (required, String) —

    The name of the computer account.

  • :password (required, String) —

    A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

  • :organizational_unit_distinguished_name (String) —

    The fully-qualified distinguished name of the organizational unit to place the computer account in.

  • :computer_attributes (Array<Types::Attribute>) —

    An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 643

def create_computer(params = {}, options = {})
  req = build_request(:create_computer, params)
  req.send_request(options)
end

#create_conditional_forwarder(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.create_conditional_forwarder({
  directory_id: "DirectoryId", # required
  remote_domain_name: "RemoteDomainName", # required
  dns_ip_addrs: ["IpAddr"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The directory ID of the AWS directory for which you are creating the conditional forwarder.

  • :remote_domain_name (required, String) —

    The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

  • :dns_ip_addrs (required, Array<String>) —

    The IP addresses of the remote DNS server associated with RemoteDomainName.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



679
680
681
682
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 679

def create_conditional_forwarder(params = {}, options = {})
  req = build_request(:create_conditional_forwarder, params)
  req.send_request(options)
end

#create_directory(params = {}) ⇒ Types::CreateDirectoryResult

Creates a Simple AD directory. For more information, see Simple Active Directory in the AWS Directory Service Admin Guide.

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.

Examples:

Request syntax with placeholder values


resp = client.create_directory({
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "Password", # required
  description: "Description",
  size: "Small", # required, accepts Small, Large
  vpc_settings: {
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The fully qualified name for the directory, such as corp.example.com.

  • :short_name (String) —

    The NetBIOS name of the directory, such as CORP.

  • :password (required, String) —

    The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

    If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

  • :description (String) —

    A description for the directory.

  • :size (required, String) —

    The size of the directory.

  • :vpc_settings (Types::DirectoryVpcSettings) —

    A DirectoryVpcSettings object that contains additional information for the operation.

  • :tags (Array<Types::Tag>) —

    The tags to be assigned to the Simple AD directory.

Returns:

See Also:



758
759
760
761
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 758

def create_directory(params = {}, options = {})
  req = build_request(:create_directory, params)
  req.send_request(options)
end

#create_log_subscription(params = {}) ⇒ Struct

Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your AWS account.

Examples:

Request syntax with placeholder values


resp = client.create_log_subscription({
  directory_id: "DirectoryId", # required
  log_group_name: "LogGroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.

  • :log_group_name (required, String) —

    The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



788
789
790
791
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 788

def create_log_subscription(params = {}, options = {})
  req = build_request(:create_log_subscription, params)
  req.send_request(options)
end

#create_microsoft_ad(params = {}) ⇒ Types::CreateMicrosoftADResult

Creates a Microsoft AD directory in the AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS Directory Service Admin Guide.

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.

Examples:

Request syntax with placeholder values


resp = client.create_microsoft_ad({
  name: "DirectoryName", # required
  short_name: "DirectoryShortName",
  password: "Password", # required
  description: "Description",
  vpc_settings: { # required
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
  },
  edition: "Enterprise", # accepts Enterprise, Standard
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

  • :short_name (String) —

    The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

  • :password (required, String) —

    The password for the default administrative user named Admin.

    If you need to change the password for the administrator account, you can use the ResetUserPassword API call.

  • :description (String) —

    A description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

  • :vpc_settings (required, Types::DirectoryVpcSettings) —

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

  • :edition (String) —

    AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

  • :tags (Array<Types::Tag>) —

    The tags to be assigned to the AWS Managed Microsoft AD directory.

Returns:

See Also:



872
873
874
875
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 872

def create_microsoft_ad(params = {}, options = {})
  req = build_request(:create_microsoft_ad, params)
  req.send_request(options)
end

#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResult

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

You cannot take snapshots of AD Connector directories.

Examples:

Request syntax with placeholder values


resp = client.create_snapshot({
  directory_id: "DirectoryId", # required
  name: "SnapshotName",
})

Response structure


resp.snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory of which to take a snapshot.

  • :name (String) —

    The descriptive name to apply to the snapshot.

Returns:

See Also:



909
910
911
912
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 909

def create_snapshot(params = {}, options = {})
  req = build_request(:create_snapshot, params)
  req.send_request(options)
end

#create_trust(params = {}) ⇒ Types::CreateTrustResult

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, 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 an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

Examples:

Request syntax with placeholder values


resp = client.create_trust({
  directory_id: "DirectoryId", # required
  remote_domain_name: "RemoteDomainName", # required
  trust_password: "TrustPassword", # required
  trust_direction: "One-Way: Outgoing", # required, accepts One-Way: Outgoing, One-Way: Incoming, Two-Way
  trust_type: "Forest", # accepts Forest, External
  conditional_forwarder_ip_addrs: ["IpAddr"],
  selective_auth: "Enabled", # accepts Enabled, Disabled
})

Response structure


resp.trust_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.

  • :remote_domain_name (required, String) —

    The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

  • :trust_password (required, String) —

    The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

  • :trust_direction (required, String) —

    The direction of the trust relationship.

  • :trust_type (String) —

    The trust relationship type. Forest is the default.

  • :conditional_forwarder_ip_addrs (Array<String>) —

    The IP addresses of the remote DNS server associated with RemoteDomainName.

  • :selective_auth (String) —

    Optional parameter to enable selective authentication for the trust.

Returns:

See Also:



975
976
977
978
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 975

def create_trust(params = {}, options = {})
  req = build_request(:create_trust, params)
  req.send_request(options)
end

#delete_conditional_forwarder(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_conditional_forwarder({
  directory_id: "DirectoryId", # required
  remote_domain_name: "RemoteDomainName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The directory ID for which you are deleting the conditional forwarder.

  • :remote_domain_name (required, String) —

    The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1003
1004
1005
1006
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1003

def delete_conditional_forwarder(params = {}, options = {})
  req = build_request(:delete_conditional_forwarder, params)
  req.send_request(options)
end

#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResult

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.

Examples:

Request syntax with placeholder values


resp = client.delete_directory({
  directory_id: "DirectoryId", # required
})

Response structure


resp.directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory to delete.

Returns:

See Also:



1041
1042
1043
1044
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1041

def delete_directory(params = {}, options = {})
  req = build_request(:delete_directory, params)
  req.send_request(options)
end

#delete_log_subscription(params = {}) ⇒ Struct

Deletes the specified log subscription.

Examples:

Request syntax with placeholder values


resp = client.delete_log_subscription({
  directory_id: "DirectoryId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the directory whose log subscription you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1063
1064
1065
1066
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1063

def delete_log_subscription(params = {}, options = {})
  req = build_request(:delete_log_subscription, params)
  req.send_request(options)
end

#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResult

Deletes a directory snapshot.

Examples:

Request syntax with placeholder values


resp = client.delete_snapshot({
  snapshot_id: "SnapshotId", # required
})

Response structure


resp.snapshot_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The identifier of the directory snapshot to be deleted.

Returns:

See Also:



1091
1092
1093
1094
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1091

def delete_snapshot(params = {}, options = {})
  req = build_request(:delete_snapshot, params)
  req.send_request(options)
end

#delete_trust(params = {}) ⇒ Types::DeleteTrustResult

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

Examples:

Request syntax with placeholder values


resp = client.delete_trust({
  trust_id: "TrustId", # required
  delete_associated_conditional_forwarder: false,
})

Response structure


resp.trust_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_id (required, String) —

    The Trust ID of the trust relationship to be deleted.

  • :delete_associated_conditional_forwarder (Boolean) —

    Delete a conditional forwarder as part of a DeleteTrustRequest.

Returns:

See Also:



1124
1125
1126
1127
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1124

def delete_trust(params = {}, options = {})
  req = build_request(:delete_trust, params)
  req.send_request(options)
end

#deregister_certificate(params = {}) ⇒ Struct

Deletes from the system the certificate that was registered for a secured LDAP connection.

Examples:

Request syntax with placeholder values


resp = client.deregister_certificate({
  directory_id: "DirectoryId", # required
  certificate_id: "CertificateId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :certificate_id (required, String) —

    The identifier of the certificate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1151

def deregister_certificate(params = {}, options = {})
  req = build_request(:deregister_certificate, params)
  req.send_request(options)
end

#deregister_event_topic(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.deregister_event_topic({
  directory_id: "DirectoryId", # required
  topic_name: "TopicName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

  • :topic_name (required, String) —

    The name of the SNS topic from which to remove the directory as a publisher.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1180
1181
1182
1183
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1180

def deregister_event_topic(params = {}, options = {})
  req = build_request(:deregister_event_topic, params)
  req.send_request(options)
end

#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResult

Displays information about the certificate registered for a secured LDAP connection.

Examples:

Request syntax with placeholder values


resp = client.describe_certificate({
  directory_id: "DirectoryId", # required
  certificate_id: "CertificateId", # required
})

Response structure


resp.certificate.certificate_id #=> String
resp.certificate.state #=> String, one of "Registering", "Registered", "RegisterFailed", "Deregistering", "Deregistered", "DeregisterFailed"
resp.certificate.state_reason #=> String
resp.certificate.common_name #=> String
resp.certificate.registered_date_time #=> Time
resp.certificate.expiry_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :certificate_id (required, String) —

    The identifier of the certificate.

Returns:

See Also:



1218
1219
1220
1221
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1218

def describe_certificate(params = {}, options = {})
  req = build_request(:describe_certificate, params)
  req.send_request(options)
end

#describe_conditional_forwarders(params = {}) ⇒ Types::DescribeConditionalForwardersResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_conditional_forwarders({
  directory_id: "DirectoryId", # required
  remote_domain_names: ["RemoteDomainName"],
})

Response structure


resp.conditional_forwarders #=> Array
resp.conditional_forwarders[0].remote_domain_name #=> String
resp.conditional_forwarders[0].dns_ip_addrs #=> Array
resp.conditional_forwarders[0].dns_ip_addrs[0] #=> String
resp.conditional_forwarders[0].replication_scope #=> String, one of "Domain"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The directory ID for which to get the list of associated conditional forwarders.

  • :remote_domain_names (Array<String>) —

    The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

Returns:

See Also:



1261
1262
1263
1264
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1261

def describe_conditional_forwarders(params = {}, options = {})
  req = build_request(:describe_conditional_forwarders, params)
  req.send_request(options)
end

#describe_directories(params = {}) ⇒ Types::DescribeDirectoriesResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_directories({
  directory_ids: ["DirectoryId"],
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.directory_descriptions #=> Array
resp.directory_descriptions[0].directory_id #=> String
resp.directory_descriptions[0].name #=> String
resp.directory_descriptions[0].short_name #=> String
resp.directory_descriptions[0].size #=> String, one of "Small", "Large"
resp.directory_descriptions[0].edition #=> String, one of "Enterprise", "Standard"
resp.directory_descriptions[0].alias #=> String
resp.directory_descriptions[0].access_url #=> String
resp.directory_descriptions[0].description #=> String
resp.directory_descriptions[0].dns_ip_addrs #=> Array
resp.directory_descriptions[0].dns_ip_addrs[0] #=> String
resp.directory_descriptions[0].stage #=> String, one of "Requested", "Creating", "Created", "Active", "Inoperable", "Impaired", "Restoring", "RestoreFailed", "Deleting", "Deleted", "Failed"
resp.directory_descriptions[0].share_status #=> String, one of "Shared", "PendingAcceptance", "Rejected", "Rejecting", "RejectFailed", "Sharing", "ShareFailed", "Deleted", "Deleting"
resp.directory_descriptions[0].share_method #=> String, one of "ORGANIZATIONS", "HANDSHAKE"
resp.directory_descriptions[0].share_notes #=> String
resp.directory_descriptions[0].launch_time #=> Time
resp.directory_descriptions[0].stage_last_updated_date_time #=> Time
resp.directory_descriptions[0].type #=> String, one of "SimpleAD", "ADConnector", "MicrosoftAD", "SharedMicrosoftAD"
resp.directory_descriptions[0].vpc_settings.vpc_id #=> String
resp.directory_descriptions[0].vpc_settings.subnet_ids #=> Array
resp.directory_descriptions[0].vpc_settings.subnet_ids[0] #=> String
resp.directory_descriptions[0].vpc_settings.security_group_id #=> String
resp.directory_descriptions[0].vpc_settings.availability_zones #=> Array
resp.directory_descriptions[0].vpc_settings.availability_zones[0] #=> String
resp.directory_descriptions[0].connect_settings.vpc_id #=> String
resp.directory_descriptions[0].connect_settings.subnet_ids #=> Array
resp.directory_descriptions[0].connect_settings.subnet_ids[0] #=> String
resp.directory_descriptions[0].connect_settings.customer_user_name #=> String
resp.directory_descriptions[0].connect_settings.security_group_id #=> String
resp.directory_descriptions[0].connect_settings.availability_zones #=> Array
resp.directory_descriptions[0].connect_settings.availability_zones[0] #=> String
resp.directory_descriptions[0].connect_settings.connect_ips #=> Array
resp.directory_descriptions[0].connect_settings.connect_ips[0] #=> String
resp.directory_descriptions[0].radius_settings.radius_servers #=> Array
resp.directory_descriptions[0].radius_settings.radius_servers[0] #=> String
resp.directory_descriptions[0].radius_settings.radius_port #=> Integer
resp.directory_descriptions[0].radius_settings.radius_timeout #=> Integer
resp.directory_descriptions[0].radius_settings.radius_retries #=> Integer
resp.directory_descriptions[0].radius_settings.shared_secret #=> String
resp.directory_descriptions[0].radius_settings.authentication_protocol #=> String, one of "PAP", "CHAP", "MS-CHAPv1", "MS-CHAPv2"
resp.directory_descriptions[0].radius_settings.display_label #=> String
resp.directory_descriptions[0].radius_settings.use_same_username #=> Boolean
resp.directory_descriptions[0].radius_status #=> String, one of "Creating", "Completed", "Failed"
resp.directory_descriptions[0].stage_reason #=> String
resp.directory_descriptions[0].sso_enabled #=> Boolean
resp.directory_descriptions[0].desired_number_of_domain_controllers #=> Integer
resp.directory_descriptions[0].owner_directory_description.directory_id #=> String
resp.directory_descriptions[0].owner_directory_description. #=> String
resp.directory_descriptions[0].owner_directory_description.dns_ip_addrs #=> Array
resp.directory_descriptions[0].owner_directory_description.dns_ip_addrs[0] #=> String
resp.directory_descriptions[0].owner_directory_description.vpc_settings.vpc_id #=> String
resp.directory_descriptions[0].owner_directory_description.vpc_settings.subnet_ids #=> Array
resp.directory_descriptions[0].owner_directory_description.vpc_settings.subnet_ids[0] #=> String
resp.directory_descriptions[0].owner_directory_description.vpc_settings.security_group_id #=> String
resp.directory_descriptions[0].owner_directory_description.vpc_settings.availability_zones #=> Array
resp.directory_descriptions[0].owner_directory_description.vpc_settings.availability_zones[0] #=> String
resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_servers #=> Array
resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_servers[0] #=> String
resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_port #=> Integer
resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_timeout #=> Integer
resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_retries #=> Integer
resp.directory_descriptions[0].owner_directory_description.radius_settings.shared_secret #=> String
resp.directory_descriptions[0].owner_directory_description.radius_settings.authentication_protocol #=> String, one of "PAP", "CHAP", "MS-CHAPv1", "MS-CHAPv2"
resp.directory_descriptions[0].owner_directory_description.radius_settings.display_label #=> String
resp.directory_descriptions[0].owner_directory_description.radius_settings.use_same_username #=> Boolean
resp.directory_descriptions[0].owner_directory_description.radius_status #=> String, one of "Creating", "Completed", "Failed"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_ids (Array<String>) —

    A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

    An empty list results in an InvalidParameterException being thrown.

  • :next_token (String) —

    The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

  • :limit (Integer) —

    The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Returns:

See Also:



1384
1385
1386
1387
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1384

def describe_directories(params = {}, options = {})
  req = build_request(:describe_directories, params)
  req.send_request(options)
end

#describe_domain_controllers(params = {}) ⇒ Types::DescribeDomainControllersResult

Provides information about any domain controllers in your directory.

Examples:

Request syntax with placeholder values


resp = client.describe_domain_controllers({
  directory_id: "DirectoryId", # required
  domain_controller_ids: ["DomainControllerId"],
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.domain_controllers #=> Array
resp.domain_controllers[0].directory_id #=> String
resp.domain_controllers[0].domain_controller_id #=> String
resp.domain_controllers[0].dns_ip_addr #=> String
resp.domain_controllers[0].vpc_id #=> String
resp.domain_controllers[0].subnet_id #=> String
resp.domain_controllers[0].availability_zone #=> String
resp.domain_controllers[0].status #=> String, one of "Creating", "Active", "Impaired", "Restoring", "Deleting", "Deleted", "Failed"
resp.domain_controllers[0].status_reason #=> String
resp.domain_controllers[0].launch_time #=> Time
resp.domain_controllers[0].status_last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the directory for which to retrieve the domain controller information.

  • :domain_controller_ids (Array<String>) —

    A list of identifiers for the domain controllers whose information will be provided.

  • :next_token (String) —

    The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

  • :limit (Integer) —

    The maximum number of items to return.

Returns:

See Also:



1439
1440
1441
1442
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1439

def describe_domain_controllers(params = {}, options = {})
  req = build_request(:describe_domain_controllers, params)
  req.send_request(options)
end

#describe_event_topics(params = {}) ⇒ Types::DescribeEventTopicsResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_event_topics({
  directory_id: "DirectoryId",
  topic_names: ["TopicName"],
})

Response structure


resp.event_topics #=> Array
resp.event_topics[0].directory_id #=> String
resp.event_topics[0].topic_name #=> String
resp.event_topics[0].topic_arn #=> String
resp.event_topics[0].created_date_time #=> Time
resp.event_topics[0].status #=> String, one of "Registered", "Topic not found", "Failed", "Deleted"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (String) —

    The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

  • :topic_names (Array<String>) —

    A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

    An empty list results in an InvalidParameterException being thrown.

Returns:

See Also:



1486
1487
1488
1489
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1486

def describe_event_topics(params = {}, options = {})
  req = build_request(:describe_event_topics, params)
  req.send_request(options)
end

#describe_ldaps_settings(params = {}) ⇒ Types::DescribeLDAPSSettingsResult

Describes the status of LDAP security for the specified directory.

Examples:

Request syntax with placeholder values


resp = client.describe_ldaps_settings({
  directory_id: "DirectoryId", # required
  type: "Client", # accepts Client
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.ldaps_settings_info #=> Array
resp.ldaps_settings_info[0].ldaps_status #=> String, one of "Enabling", "Enabled", "EnableFailed", "Disabled"
resp.ldaps_settings_info[0].ldaps_status_reason #=> String
resp.ldaps_settings_info[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :type (String) —

    The type of LDAP security to enable. Currently only the value Client is supported.

  • :next_token (String) —

    The type of next token used for pagination.

  • :limit (Integer) —

    Specifies the number of items that should be displayed on one page.

Returns:

See Also:



1532
1533
1534
1535
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1532

def describe_ldaps_settings(params = {}, options = {})
  req = build_request(:describe_ldaps_settings, params)
  req.send_request(options)
end

#describe_shared_directories(params = {}) ⇒ Types::DescribeSharedDirectoriesResult

Returns the shared directories in your account.

Examples:

Request syntax with placeholder values


resp = client.describe_shared_directories({
  owner_directory_id: "DirectoryId", # required
  shared_directory_ids: ["DirectoryId"],
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.shared_directories #=> Array
resp.shared_directories[0]. #=> String
resp.shared_directories[0].owner_directory_id #=> String
resp.shared_directories[0].share_method #=> String, one of "ORGANIZATIONS", "HANDSHAKE"
resp.shared_directories[0]. #=> String
resp.shared_directories[0].shared_directory_id #=> String
resp.shared_directories[0].share_status #=> String, one of "Shared", "PendingAcceptance", "Rejected", "Rejecting", "RejectFailed", "Sharing", "ShareFailed", "Deleted", "Deleting"
resp.shared_directories[0].share_notes #=> String
resp.shared_directories[0].created_date_time #=> Time
resp.shared_directories[0].last_updated_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :owner_directory_id (required, String) —

    Returns the identifier of the directory in the directory owner account.

  • :shared_directory_ids (Array<String>) —

    A list of identifiers of all shared directories in your account.

  • :next_token (String) —

    The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

  • :limit (Integer) —

    The number of shared directories to return in the response object.

Returns:

See Also:



1586
1587
1588
1589
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1586

def describe_shared_directories(params = {}, options = {})
  req = build_request(:describe_shared_directories, params)
  req.send_request(options)
end

#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_snapshots({
  directory_id: "DirectoryId",
  snapshot_ids: ["SnapshotId"],
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.snapshots #=> Array
resp.snapshots[0].directory_id #=> String
resp.snapshots[0].snapshot_id #=> String
resp.snapshots[0].type #=> String, one of "Auto", "Manual"
resp.snapshots[0].name #=> String
resp.snapshots[0].status #=> String, one of "Creating", "Completed", "Failed"
resp.snapshots[0].start_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (String) —

    The identifier of the directory for which to retrieve snapshot information.

  • :snapshot_ids (Array<String>) —

    A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

  • :next_token (String) —

    The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

  • :limit (Integer) —

    The maximum number of objects to return.

Returns:

See Also:



1647
1648
1649
1650
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1647

def describe_snapshots(params = {}, options = {})
  req = build_request(:describe_snapshots, params)
  req.send_request(options)
end

#describe_trusts(params = {}) ⇒ Types::DescribeTrustsResult

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.

Examples:

Request syntax with placeholder values


resp = client.describe_trusts({
  directory_id: "DirectoryId",
  trust_ids: ["TrustId"],
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.trusts #=> Array
resp.trusts[0].directory_id #=> String
resp.trusts[0].trust_id #=> String
resp.trusts[0].remote_domain_name #=> String
resp.trusts[0].trust_type #=> String, one of "Forest", "External"
resp.trusts[0].trust_direction #=> String, one of "One-Way: Outgoing", "One-Way: Incoming", "Two-Way"
resp.trusts[0].trust_state #=> String, one of "Creating", "Created", "Verifying", "VerifyFailed", "Verified", "Updating", "UpdateFailed", "Updated", "Deleting", "Deleted", "Failed"
resp.trusts[0].created_date_time #=> Time
resp.trusts[0].last_updated_date_time #=> Time
resp.trusts[0].state_last_updated_date_time #=> Time
resp.trusts[0].trust_state_reason #=> String
resp.trusts[0].selective_auth #=> String, one of "Enabled", "Disabled"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (String) —

    The Directory ID of the AWS directory that is a part of the requested trust relationship.

  • :trust_ids (Array<String>) —

    A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

    An empty list results in an InvalidParameterException being thrown.

  • :next_token (String) —

    The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.

  • :limit (Integer) —

    The maximum number of objects to return.

Returns:

See Also:



1710
1711
1712
1713
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1710

def describe_trusts(params = {}, options = {})
  req = build_request(:describe_trusts, params)
  req.send_request(options)
end

#disable_ldaps(params = {}) ⇒ Struct

Deactivates LDAP secure calls for the specified directory.

Examples:

Request syntax with placeholder values


resp = client.disable_ldaps({
  directory_id: "DirectoryId", # required
  type: "Client", # required, accepts Client
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :type (required, String) —

    The type of LDAP security to enable. Currently only the value Client is supported.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1737
1738
1739
1740
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1737

def disable_ldaps(params = {}, options = {})
  req = build_request(:disable_ldaps, params)
  req.send_request(options)
end

#disable_radius(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disable_radius({
  directory_id: "DirectoryId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to disable MFA.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1761
1762
1763
1764
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1761

def disable_radius(params = {}, options = {})
  req = build_request(:disable_radius, params)
  req.send_request(options)
end

#disable_sso(params = {}) ⇒ Struct

Disables single-sign on for a directory.

Examples:

Request syntax with placeholder values


resp = client.disable_sso({
  directory_id: "DirectoryId", # required
  user_name: "UserName",
  password: "ConnectPassword",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to disable single-sign on.

  • :user_name (String) —

    The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

    If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

  • :password (String) —

    The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1801
1802
1803
1804
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1801

def disable_sso(params = {}, options = {})
  req = build_request(:disable_sso, params)
  req.send_request(options)
end

#enable_ldaps(params = {}) ⇒ Struct

Activates the switch for the specific directory to always use LDAP secure calls.

Examples:

Request syntax with placeholder values


resp = client.enable_ldaps({
  directory_id: "DirectoryId", # required
  type: "Client", # required, accepts Client
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :type (required, String) —

    The type of LDAP security to enable. Currently only the value Client is supported.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1829
1830
1831
1832
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1829

def enable_ldaps(params = {}, options = {})
  req = build_request(:enable_ldaps, params)
  req.send_request(options)
end

#enable_radius(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.enable_radius({
  directory_id: "DirectoryId", # required
  radius_settings: { # required
    radius_servers: ["Server"],
    radius_port: 1,
    radius_timeout: 1,
    radius_retries: 1,
    shared_secret: "RadiusSharedSecret",
    authentication_protocol: "PAP", # accepts PAP, CHAP, MS-CHAPv1, MS-CHAPv2
    display_label: "RadiusDisplayLabel",
    use_same_username: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to enable MFA.

  • :radius_settings (required, Types::RadiusSettings) —

    A RadiusSettings object that contains information about the RADIUS server.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1867
1868
1869
1870
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1867

def enable_radius(params = {}, options = {})
  req = build_request(:enable_radius, params)
  req.send_request(options)
end

#enable_sso(params = {}) ⇒ Struct

Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately.

Examples:

Request syntax with placeholder values


resp = client.enable_sso({
  directory_id: "DirectoryId", # required
  user_name: "UserName",
  password: "ConnectPassword",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to enable single-sign on.

  • :user_name (String) —

    The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

    If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

  • :password (String) —

    The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1909
1910
1911
1912
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1909

def enable_sso(params = {}, options = {})
  req = build_request(:enable_sso, params)
  req.send_request(options)
end

#get_directory_limits(params = {}) ⇒ Types::GetDirectoryLimitsResult

Obtains directory limit information for the current Region.

Examples:

Response structure


resp.directory_limits.cloud_only_directories_limit #=> Integer
resp.directory_limits.cloud_only_directories_current_count #=> Integer
resp.directory_limits.cloud_only_directories_limit_reached #=> Boolean
resp.directory_limits.cloud_only_microsoft_ad_limit #=> Integer
resp.directory_limits.cloud_only_microsoft_ad_current_count #=> Integer
resp.directory_limits.cloud_only_microsoft_ad_limit_reached #=> Boolean
resp.directory_limits.connected_directories_limit #=> Integer
resp.directory_limits.connected_directories_current_count #=> Integer
resp.directory_limits.connected_directories_limit_reached #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1936
1937
1938
1939
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1936

def get_directory_limits(params = {}, options = {})
  req = build_request(:get_directory_limits, params)
  req.send_request(options)
end

#get_snapshot_limits(params = {}) ⇒ Types::GetSnapshotLimitsResult

Obtains the manual snapshot limits for a directory.

Examples:

Request syntax with placeholder values


resp = client.get_snapshot_limits({
  directory_id: "DirectoryId", # required
})

Response structure


resp.snapshot_limits.manual_snapshots_limit #=> Integer
resp.snapshot_limits.manual_snapshots_current_count #=> Integer
resp.snapshot_limits.manual_snapshots_limit_reached #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Contains the identifier of the directory to obtain the limits for.

Returns:

See Also:



1966
1967
1968
1969
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1966

def get_snapshot_limits(params = {}, options = {})
  req = build_request(:get_snapshot_limits, params)
  req.send_request(options)
end

#list_certificates(params = {}) ⇒ Types::ListCertificatesResult

For the specified directory, lists all the certificates registered for a secured LDAP connection.

Examples:

Request syntax with placeholder values


resp = client.list_certificates({
  directory_id: "DirectoryId", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.next_token #=> String
resp.certificates_info #=> Array
resp.certificates_info[0].certificate_id #=> String
resp.certificates_info[0].common_name #=> String
resp.certificates_info[0].state #=> String, one of "Registering", "Registered", "RegisterFailed", "Deregistering", "Deregistered", "DeregisterFailed"
resp.certificates_info[0].expiry_date_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :next_token (String) —

    A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

  • :limit (Integer) —

    The number of items that should show up on one page

Returns:

See Also:



2012
2013
2014
2015
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2012

def list_certificates(params = {}, options = {})
  req = build_request(:list_certificates, params)
  req.send_request(options)
end

#list_ip_routes(params = {}) ⇒ Types::ListIpRoutesResult

Lists the address blocks that you have added to a directory.

Examples:

Request syntax with placeholder values


resp = client.list_ip_routes({
  directory_id: "DirectoryId", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.ip_routes_info #=> Array
resp.ip_routes_info[0].directory_id #=> String
resp.ip_routes_info[0].cidr_ip #=> String
resp.ip_routes_info[0].ip_route_status_msg #=> String, one of "Adding", "Added", "Removing", "Removed", "AddFailed", "RemoveFailed"
resp.ip_routes_info[0].added_date_time #=> Time
resp.ip_routes_info[0].ip_route_status_reason #=> String
resp.ip_routes_info[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier (ID) of the directory for which you want to retrieve the IP addresses.

  • :next_token (String) —

    The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

  • :limit (Integer) —

    Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

Returns:

See Also:



2059
2060
2061
2062
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2059

def list_ip_routes(params = {}, options = {})
  req = build_request(:list_ip_routes, params)
  req.send_request(options)
end

#list_log_subscriptions(params = {}) ⇒ Types::ListLogSubscriptionsResult

Lists the active log subscriptions for the AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_log_subscriptions({
  directory_id: "DirectoryId",
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.log_subscriptions #=> Array
resp.log_subscriptions[0].directory_id #=> String
resp.log_subscriptions[0].log_group_name #=> String
resp.log_subscriptions[0].subscription_created_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (String) —

    If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.

  • :next_token (String) —

    The token for the next set of items to return.

  • :limit (Integer) —

    The maximum number of items returned.

Returns:

See Also:



2104
2105
2106
2107
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2104

def list_log_subscriptions(params = {}, options = {})
  req = build_request(:list_log_subscriptions, params)
  req.send_request(options)
end

#list_schema_extensions(params = {}) ⇒ Types::ListSchemaExtensionsResult

Lists all schema extensions applied to a Microsoft AD Directory.

Examples:

Request syntax with placeholder values


resp = client.list_schema_extensions({
  directory_id: "DirectoryId", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.schema_extensions_info #=> Array
resp.schema_extensions_info[0].directory_id #=> String
resp.schema_extensions_info[0].schema_extension_id #=> String
resp.schema_extensions_info[0].description #=> String
resp.schema_extensions_info[0].schema_extension_status #=> String, one of "Initializing", "CreatingSnapshot", "UpdatingSchema", "Replicating", "CancelInProgress", "RollbackInProgress", "Cancelled", "Failed", "Completed"
resp.schema_extensions_info[0].schema_extension_status_reason #=> String
resp.schema_extensions_info[0].start_date_time #=> Time
resp.schema_extensions_info[0].end_date_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory from which to retrieve the schema extension information.

  • :next_token (String) —

    The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

  • :limit (Integer) —

    The maximum number of items to return.

Returns:

See Also:



2151
2152
2153
2154
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2151

def list_schema_extensions(params = {}, options = {})
  req = build_request(:list_schema_extensions, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult

Lists all tags on a directory.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_id: "ResourceId", # required
  next_token: "NextToken",
  limit: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Identifier (ID) of the directory for which you want to retrieve tags.

  • :next_token (String) —

    Reserved for future use.

  • :limit (Integer) —

    Reserved for future use.

Returns:

See Also:



2191
2192
2193
2194
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2191

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#register_certificate(params = {}) ⇒ Types::RegisterCertificateResult

Registers a certificate for secured LDAP connection.

Examples:

Request syntax with placeholder values


resp = client.register_certificate({
  directory_id: "DirectoryId", # required
  certificate_data: "CertificateData", # required
})

Response structure


resp.certificate_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory.

  • :certificate_data (required, String) —

    The certificate PEM string that needs to be registered.

Returns:

See Also:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2223

def register_certificate(params = {}, options = {})
  req = build_request(:register_certificate, params)
  req.send_request(options)
end

#register_event_topic(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.register_event_topic({
  directory_id: "DirectoryId", # required
  topic_name: "TopicName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The Directory ID that will publish status messages to the SNS topic.

  • :topic_name (required, String) —

    The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2256
2257
2258
2259
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2256

def register_event_topic(params = {}, options = {})
  req = build_request(:register_event_topic, params)
  req.send_request(options)
end

#reject_shared_directory(params = {}) ⇒ Types::RejectSharedDirectoryResult

Rejects a directory sharing request that was sent from the directory owner account.

Examples:

Request syntax with placeholder values


resp = client.reject_shared_directory({
  shared_directory_id: "DirectoryId", # required
})

Response structure


resp.shared_directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :shared_directory_id (required, String) —

    Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

Returns:

See Also:



2286
2287
2288
2289
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2286

def reject_shared_directory(params = {}, options = {})
  req = build_request(:reject_shared_directory, params)
  req.send_request(options)
end

#remove_ip_routes(params = {}) ⇒ Struct

Removes IP address blocks from a directory.

Examples:

Request syntax with placeholder values


resp = client.remove_ip_routes({
  directory_id: "DirectoryId", # required
  cidr_ips: ["CidrIp"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier (ID) of the directory from which you want to remove the IP addresses.

  • :cidr_ips (required, Array<String>) —

    IP address blocks that you want to remove.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2313
2314
2315
2316
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2313

def remove_ip_routes(params = {}, options = {})
  req = build_request(:remove_ip_routes, params)
  req.send_request(options)
end

#remove_tags_from_resource(params = {}) ⇒ Struct

Removes tags from a directory.

Examples:

Request syntax with placeholder values


resp = client.remove_tags_from_resource({
  resource_id: "ResourceId", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    Identifier (ID) of the directory from which to remove the tag.

  • :tag_keys (required, Array<String>) —

    The tag key (name) of the tag to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2339
2340
2341
2342
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2339

def remove_tags_from_resource(params = {}, options = {})
  req = build_request(:remove_tags_from_resource, params)
  req.send_request(options)
end

#reset_user_password(params = {}) ⇒ Struct

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

You can reset the password for any user in your directory with the following exceptions:

  • For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.

  • For AWS Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.

Examples:

Request syntax with placeholder values


resp = client.reset_user_password({
  directory_id: "DirectoryId", # required
  user_name: "CustomerUserName", # required
  new_password: "UserPassword", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.

  • :user_name (required, String) —

    The user name of the user whose password will be reset.

  • :new_password (required, String) —

    The new password that will be reset.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2390
2391
2392
2393
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2390

def reset_user_password(params = {}, options = {})
  req = build_request(:reset_user_password, params)
  req.send_request(options)
end

#restore_from_snapshot(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.restore_from_snapshot({
  snapshot_id: "SnapshotId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_id (required, String) —

    The identifier of the snapshot to restore from.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2421
2422
2423
2424
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2421

def restore_from_snapshot(params = {}, options = {})
  req = build_request(:restore_from_snapshot, params)
  req.send_request(options)
end

#share_directory(params = {}) ⇒ Types::ShareDirectoryResult

Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

Examples:

Request syntax with placeholder values


resp = client.share_directory({
  directory_id: "DirectoryId", # required
  share_notes: "Notes",
  share_target: { # required
    id: "TargetId", # required
    type: "ACCOUNT", # required, accepts ACCOUNT
  },
  share_method: "ORGANIZATIONS", # required, accepts ORGANIZATIONS, HANDSHAKE
})

Response structure


resp.shared_directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

  • :share_notes (String) —

    A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

  • :share_target (required, Types::ShareTarget) —

    Identifier for the directory consumer account with whom the directory is to be shared.

  • :share_method (required, String) —

    The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

Returns:

See Also:



2490
2491
2492
2493
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2490

def share_directory(params = {}, options = {})
  req = build_request(:share_directory, params)
  req.send_request(options)
end

#start_schema_extension(params = {}) ⇒ Types::StartSchemaExtensionResult

Applies a schema extension to a Microsoft AD directory.

Examples:

Request syntax with placeholder values


resp = client.start_schema_extension({
  directory_id: "DirectoryId", # required
  create_snapshot_before_schema_extension: false, # required
  ldif_content: "LdifContent", # required
  description: "Description", # required
})

Response structure


resp.schema_extension_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which the schema extension will be applied to.

  • :create_snapshot_before_schema_extension (required, Boolean) —

    If true, creates a snapshot of the directory before applying the schema extension.

  • :ldif_content (required, String) —

    The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.

  • :description (required, String) —

    A description of the schema extension.

Returns:

See Also:



2535
2536
2537
2538
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2535

def start_schema_extension(params = {}, options = {})
  req = build_request(:start_schema_extension, params)
  req.send_request(options)
end

#unshare_directory(params = {}) ⇒ Types::UnshareDirectoryResult

Stops the directory sharing between the directory owner and consumer accounts.

Examples:

Request syntax with placeholder values


resp = client.unshare_directory({
  directory_id: "DirectoryId", # required
  unshare_target: { # required
    id: "TargetId", # required
    type: "ACCOUNT", # required, accepts ACCOUNT
  },
})

Response structure


resp.shared_directory_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.

  • :unshare_target (required, Types::UnshareTarget) —

    Identifier for the directory consumer account with whom the directory has to be unshared.

Returns:

See Also:



2573
2574
2575
2576
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2573

def unshare_directory(params = {}, options = {})
  req = build_request(:unshare_directory, params)
  req.send_request(options)
end

#update_conditional_forwarder(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_conditional_forwarder({
  directory_id: "DirectoryId", # required
  remote_domain_name: "RemoteDomainName", # required
  dns_ip_addrs: ["IpAddr"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The directory ID of the AWS directory for which to update the conditional forwarder.

  • :remote_domain_name (required, String) —

    The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

  • :dns_ip_addrs (required, Array<String>) —

    The updated IP addresses of the remote DNS server associated with the conditional forwarder.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2607
2608
2609
2610
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2607

def update_conditional_forwarder(params = {}, options = {})
  req = build_request(:update_conditional_forwarder, params)
  req.send_request(options)
end

#update_number_of_domain_controllers(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.update_number_of_domain_controllers({
  directory_id: "DirectoryId", # required
  desired_number: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    Identifier of the directory to which the domain controllers will be added or removed.

  • :desired_number (required, Integer) —

    The number of domain controllers desired in the directory.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2639
2640
2641
2642
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2639

def update_number_of_domain_controllers(params = {}, options = {})
  req = build_request(:update_number_of_domain_controllers, params)
  req.send_request(options)
end

#update_radius(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.update_radius({
  directory_id: "DirectoryId", # required
  radius_settings: { # required
    radius_servers: ["Server"],
    radius_port: 1,
    radius_timeout: 1,
    radius_retries: 1,
    shared_secret: "RadiusSharedSecret",
    authentication_protocol: "PAP", # accepts PAP, CHAP, MS-CHAPv1, MS-CHAPv2
    display_label: "RadiusDisplayLabel",
    use_same_username: false,
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory for which to update the RADIUS server information.

  • :radius_settings (required, Types::RadiusSettings) —

    A RadiusSettings object that contains information about the RADIUS server.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2677
2678
2679
2680
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2677

def update_radius(params = {}, options = {})
  req = build_request(:update_radius, params)
  req.send_request(options)
end

#update_trust(params = {}) ⇒ Types::UpdateTrustResult

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

Examples:

Request syntax with placeholder values


resp = client.update_trust({
  trust_id: "TrustId", # required
  selective_auth: "Enabled", # accepts Enabled, Disabled
})

Response structure


resp.request_id #=> String
resp.trust_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_id (required, String) —

    Identifier of the trust relationship.

  • :selective_auth (String) —

    Updates selective authentication for the trust.

Returns:

See Also:



2712
2713
2714
2715
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2712

def update_trust(params = {}, options = {})
  req = build_request(:update_trust, params)
  req.send_request(options)
end

#verify_trust(params = {}) ⇒ Types::VerifyTrustResult

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

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

Examples:

Request syntax with placeholder values


resp = client.verify_trust({
  trust_id: "TrustId", # required
})

Response structure


resp.trust_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :trust_id (required, String) —

    The unique Trust ID of the trust relationship to verify.

Returns:

See Also:



2744
2745
2746
2747
 
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2744

def verify_trust(params = {}, options = {})
  req = build_request(:verify_trust, params)
  req.send_request(options)
end