Class: Aws::DirectoryService::Client

Examples:

Example: To add a CIDR address block that routes traffic for Microsoft AD

 # The following example adds a CIDR address block to correctly route traffic to and from your Microsoft AD on AWS.  resp = client.add_ip_routes({ directory_id: "d-92654abfed", ip_routes: [ { cidr_ip: "12.12.12.12/32", description: "my IpRoute", }, ], }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

 resp = client.add_region({ directory_id: "DirectoryId", # required  region_name: "RegionName", # required  vpc_settings: { # required  vpc_id: "VpcId", # required  subnet_ids: ["SubnetId"], # required  }, })

Examples:

Example: To add tags to a directory

 # The following example adds or overwrites one or more tags for the specified directory.  resp = client.add_tags_to_resource({ resource_id: "d-92654abfed", tags: [ { key: "environment", value: "production", }, ], }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Example: To cancel a Microsoft AD schema extension that is in progress

 # The following example cancels an in-progress schema extension to a Microsoft AD directory.  resp = client.cancel_schema_extension({ directory_id: "d-92654abfed", schema_extension_id: "e-926731d2a0", }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Example: To connect to an on-premises directory

 # The following example creates an AD Connector to connect to an on-premises directory.  resp = client.connect_directory({ connect_settings: { customer_dns_ips: [ "172.30.21.228", ], customer_user_name: "Administrator", subnet_ids: [ "subnet-ba0146de", "subnet-bef46bc8", ], vpc_id: "vpc-45025421", }, description: "Connector to corp", name: "corp.example.com", password: "Str0ngP@ssw0rd", short_name: "corp", size: "Small", }) resp.to_h outputs the following: { directory_id: "d-92654abfed", }

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"], customer_dns_ips_v6: ["Ipv6Addr"], customer_user_name: "UserName", # required  }, tags: [ { key: "TagKey", # required  value: "TagValue", # required  }, ], network_type: "Dual-stack", # accepts Dual-stack, IPv4, IPv6 })

Response structure

 resp.directory_id #=> String

Examples:

Example: To create an alias for a directory

 # The following example creates an alias for a directory.  resp = client.create_alias({ alias: "salesorg", directory_id: "d-92654abfed", }) resp.to_h outputs the following: { alias: "salesorg", directory_id: "d-92654abfed", }

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

Examples:

Example: To create a computer account

 # The following example creates a computer account in the specified directory, and joins the computer to the directory.  resp = client.create_computer({ computer_attributes: [ { name: "ip", value: "192.168.101.100", }, ], computer_name: "labcomputer", directory_id: "d-92654abfed", organizational_unit_distinguished_name: "OU=Computers,OU=example,DC=corp,DC=example,DC=com", password: "Str0ngP@ssw0rd", }) resp.to_h outputs the following: { computer: { computer_attributes: [ { name: "DistinguishedName", value: "CN=labcomputer,OU=Computers,OU=nickcorp,DC=seattle,DC=nickcorp,DC=com", }, { name: "WindowsSamName", value: "labcomputer$", }, ], computer_id: "S-1-5-21-1932691875-1648176379-1176097576-1124", computer_name: "labcomputer", }, }

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>

Examples:

Example: To create a conditional forwarder

 # The following example creates a conditional forwarder associated with your AWS directory.  resp = client.create_conditional_forwarder({ directory_id: "d-92654abfed", dns_ip_addrs: [ "172.30.21.228", ], remote_domain_name: "sales.example.com", }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Example: To create a Simple AD directory

 # The following example creates a Simple AD directory.  resp = client.create_directory({ description: "Regional directory for example.com", name: "seattle.example.com", password: "Str0ngP@ssw0rd", short_name: "seattle", size: "Small", vpc_settings: { subnet_ids: [ "subnet-ba0146de", "subnet-bef46bc8", ], vpc_id: "vpc-45025421", }, }) resp.to_h outputs the following: { directory_id: "d-92654abfed", }

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  }, ], network_type: "Dual-stack", # accepts Dual-stack, IPv4, IPv6 })

Response structure

 resp.directory_id #=> String

Examples:

