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

#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(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



163
164
165
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 163

def initialize(*args)
  super
end

Instance Method Details

#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:



267
268
269
270
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 267

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:



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

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:



331
332
333
334
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 331

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
  },
})

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 textual 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.

Returns:

See Also:



396
397
398
399
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 396

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:



439
440
441
442
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 439

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:



498
499
500
501
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 498

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:



534
535
536
537
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 534

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.

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
  },
})

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 short 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 username Administrator and this password.

  • :description (String)

    A textual 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.

Returns:

See Also:



599
600
601
602
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 599

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

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

Creates a Microsoft AD in the AWS cloud.

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
})

Response structure


resp.directory_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The fully qualified domain name for the 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. A short identifier 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.

  • :description (String)

    A textual 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 Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

Returns:

See Also:



668
669
670
671
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 668

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:



705
706
707
708
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 705

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 Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

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
  conditional_forwarder_ip_addrs: ["IpAddr"],
})

Response structure


resp.trust_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (required, String)

    The Directory ID of the Microsoft AD in the AWS cloud 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.

  • :conditional_forwarder_ip_addrs (Array<String>)

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

Returns:

See Also:



766
767
768
769
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 766

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:



794
795
796
797
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 794

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:



832
833
834
835
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 832

def delete_directory(params = {}, options = {})
  req = build_request(:delete_directory, 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:



860
861
862
863
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 860

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 Microsoft AD in the AWS cloud 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:



893
894
895
896
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 893

def delete_trust(params = {}, options = {})
  req = build_request(:delete_trust, 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:



922
923
924
925
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 922

def deregister_event_topic(params = {}, options = {})
  req = build_request(:deregister_event_topic, 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:



965
966
967
968
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 965

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].launch_time #=> Time
resp.directory_descriptions[0].stage_last_updated_date_time #=> Time
resp.directory_descriptions[0].type #=> String, one of "SimpleAD", "ADConnector", "MicrosoftAD"
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.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:



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

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:



1120
1121
1122
1123
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1120

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:



1167
1168
1169
1170
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1167

def describe_event_topics(params = {}, options = {})
  req = build_request(:describe_event_topics, 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:



1228
1229
1230
1231
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1228

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"
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", "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.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:



1290
1291
1292
1293
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1290

def describe_trusts(params = {}, options = {})
  req = build_request(:describe_trusts, 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 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:



1314
1315
1316
1317
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1314

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:



1354
1355
1356
1357
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1354

def disable_sso(params = {}, options = {})
  req = build_request(:disable_sso, 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 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:



1392
1393
1394
1395
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1392

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.

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:



1432
1433
1434
1435
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1432

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:



1459
1460
1461
1462
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1459

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:



1489
1490
1491
1492
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1489

def get_snapshot_limits(params = {}, options = {})
  req = build_request(:get_snapshot_limits, 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:



1536
1537
1538
1539
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1536

def list_ip_routes(params = {}, options = {})
  req = build_request(:list_ip_routes, 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:



1583
1584
1585
1586
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1583

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:



1623
1624
1625
1626
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1623

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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:



1656
1657
1658
1659
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1656

def register_event_topic(params = {}, options = {})
  req = build_request(:register_event_topic, 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:



1683
1684
1685
1686
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1683

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:



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

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.

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 username 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:



1741
1742
1743
1744
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1741

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:



1772
1773
1774
1775
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1772

def restore_from_snapshot(params = {}, options = {})
  req = build_request(:restore_from_snapshot, 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:



1817
1818
1819
1820
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1817

def start_schema_extension(params = {}, options = {})
  req = build_request(:start_schema_extension, 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:



1851
1852
1853
1854
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1851

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:



1883
1884
1885
1886
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1883

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 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:



1921
1922
1923
1924
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1921

def update_radius(params = {}, options = {})
  req = build_request(:update_radius, 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 Microsoft AD in the AWS cloud 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:



1953
1954
1955
1956
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1953

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