Struct Client

pub struct Client { /* private fields */ }

Client for AWS Directory Service

Client for invoking operations on AWS Directory Service. Each operation on AWS Directory Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_directory::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_directory::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptSharedDirectory operation has a Client::accept_shared_directory, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_shared_directory()
    .shared_directory_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_shared_directory(&self) -> AcceptSharedDirectoryFluentBuilder

Constructs a fluent builder for the AcceptSharedDirectory operation.

• The fluent builder is configurable:
  • shared_directory_id(impl Into<String>) / set_shared_directory_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with AcceptSharedDirectoryOutput with field(s):
  • shared_directory(Option<SharedDirectory>):

    The shared directory in the directory consumer account.

• On failure, responds with SdkError<AcceptSharedDirectoryError>

impl Client

pub fn add_ip_routes(&self) -> AddIpRoutesFluentBuilder

Constructs a fluent builder for the AddIpRoutes operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • ip_routes(IpRoute) / set_ip_routes(Option<Vec::<IpRoute>>):
    required: true
    

    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 self-managed domain.

    
    
  • update_security_group_for_directory_controllers(bool) / set_update_security_group_for_directory_controllers(Option<bool>):
    required: false
    

    If set to true, updates the inbound and outbound rules of the security group that has the description: “Amazon Web Services created security group for directory ID directory controllers.” Following are the new rules:

    Inbound:

    • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: LDAP, Protocol: TCP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR

    • Type: All ICMP, Protocol: All, Range: N/A, Source: Managed Microsoft AD VPC IPv4 CIDR

    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.

    
    
• On success, responds with AddIpRoutesOutput
• On failure, responds with SdkError<AddIpRoutesError>

impl Client

pub fn add_region(&self) -> AddRegionFluentBuilder

Constructs a fluent builder for the AddRegion operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory to which you want to add Region replication.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: true
    

    The name of the Region where you want to add domain controllers for replication. For example, us-east-1.

    
    
  • vpc_settings(DirectoryVpcSettings) / set_vpc_settings(Option<DirectoryVpcSettings>):
    required: true
    

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    
    
• On success, responds with AddRegionOutput
• On failure, responds with SdkError<AddRegionError>

impl Client

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to be assigned to the directory.

    
    
• On success, responds with AddTagsToResourceOutput
• On failure, responds with SdkError<AddTagsToResourceError>

impl Client

pub fn cancel_schema_extension(&self) -> CancelSchemaExtensionFluentBuilder

Constructs a fluent builder for the CancelSchemaExtension operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • schema_extension_id(impl Into<String>) / set_schema_extension_id(Option<String>):
    required: true
    

    The identifier of the schema extension that will be canceled.

    
    
• On success, responds with CancelSchemaExtensionOutput
• On failure, responds with SdkError<CancelSchemaExtensionError>

impl Client

pub fn connect_directory(&self) -> ConnectDirectoryFluentBuilder

Constructs a fluent builder for the ConnectDirectory operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The fully qualified name of your self-managed directory, such as corp.example.com.

    
    
  • short_name(impl Into<String>) / set_short_name(Option<String>):
    required: false
    

    The NetBIOS name of your self-managed directory, such as CORP.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    The password for your self-managed user account.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the directory.

    
    
  • size(DirectorySize) / set_size(Option<DirectorySize>):
    required: true
    

    The size of the directory.

    
    
  • connect_settings(DirectoryConnectSettings) / set_connect_settings(Option<DirectoryConnectSettings>):
    required: true
    

    A DirectoryConnectSettings object that contains additional information for the operation.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to be assigned to AD Connector.

    
    
• On success, responds with ConnectDirectoryOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the new directory.

• On failure, responds with SdkError<ConnectDirectoryError>

impl Client

pub fn create_alias(&self) -> CreateAliasFluentBuilder

Constructs a fluent builder for the CreateAlias operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • alias(impl Into<String>) / set_alias(Option<String>):
    required: true
    

    The requested alias.

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

    
    
• On success, responds with CreateAliasOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the directory.

  • alias(Option<String>):

    The alias for the directory.

• On failure, responds with SdkError<CreateAliasError>

impl Client

pub fn create_computer(&self) -> CreateComputerFluentBuilder

Constructs a fluent builder for the CreateComputer operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • computer_name(impl Into<String>) / set_computer_name(Option<String>):
    required: true
    

    The name of the computer account.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    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(impl Into<String>) / set_organizational_unit_distinguished_name(Option<String>):
    required: false
    

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

    
    
  • computer_attributes(Attribute) / set_computer_attributes(Option<Vec::<Attribute>>):
    required: false
    

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

    
    