Request syntax with placeholder values

 resp = client.create_hybrid_ad({ secret_arn: "SecretArn", # required  assessment_id: "AssessmentId", # required  tags: [ { key: "TagKey", # required  value: "TagValue", # required  }, ], })

Response structure

 resp.directory_id #=> String

Examples:

Request syntax with placeholder values

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

Examples:

Example: To create a Microsoft AD directory

 # The following example creates a Microsoft AD directory in the AWS cloud.  resp = client.create_microsoft_ad({ description: "Corporate AD directory", name: "ad.example.com", password: "Str0ngP@ssw0rd", short_name: "ad", vpc_settings: { subnet_ids: [ "subnet-ba0146de", "subnet-bef46bc8", ], vpc_id: "vpc-45025421", }, }) resp.to_h outputs the following: { directory_id: "d-92654abfed", }

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, Hybrid  tags: [ { key: "TagKey", # required  value: "TagValue", # required  }, ], network_type: "Dual-stack", # accepts Dual-stack, IPv4, IPv6 })

Response structure

 resp.directory_id #=> String

Examples:

Example: To create a snapshot of a directory

 # The following example creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.  resp = client.create_snapshot({ directory_id: "d-92654abfed", name: "ad.example.com", }) resp.to_h outputs the following: { snapshot_id: "s-9267f8d3f0", }

Request syntax with placeholder values

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

Response structure

 resp.snapshot_id #=> String

Examples:

Example: To create a trust

 # The following example creates a trust between Microsoft AD in the AWS cloud and an external domain.  resp = client.create_trust({ conditional_forwarder_ip_addrs: [ "172.30.21.228", ], directory_id: "d-92654abfed", remote_domain_name: "europe.example.com", trust_direction: "One-Way: Outgoing", trust_password: "Str0ngP@ssw0rd", trust_type: "Forest", }) resp.to_h outputs the following: { trust_id: "t-9267353743", }

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"], conditional_forwarder_ipv_6_addrs: ["Ipv6Addr"], selective_auth: "Enabled", # accepts Enabled, Disabled })

Response structure

 resp.trust_id #=> String

Examples:

Request syntax with placeholder values

 resp = client.delete_ad_assessment({ assessment_id: "AssessmentId", # required })

Response structure

 resp.assessment_id #=> String

Examples:

Example: To delete a conditional forwarder

 # The following example deletes a conditional forwarder.  resp = client.delete_conditional_forwarder({ directory_id: "d-92654abfed", remote_domain_name: "sales.example.com", }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Example: To delete a directory

 # The following example deletes a directory from your AWS account.  resp = client.delete_directory({ directory_id: "d-92654abfed", }) resp.to_h outputs the following: { directory_id: "d-92654abfed", }

Request syntax with placeholder values

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

Response structure

 resp.directory_id #=> String

Examples:

Request syntax with placeholder values

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

Examples:

Example: To delete a snapshot

 # The following example deletes a directory snapshot.  resp = client.delete_snapshot({ snapshot_id: "s-9267f8d3f0", }) resp.to_h outputs the following: { snapshot_id: "s-9267f8d3f0", }

Request syntax with placeholder values

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

Response structure

 resp.snapshot_id #=> String

Examples:

Example: To delete a trust

 # The following example deletes an existing trust between your Microsoft AD in the AWS cloud and an external domain.  resp = client.delete_trust({ delete_associated_conditional_forwarder: true, trust_id: "t-9267353743", }) resp.to_h outputs the following: { trust_id: "t-9267353743", }

Request syntax with placeholder values

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

Response structure

 resp.trust_id #=> String

Examples:

Request syntax with placeholder values

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

Examples:

Example: To remove an event topic

 # The following example removes the specified directory as a publisher to the specified SNS topic.  resp = client.deregister_event_topic({ directory_id: "d-92654abfed", topic_name: "snstopicexample", }) resp.to_h outputs the following: { }

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

 resp = client.describe_ad_assessment({ assessment_id: "AssessmentId", # required })

Response structure

 resp.assessment.assessment_id #=> String resp.assessment.directory_id #=> String resp.assessment.dns_name #=> String resp.assessment.start_time #=> Time resp.assessment.last_update_date_time #=> Time resp.assessment.status #=> String resp.assessment.status_code #=> String resp.assessment.status_reason #=> String resp.assessment.customer_dns_ips #=> Array resp.assessment.customer_dns_ips[0] #=> String resp.assessment.vpc_id #=> String resp.assessment.subnet_ids #=> Array resp.assessment.subnet_ids[0] #=> String resp.assessment.security_group_ids #=> Array resp.assessment.security_group_ids[0] #=> String resp.assessment.self_managed_instance_ids #=> Array resp.assessment.self_managed_instance_ids[0] #=> String resp.assessment.report_type #=> String resp.assessment.version #=> String resp.assessment_reports #=> Array resp.assessment_reports[0].domain_controller_ip #=> String resp.assessment_reports[0].validations #=> Array resp.assessment_reports[0].validations[0].category #=> String resp.assessment_reports[0].validations[0].name #=> String resp.assessment_reports[0].validations[0].status #=> String resp.assessment_reports[0].validations[0].status_code #=> String resp.assessment_reports[0].validations[0].status_reason #=> String resp.assessment_reports[0].validations[0].start_time #=> Time resp.assessment_reports[0].validations[0].last_update_date_time #=> Time

Examples:

Request syntax with placeholder values

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

Response structure

 resp.directory_id #=> String resp.pca_connector_arn #=> String resp.ca_enrollment_policy_status #=> String, one of "InProgress", "Success", "Failed", "Disabling", "Disabled", "Impaired" resp.last_updated_date_time #=> Time resp.ca_enrollment_policy_status_reason #=> String

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 resp.certificate.type #=> String, one of "ClientCertAuth", "ClientLDAPS" resp.certificate.client_cert_auth_settings.ocsp_url #=> String

Examples:

Request syntax with placeholder values

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

Response structure

 resp.client_authentication_settings_info #=> Array resp.client_authentication_settings_info[0].type #=> String, one of "SmartCard", "SmartCardOrPassword" resp.client_authentication_settings_info[0].status #=> String, one of "Enabled", "Disabled" resp.client_authentication_settings_info[0].last_updated_date_time #=> Time resp.next_token #=> String

Examples:

Example: To describe conditional forwarders

 # The following example obtains information about the conditional forwarders for a specified directory.  resp = client.describe_conditional_forwarders({ directory_id: "d-92654abfed", remote_domain_names: [ "sales.example.com", ], }) resp.to_h outputs the following: { conditional_forwarders: [ ], }

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].dns_ipv_6_addrs #=> Array resp.conditional_forwarders[0].dns_ipv_6_addrs[0] #=> String resp.conditional_forwarders[0].replication_scope #=> String, one of "Domain"

Examples:

Example: To describe one or more directories

 # The following example obtains information about a specified directory.  resp = client.describe_directories({ directory_ids: [ "d-92654abfed", ], limit: 0, }) resp.to_h outputs the following: { directory_descriptions: [ { access_url: "myaccess.awsapps.com", alias: "myaccess", directory_id: "d-92654abfed", dns_ip_addrs: [ "172.30.21.228", "172.30.9.82", ], launch_time: Time.parse(1469737584.772), name: "corp.example.com", short_name: "example", sso_enabled: true, stage: "Active", stage_last_updated_date_time: Time.parse(1469739131.71), type: "MicrosoftAD", vpc_settings: { availability_zones: [ "us-west-2a", "us-west-2b", ], subnet_ids: [ "subnet-ba0146de", "subnet-bef46bc8", ], vpc_id: "vpc-45025421", }, }, ], }

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", "Hybrid" 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].dns_ipv_6_addrs #=> Array resp.directory_descriptions[0].dns_ipv_6_addrs[0] #=> String resp.directory_descriptions[0].stage #=> String, one of "Requested", "Creating", "Created", "Active", "Inoperable", "Impaired", "Restoring", "RestoreFailed", "Deleting", "Deleted", "Failed", "Updating" 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].connect_settings.connect_ips_v6 #=> Array resp.directory_descriptions[0].connect_settings.connect_ips_v6[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_servers_ipv_6 #=> Array resp.directory_descriptions[0].radius_settings.radius_servers_ipv_6[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.account_id #=> 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.dns_ipv_6_addrs #=> Array resp.directory_descriptions[0].owner_directory_description.dns_ipv_6_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_servers_ipv_6 #=> Array resp.directory_descriptions[0].owner_directory_description.radius_settings.radius_servers_ipv_6[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.directory_descriptions[0].owner_directory_description.network_type #=> String, one of "Dual-stack", "IPv4", "IPv6" resp.directory_descriptions[0].regions_info.primary_region #=> String resp.directory_descriptions[0].regions_info.additional_regions #=> Array resp.directory_descriptions[0].regions_info.additional_regions[0] #=> String resp.directory_descriptions[0].os_version #=> String, one of "SERVER_2012", "SERVER_2019" resp.directory_descriptions[0].hybrid_settings.self_managed_dns_ip_addrs #=> Array resp.directory_descriptions[0].hybrid_settings.self_managed_dns_ip_addrs[0] #=> String resp.directory_descriptions[0].hybrid_settings.self_managed_instance_ids #=> Array resp.directory_descriptions[0].hybrid_settings.self_managed_instance_ids[0] #=> String resp.directory_descriptions[0].network_type #=> String, one of "Dual-stack", "IPv4", "IPv6" resp.next_token #=> String