• On success, responds with CreateComputerOutput with field(s):
  • computer(Option<Computer>):

    A Computer object that represents the computer account.

• On failure, responds with SdkError<CreateComputerError>

impl Client

pub fn create_conditional_forwarder( &self, ) -> CreateConditionalForwarderFluentBuilder

Constructs a fluent builder for the CreateConditionalForwarder operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The directory ID of the Amazon Web Services directory for which you are creating the conditional forwarder.

    
    
  • remote_domain_name(impl Into<String>) / set_remote_domain_name(Option<String>):
    required: true
    

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

    
    
  • dns_ip_addrs(impl Into<String>) / set_dns_ip_addrs(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with CreateConditionalForwarderOutput
• On failure, responds with SdkError<CreateConditionalForwarderError>

impl Client

pub fn create_directory(&self) -> CreateDirectoryFluentBuilder

Constructs a fluent builder for the CreateDirectory operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

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

    
    
  • short_name(impl Into<String>) / set_short_name(Option<String>):
    required: false
    

    The NetBIOS name of the directory, such as CORP.

    
    
  • password(impl Into<String>) / set_password(Option<String>):
    required: true
    

    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.

    The regex pattern for this string is made up of the following conditions:

    • Length (?=^.{8,64}$) – Must be between 8 and 64 characters

    AND any 3 of the following password complexity rules required by Active Directory:

    • Numbers and upper case and lowercase (?=.\d)(?=.[A-Z])(?=.[a-z])

    • Numbers and special characters and lower case (?=.\d)(?=.[^A-Za-z0-9\s])(?=.[a-z])

    • Special characters and upper case and lower case (?=.[^A-Za-z0-9\s])(?=.[A-Z])(?=.[a-z])

    • Numbers and upper case and special characters (?=.\d)(?=.[A-Z])(?=.[^A-Za-z0-9\s])

    For additional information about how Active Directory passwords are enforced, see Password must meet complexity requirements on the Microsoft website.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the directory.

    
    
  • size(DirectorySize) / set_size(Option<DirectorySize>):
    required: true
    

    The size of the directory.

    
    
  • vpc_settings(DirectoryVpcSettings) / set_vpc_settings(Option<DirectoryVpcSettings>):
    required: false
    

    A DirectoryVpcSettings object that contains additional information for the operation.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to be assigned to the Simple AD directory.

    
    
• On success, responds with CreateDirectoryOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the directory that was created.

• On failure, responds with SdkError<CreateDirectoryError>

impl Client

pub fn create_log_subscription(&self) -> CreateLogSubscriptionFluentBuilder

Constructs a fluent builder for the CreateLogSubscription operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • log_group_name(impl Into<String>) / set_log_group_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with CreateLogSubscriptionOutput
• On failure, responds with SdkError<CreateLogSubscriptionError>

impl Client

pub fn create_microsoft_ad(&self) -> CreateMicrosoftADFluentBuilder

Constructs a fluent builder for the CreateMicrosoftAD operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The fully qualified domain name for the 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(impl Into<String>) / set_short_name(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: true
    

    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(impl Into<String>) / set_description(Option<String>):
    required: false
    

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

    
    
  • vpc_settings(DirectoryVpcSettings) / set_vpc_settings(Option<DirectoryVpcSettings>):
    required: true
    

    Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

    
    
  • edition(DirectoryEdition) / set_edition(Option<DirectoryEdition>):
    required: false
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

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

    
    
• On success, responds with CreateMicrosoftAdOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the directory that was created.

• On failure, responds with SdkError<CreateMicrosoftADError>

impl Client

pub fn create_snapshot(&self) -> CreateSnapshotFluentBuilder

Constructs a fluent builder for the CreateSnapshot operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The descriptive name to apply to the snapshot.

    
    
• On success, responds with CreateSnapshotOutput with field(s):
  • snapshot_id(Option<String>):

    The identifier of the snapshot that was created.

• On failure, responds with SdkError<CreateSnapshotError>

impl Client

pub fn create_trust(&self) -> CreateTrustFluentBuilder

Constructs a fluent builder for the CreateTrust operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • remote_domain_name(impl Into<String>) / set_remote_domain_name(Option<String>):
    required: true
    

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

    
    
  • trust_password(impl Into<String>) / set_trust_password(Option<String>):
    required: true
    

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

    
    
  • trust_direction(TrustDirection) / set_trust_direction(Option<TrustDirection>):
    required: true
    

    The direction of the trust relationship.

    
    
  • trust_type(TrustType) / set_trust_type(Option<TrustType>):
    required: false
    

    The trust relationship type. Forest is the default.

    
    
  • conditional_forwarder_ip_addrs(impl Into<String>) / set_conditional_forwarder_ip_addrs(Option<Vec::<String>>):
    required: false
    

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

    
    
  • selective_auth(SelectiveAuth) / set_selective_auth(Option<SelectiveAuth>):
    required: false
    

    Optional parameter to enable selective authentication for the trust.

    
    
• On success, responds with CreateTrustOutput with field(s):
  • trust_id(Option<String>):

    A unique identifier for the trust relationship that was created.

• On failure, responds with SdkError<CreateTrustError>

impl Client

pub fn delete_conditional_forwarder( &self, ) -> DeleteConditionalForwarderFluentBuilder

Constructs a fluent builder for the DeleteConditionalForwarder operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • remote_domain_name(impl Into<String>) / set_remote_domain_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteConditionalForwarderOutput
• On failure, responds with SdkError<DeleteConditionalForwarderError>

impl Client

pub fn delete_directory(&self) -> DeleteDirectoryFluentBuilder

Constructs a fluent builder for the DeleteDirectory operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory to delete.

    
    
• On success, responds with DeleteDirectoryOutput with field(s):
  • directory_id(Option<String>):

    The directory identifier.

• On failure, responds with SdkError<DeleteDirectoryError>

impl Client

pub fn delete_log_subscription(&self) -> DeleteLogSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteLogSubscription operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteLogSubscriptionOutput
• On failure, responds with SdkError<DeleteLogSubscriptionError>

impl Client

pub fn delete_snapshot(&self) -> DeleteSnapshotFluentBuilder

Constructs a fluent builder for the DeleteSnapshot operation.

• The fluent builder is configurable:
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: true
    

    The identifier of the directory snapshot to be deleted.

    
    
• On success, responds with DeleteSnapshotOutput with field(s):
  • snapshot_id(Option<String>):

    The identifier of the directory snapshot that was deleted.

• On failure, responds with SdkError<DeleteSnapshotError>

impl Client

pub fn delete_trust(&self) -> DeleteTrustFluentBuilder

Constructs a fluent builder for the DeleteTrust operation.

• The fluent builder is configurable:
  • trust_id(impl Into<String>) / set_trust_id(Option<String>):
    required: true
    

    The Trust ID of the trust relationship to be deleted.

    
    
  • delete_associated_conditional_forwarder(bool) / set_delete_associated_conditional_forwarder(Option<bool>):
    required: false
    

    Delete a conditional forwarder as part of a DeleteTrustRequest.

    
    
• On success, responds with DeleteTrustOutput with field(s):
  • trust_id(Option<String>):

    The Trust ID of the trust relationship that was deleted.

• On failure, responds with SdkError<DeleteTrustError>

impl Client

pub fn deregister_certificate(&self) -> DeregisterCertificateFluentBuilder

Constructs a fluent builder for the DeregisterCertificate operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The identifier of the certificate.

    
    
• On success, responds with DeregisterCertificateOutput
• On failure, responds with SdkError<DeregisterCertificateError>

impl Client

pub fn deregister_event_topic(&self) -> DeregisterEventTopicFluentBuilder

Constructs a fluent builder for the DeregisterEventTopic operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • topic_name(impl Into<String>) / set_topic_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeregisterEventTopicOutput
• On failure, responds with SdkError<DeregisterEventTopicError>

impl Client

pub fn describe_certificate(&self) -> DescribeCertificateFluentBuilder

Constructs a fluent builder for the DescribeCertificate operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • certificate_id(impl Into<String>) / set_certificate_id(Option<String>):
    required: true
    

    The identifier of the certificate.

    
    
• On success, responds with DescribeCertificateOutput with field(s):
  • certificate(Option<Certificate>):

    Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.

• On failure, responds with SdkError<DescribeCertificateError>

impl Client

pub fn describe_client_authentication_settings( &self, ) -> DescribeClientAuthenticationSettingsFluentBuilder

Constructs a fluent builder for the DescribeClientAuthenticationSettings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which to retrieve information.

    
    
  • r#type(ClientAuthenticationType) / set_type(Option<ClientAuthenticationType>):
    required: false
    

    The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with DescribeClientAuthenticationSettingsOutput with field(s):
  • client_authentication_settings_info(Option<Vec::<ClientAuthenticationSettingInfo>>):

    Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.

  • next_token(Option<String>):

    The next token used to retrieve the client authentication settings if the number of setting types exceeds page limit and there is another page.

• On failure, responds with SdkError<DescribeClientAuthenticationSettingsError>

impl Client

pub fn describe_conditional_forwarders( &self, ) -> DescribeConditionalForwardersFluentBuilder

Constructs a fluent builder for the DescribeConditionalForwarders operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • remote_domain_names(impl Into<String>) / set_remote_domain_names(Option<Vec::<String>>):
    required: false
    

    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.

    
    
• On success, responds with DescribeConditionalForwardersOutput with field(s):
  • conditional_forwarders(Option<Vec::<ConditionalForwarder>>):

    The list of conditional forwarders that have been created.

• On failure, responds with SdkError<DescribeConditionalForwardersError>

impl Client

pub fn describe_directories(&self) -> DescribeDirectoriesFluentBuilder

Constructs a fluent builder for the DescribeDirectories operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_ids(impl Into<String>) / set_directory_ids(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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.

    
    
• On success, responds with DescribeDirectoriesOutput with field(s):
  • directory_descriptions(Option<Vec::<DirectoryDescription>>):

    The list of available DirectoryDescription objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.

• On failure, responds with SdkError<DescribeDirectoriesError>

impl Client

pub fn describe_directory_data_access( &self, ) -> DescribeDirectoryDataAccessFluentBuilder

Constructs a fluent builder for the DescribeDirectoryDataAccess operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The directory identifier.

    
    
• On success, responds with DescribeDirectoryDataAccessOutput with field(s):
  • data_access_status(Option<DataAccessStatus>):

    The current status of data access through the Directory Service Data API.

• On failure, responds with SdkError<DescribeDirectoryDataAccessError>

impl Client

pub fn describe_domain_controllers( &self, ) -> DescribeDomainControllersFluentBuilder

Constructs a fluent builder for the DescribeDomainControllers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • domain_controller_ids(impl Into<String>) / set_domain_controller_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
• On success, responds with DescribeDomainControllersOutput with field(s):
  • domain_controllers(Option<Vec::<DomainController>>):

    List of the DomainController objects that were retrieved.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

• On failure, responds with SdkError<DescribeDomainControllersError>

impl Client

pub fn describe_event_topics(&self) -> DescribeEventTopicsFluentBuilder

Constructs a fluent builder for the DescribeEventTopics operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

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

    
    
  • topic_names(impl Into<String>) / set_topic_names(Option<Vec::<String>>):
    required: false
    

    A list of Amazon 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.

    
    
• On success, responds with DescribeEventTopicsOutput with field(s):
  • event_topics(Option<Vec::<EventTopic>>):

    A list of Amazon SNS topic names that receive status messages from the specified Directory ID.

• On failure, responds with SdkError<DescribeEventTopicsError>

impl Client

pub fn describe_ldaps_settings(&self) -> DescribeLDAPSSettingsFluentBuilder

Constructs a fluent builder for the DescribeLDAPSSettings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • r#type(LdapsType) / set_type(Option<LdapsType>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The type of next token used for pagination.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

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

    
    
• On success, responds with DescribeLdapsSettingsOutput with field(s):
  • ldaps_settings_info(Option<Vec::<LdapsSettingInfo>>):

    Information about LDAP security for the specified directory, including status of enablement, state last updated date time, and the reason for the state.

  • next_token(Option<String>):

    The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is another page.

• On failure, responds with SdkError<DescribeLDAPSSettingsError>

impl Client

pub fn describe_regions(&self) -> DescribeRegionsFluentBuilder

Constructs a fluent builder for the DescribeRegions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: false
    

    The name of the Region. For example, us-east-1.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeRegionsOutput with field(s):
  • regions_description(Option<Vec::<RegionDescription>>):

    List of Region information related to the directory for each replicated Region.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items.

• On failure, responds with SdkError<DescribeRegionsError>

impl Client

pub fn describe_settings(&self) -> DescribeSettingsFluentBuilder

Constructs a fluent builder for the DescribeSettings operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which to retrieve information.

    
    
  • status(DirectoryConfigurationStatus) / set_status(Option<DirectoryConfigurationStatus>):
    required: false
    

    The status of the directory settings for which to retrieve information.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeSettingsOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the directory.

  • setting_entries(Option<Vec::<SettingEntry>>):

    The list of SettingEntry objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

  • next_token(Option<String>):

    If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.

• On failure, responds with SdkError<DescribeSettingsError>

impl Client

pub fn describe_shared_directories( &self, ) -> DescribeSharedDirectoriesFluentBuilder

Constructs a fluent builder for the DescribeSharedDirectories operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • owner_directory_id(impl Into<String>) / set_owner_directory_id(Option<String>):
    required: true
    

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

    
    
  • shared_directory_ids(impl Into<String>) / set_shared_directory_ids(Option<Vec::<String>>):
    required: false
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

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

    
    
• On success, responds with DescribeSharedDirectoriesOutput with field(s):
  • shared_directories(Option<Vec::<SharedDirectory>>):

    A list of all shared directories in your account.

  • next_token(Option<String>):

    If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

• On failure, responds with SdkError<DescribeSharedDirectoriesError>

impl Client

pub fn describe_snapshots(&self) -> DescribeSnapshotsFluentBuilder

Constructs a fluent builder for the DescribeSnapshots operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

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

    
    
  • snapshot_ids(impl Into<String>) / set_snapshot_ids(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of objects to return.

    
    
• On success, responds with DescribeSnapshotsOutput with field(s):
  • snapshots(Option<Vec::<Snapshot>>):

    The list of Snapshot objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

• On failure, responds with SdkError<DescribeSnapshotsError>

impl Client

pub fn describe_trusts(&self) -> DescribeTrustsFluentBuilder

Constructs a fluent builder for the DescribeTrusts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

    The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.

    
    
  • trust_ids(impl Into<String>) / set_trust_ids(Option<Vec::<String>>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of objects to return.

    
    
• On success, responds with DescribeTrustsOutput with field(s):
  • trusts(Option<Vec::<Trust>>):

    The list of Trust objects that were retrieved.

    It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.

• On failure, responds with SdkError<DescribeTrustsError>

impl Client

pub fn describe_update_directory(&self) -> DescribeUpdateDirectoryFluentBuilder

Constructs a fluent builder for the DescribeUpdateDirectory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The unique identifier of the directory.

    
    
  • update_type(UpdateType) / set_update_type(Option<UpdateType>):
    required: true
    

    The type of updates you want to describe for the directory.

    
    
  • region_name(impl Into<String>) / set_region_name(Option<String>):
    required: false
    

    The name of the Region.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
• On success, responds with DescribeUpdateDirectoryOutput with field(s):
  • update_activities(Option<Vec::<UpdateInfoEntry>>):

    The list of update activities on a directory for the requested update type.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter.

• On failure, responds with SdkError<DescribeUpdateDirectoryError>

impl Client

pub fn disable_client_authentication( &self, ) -> DisableClientAuthenticationFluentBuilder

Constructs a fluent builder for the DisableClientAuthentication operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory

    
    
  • r#type(ClientAuthenticationType) / set_type(Option<ClientAuthenticationType>):
    required: true
    

    The type of client authentication to disable. Currently the only parameter “SmartCard” is supported.

    
    
• On success, responds with DisableClientAuthenticationOutput
• On failure, responds with SdkError<DisableClientAuthenticationError>

impl Client

pub fn disable_directory_data_access( &self, ) -> DisableDirectoryDataAccessFluentBuilder

Constructs a fluent builder for the DisableDirectoryDataAccess operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The directory identifier.

    
    
• On success, responds with DisableDirectoryDataAccessOutput
• On failure, responds with SdkError<DisableDirectoryDataAccessError>

impl Client

pub fn disable_ldaps(&self) -> DisableLDAPSFluentBuilder

Constructs a fluent builder for the DisableLDAPS operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • r#type(LdapsType) / set_type(Option<LdapsType>):
    required: true
    

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

    
    
• On success, responds with DisableLdapsOutput
• On failure, responds with SdkError<DisableLDAPSError>

impl Client

pub fn disable_radius(&self) -> DisableRadiusFluentBuilder

Constructs a fluent builder for the DisableRadius operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which to disable MFA.

    
    
• On success, responds with DisableRadiusOutput
• On failure, responds with SdkError<DisableRadiusError>

impl Client

pub fn disable_sso(&self) -> DisableSsoFluentBuilder

Constructs a fluent builder for the DisableSso operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with DisableSsoOutput
• On failure, responds with SdkError<DisableSsoError>

impl Client

pub fn enable_client_authentication( &self, ) -> EnableClientAuthenticationFluentBuilder

Constructs a fluent builder for the EnableClientAuthentication operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the specified directory.

    
    
  • r#type(ClientAuthenticationType) / set_type(Option<ClientAuthenticationType>):
    required: true
    

    The type of client authentication to enable. Currently only the value SmartCard is supported. Smart card authentication in AD Connector requires that you enable Kerberos Constrained Delegation for the Service User to the LDAP service in your self-managed AD.

    
    
• On success, responds with EnableClientAuthenticationOutput
• On failure, responds with SdkError<EnableClientAuthenticationError>

impl Client

pub fn enable_directory_data_access( &self, ) -> EnableDirectoryDataAccessFluentBuilder

Constructs a fluent builder for the EnableDirectoryDataAccess operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The directory identifier.

    
    
• On success, responds with EnableDirectoryDataAccessOutput
• On failure, responds with SdkError<EnableDirectoryDataAccessError>

impl Client

pub fn enable_ldaps(&self) -> EnableLDAPSFluentBuilder

Constructs a fluent builder for the EnableLDAPS operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • r#type(LdapsType) / set_type(Option<LdapsType>):
    required: true
    

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

    
    
• On success, responds with EnableLdapsOutput
• On failure, responds with SdkError<EnableLDAPSError>

impl Client

pub fn enable_radius(&self) -> EnableRadiusFluentBuilder

Constructs a fluent builder for the EnableRadius operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which to enable MFA.

    
    
  • radius_settings(RadiusSettings) / set_radius_settings(Option<RadiusSettings>):
    required: true
    

    A RadiusSettings object that contains information about the RADIUS server.

    
    
• On success, responds with EnableRadiusOutput
• On failure, responds with SdkError<EnableRadiusError>

impl Client

pub fn enable_sso(&self) -> EnableSsoFluentBuilder

Constructs a fluent builder for the EnableSso operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: false
    

    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(impl Into<String>) / set_password(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with EnableSsoOutput
• On failure, responds with SdkError<EnableSsoError>

impl Client

pub fn get_directory_limits(&self) -> GetDirectoryLimitsFluentBuilder

Constructs a fluent builder for the GetDirectoryLimits operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetDirectoryLimitsOutput with field(s):
  • directory_limits(Option<DirectoryLimits>):

    A DirectoryLimits object that contains the directory limits for the current Region.

• On failure, responds with SdkError<GetDirectoryLimitsError>

impl Client

pub fn get_snapshot_limits(&self) -> GetSnapshotLimitsFluentBuilder

Constructs a fluent builder for the GetSnapshotLimits operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with GetSnapshotLimitsOutput with field(s):
  • snapshot_limits(Option<SnapshotLimits>):

    A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

• On failure, responds with SdkError<GetSnapshotLimitsError>

impl Client

pub fn list_certificates(&self) -> ListCertificatesFluentBuilder

Constructs a fluent builder for the ListCertificates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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(i32) / set_limit(Option<i32>):
    required: false
    

    The number of items that should show up on one page

    
    
• On success, responds with ListCertificatesOutput with field(s):
  • next_token(Option<String>):

    Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

  • certificates_info(Option<Vec::<CertificateInfo>>):

    A list of certificates with basic details including certificate ID, certificate common name, certificate state.

• On failure, responds with SdkError<ListCertificatesError>

impl Client

pub fn list_ip_routes(&self) -> ListIpRoutesFluentBuilder

Constructs a fluent builder for the ListIpRoutes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

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

    
    
• On success, responds with ListIpRoutesOutput with field(s):
  • ip_routes_info(Option<Vec::<IpRouteInfo>>):

    A list of IpRoutes.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

• On failure, responds with SdkError<ListIpRoutesError>

impl Client

pub fn list_log_subscriptions(&self) -> ListLogSubscriptionsFluentBuilder

Constructs a fluent builder for the ListLogSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: false
    

    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 Amazon Web Services account. If there are no log subscriptions for the Amazon Web Services account or the directory, an empty list will be returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next set of items to return.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of items returned.

    
    
• On success, responds with ListLogSubscriptionsOutput with field(s):
  • log_subscriptions(Option<Vec::<LogSubscription>>):

    A list of active LogSubscription objects for calling the Amazon Web Services account.

  • next_token(Option<String>):

    The token for the next set of items to return.

• On failure, responds with SdkError<ListLogSubscriptionsError>

impl Client

pub fn list_schema_extensions(&self) -> ListSchemaExtensionsFluentBuilder

Constructs a fluent builder for the ListSchemaExtensions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

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

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    The maximum number of items to return.

    
    
• On success, responds with ListSchemaExtensionsOutput with field(s):
  • schema_extensions_info(Option<Vec::<SchemaExtensionInfo>>):

    Information about the schema extensions applied to the directory.

  • next_token(Option<String>):

    If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

• On failure, responds with SdkError<ListSchemaExtensionsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

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

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Reserved for future use.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    Reserved for future use.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    List of tags returned by the ListTagsForResource operation.

  • next_token(Option<String>):

    Reserved for future use.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn register_certificate(&self) -> RegisterCertificateFluentBuilder

Constructs a fluent builder for the RegisterCertificate operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory.

    
    
  • certificate_data(impl Into<String>) / set_certificate_data(Option<String>):
    required: true
    

    The certificate PEM string that needs to be registered.

    
    
  • r#type(CertificateType) / set_type(Option<CertificateType>):
    required: false
    

    The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.

    
    
  • client_cert_auth_settings(ClientCertAuthSettings) / set_client_cert_auth_settings(Option<ClientCertAuthSettings>):
    required: false
    

    A ClientCertAuthSettings object that contains client certificate authentication settings.

    
    
• On success, responds with RegisterCertificateOutput with field(s):
  • certificate_id(Option<String>):

    The identifier of the certificate.

• On failure, responds with SdkError<RegisterCertificateError>

impl Client

pub fn register_event_topic(&self) -> RegisterEventTopicFluentBuilder

Constructs a fluent builder for the RegisterEventTopic operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • topic_name(impl Into<String>) / set_topic_name(Option<String>):
    required: true
    

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

    
    
• On success, responds with RegisterEventTopicOutput
• On failure, responds with SdkError<RegisterEventTopicError>

impl Client

pub fn reject_shared_directory(&self) -> RejectSharedDirectoryFluentBuilder

Constructs a fluent builder for the RejectSharedDirectory operation.

• The fluent builder is configurable:
  • shared_directory_id(impl Into<String>) / set_shared_directory_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with RejectSharedDirectoryOutput with field(s):
  • shared_directory_id(Option<String>):

    Identifier of the shared directory in the directory consumer account.

• On failure, responds with SdkError<RejectSharedDirectoryError>

impl Client

pub fn remove_ip_routes(&self) -> RemoveIpRoutesFluentBuilder

Constructs a fluent builder for the RemoveIpRoutes operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • cidr_ips(impl Into<String>) / set_cidr_ips(Option<Vec::<String>>):
    required: true
    

    IP address blocks that you want to remove.

    
    
• On success, responds with RemoveIpRoutesOutput
• On failure, responds with SdkError<RemoveIpRoutesError>

impl Client

pub fn remove_region(&self) -> RemoveRegionFluentBuilder

Constructs a fluent builder for the RemoveRegion operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which you want to remove Region replication.

    
    
• On success, responds with RemoveRegionOutput
• On failure, responds with SdkError<RemoveRegionError>

impl Client

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

• The fluent builder is configurable:
  • resource_id(impl Into<String>) / set_resource_id(Option<String>):
    required: true
    

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with RemoveTagsFromResourceOutput
• On failure, responds with SdkError<RemoveTagsFromResourceError>

impl Client

pub fn reset_user_password(&self) -> ResetUserPasswordFluentBuilder

Constructs a fluent builder for the ResetUserPassword operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • user_name(impl Into<String>) / set_user_name(Option<String>):
    required: true
    

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

    
    
  • new_password(impl Into<String>) / set_new_password(Option<String>):
    required: true
    

    The new password that will be reset.

    
    
• On success, responds with ResetUserPasswordOutput
• On failure, responds with SdkError<ResetUserPasswordError>

impl Client

pub fn restore_from_snapshot(&self) -> RestoreFromSnapshotFluentBuilder

Constructs a fluent builder for the RestoreFromSnapshot operation.

• The fluent builder is configurable:
  • snapshot_id(impl Into<String>) / set_snapshot_id(Option<String>):
    required: true
    

    The identifier of the snapshot to restore from.

    
    
• On success, responds with RestoreFromSnapshotOutput
• On failure, responds with SdkError<RestoreFromSnapshotError>

impl Client

pub fn share_directory(&self) -> ShareDirectoryFluentBuilder

Constructs a fluent builder for the ShareDirectory operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • share_notes(impl Into<String>) / set_share_notes(Option<String>):
    required: false
    

    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(ShareTarget) / set_share_target(Option<ShareTarget>):
    required: true
    

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

    
    
  • share_method(ShareMethod) / set_share_method(Option<ShareMethod>):
    required: true
    

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

    
    
• On success, responds with ShareDirectoryOutput with field(s):
  • shared_directory_id(Option<String>):

    Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).

• On failure, responds with SdkError<ShareDirectoryError>

impl Client

pub fn start_schema_extension(&self) -> StartSchemaExtensionFluentBuilder

Constructs a fluent builder for the StartSchemaExtension operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • create_snapshot_before_schema_extension(bool) / set_create_snapshot_before_schema_extension(Option<bool>):
    required: true
    

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

    
    
  • ldif_content(impl Into<String>) / set_ldif_content(Option<String>):
    required: true
    

    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(impl Into<String>) / set_description(Option<String>):
    required: true
    

    A description of the schema extension.

    
    
• On success, responds with StartSchemaExtensionOutput with field(s):
  • schema_extension_id(Option<String>):

    The identifier of the schema extension that will be applied.

• On failure, responds with SdkError<StartSchemaExtensionError>

impl Client

pub fn unshare_directory(&self) -> UnshareDirectoryFluentBuilder

Constructs a fluent builder for the UnshareDirectory operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • unshare_target(UnshareTarget) / set_unshare_target(Option<UnshareTarget>):
    required: true
    

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

    
    
• On success, responds with UnshareDirectoryOutput with field(s):
  • shared_directory_id(Option<String>):

    Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).

• On failure, responds with SdkError<UnshareDirectoryError>

impl Client

pub fn update_conditional_forwarder( &self, ) -> UpdateConditionalForwarderFluentBuilder

Constructs a fluent builder for the UpdateConditionalForwarder operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The directory ID of the Amazon Web Services directory for which to update the conditional forwarder.

    
    
  • remote_domain_name(impl Into<String>) / set_remote_domain_name(Option<String>):
    required: true
    

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

    
    
  • dns_ip_addrs(impl Into<String>) / set_dns_ip_addrs(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UpdateConditionalForwarderOutput
• On failure, responds with SdkError<UpdateConditionalForwarderError>

impl Client

pub fn update_directory_setup(&self) -> UpdateDirectorySetupFluentBuilder

Constructs a fluent builder for the UpdateDirectorySetup operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory on which you want to perform the update.

    
    
  • update_type(UpdateType) / set_update_type(Option<UpdateType>):
    required: true
    

    The type of update that needs to be performed on the directory. For example, OS.

    
    
  • os_update_settings(OsUpdateSettings) / set_os_update_settings(Option<OsUpdateSettings>):
    required: false
    

    The settings for the OS update that needs to be performed on the directory.

    
    
  • create_snapshot_before_update(bool) / set_create_snapshot_before_update(Option<bool>):
    required: false
    

    The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.

    
    
• On success, responds with UpdateDirectorySetupOutput
• On failure, responds with SdkError<UpdateDirectorySetupError>

impl Client

pub fn update_number_of_domain_controllers( &self, ) -> UpdateNumberOfDomainControllersFluentBuilder

Constructs a fluent builder for the UpdateNumberOfDomainControllers operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • desired_number(i32) / set_desired_number(Option<i32>):
    required: true
    

    The number of domain controllers desired in the directory.

    
    
• On success, responds with UpdateNumberOfDomainControllersOutput
• On failure, responds with SdkError<UpdateNumberOfDomainControllersError>

impl Client

pub fn update_radius(&self) -> UpdateRadiusFluentBuilder

Constructs a fluent builder for the UpdateRadius operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

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

    
    
  • radius_settings(RadiusSettings) / set_radius_settings(Option<RadiusSettings>):
    required: true
    

    A RadiusSettings object that contains information about the RADIUS server.

    
    
• On success, responds with UpdateRadiusOutput
• On failure, responds with SdkError<UpdateRadiusError>

impl Client

pub fn update_settings(&self) -> UpdateSettingsFluentBuilder

Constructs a fluent builder for the UpdateSettings operation.

• The fluent builder is configurable:
  • directory_id(impl Into<String>) / set_directory_id(Option<String>):
    required: true
    

    The identifier of the directory for which to update settings.

    
    
  • settings(Setting) / set_settings(Option<Vec::<Setting>>):
    required: true
    

    The list of Setting objects.

    
    
• On success, responds with UpdateSettingsOutput with field(s):
  • directory_id(Option<String>):

    The identifier of the directory.

• On failure, responds with SdkError<UpdateSettingsError>

impl Client

pub fn update_trust(&self) -> UpdateTrustFluentBuilder

Constructs a fluent builder for the UpdateTrust operation.

• The fluent builder is configurable:
  • trust_id(impl Into<String>) / set_trust_id(Option<String>):
    required: true
    

    Identifier of the trust relationship.

    
    
  • selective_auth(SelectiveAuth) / set_selective_auth(Option<SelectiveAuth>):
    required: false
    

    Updates selective authentication for the trust.

    
    
• On success, responds with UpdateTrustOutput with field(s):
  • request_id(Option<String>):

    The Amazon Web Services request identifier.

  • trust_id(Option<String>):

    Identifier of the trust relationship.

• On failure, responds with SdkError<UpdateTrustError>

impl Client

pub fn verify_trust(&self) -> VerifyTrustFluentBuilder

Constructs a fluent builder for the VerifyTrust operation.

• The fluent builder is configurable:
  • trust_id(impl Into<String>) / set_trust_id(Option<String>):
    required: true
    

    The unique Trust ID of the trust relationship to verify.

    
    
• On success, responds with VerifyTrustOutput with field(s):
  • trust_id(Option<String>):

    The unique Trust ID of the trust relationship that was verified.

• On failure, responds with SdkError<VerifyTrustError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.