Struct aws_sdk_directory::Client
source · pub struct Client { /* private fields */ }
Expand description
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.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_directory::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::retry::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_directory::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_directory::Client::from_conf(config);
Implementations§
source§impl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
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>)
: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>
sourcepub fn add_ip_routes(&self) -> AddIpRoutes
pub fn add_ip_routes(&self) -> AddIpRoutes
Constructs a fluent builder for the AddIpRoutes
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:Identifier (ID) of the directory to which to add the address block.
ip_routes(Vec<IpRoute>)
/set_ip_routes(Option<Vec<IpRoute>>)
:IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your self-managed domain.
update_security_group_for_directory_controllers(bool)
/set_update_security_group_for_directory_controllers(bool)
: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: 0.0.0.0/0
-
Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
-
Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
-
Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
-
Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
-
Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
-
Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
-
Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
-
Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
-
Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
-
Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0
Outbound:
-
Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
These security rules impact an internal network interface that is not exposed publicly.
-
- On success, responds with
AddIpRoutesOutput
- On failure, responds with
SdkError<AddIpRoutesError>
sourcepub fn add_region(&self) -> AddRegion
pub fn add_region(&self) -> AddRegion
Constructs a fluent builder for the AddRegion
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory to which you want to add Region replication.
region_name(impl Into<String>)
/set_region_name(Option<String>)
: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>)
:Contains VPC information for the
CreateDirectory
orCreateMicrosoftAD
operation.
- On success, responds with
AddRegionOutput
- On failure, responds with
SdkError<AddRegionError>
Constructs a fluent builder for the AddTagsToResource
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:Identifier (ID) for the directory to which to add the tag.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to be assigned to the directory.
- On success, responds with
AddTagsToResourceOutput
- On failure, responds with
SdkError<AddTagsToResourceError>
sourcepub fn cancel_schema_extension(&self) -> CancelSchemaExtension
pub fn cancel_schema_extension(&self) -> CancelSchemaExtension
Constructs a fluent builder for the CancelSchemaExtension
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory whose schema extension will be canceled.
schema_extension_id(impl Into<String>)
/set_schema_extension_id(Option<String>)
:The identifier of the schema extension that will be canceled.
- On success, responds with
CancelSchemaExtensionOutput
- On failure, responds with
SdkError<CancelSchemaExtensionError>
sourcepub fn connect_directory(&self) -> ConnectDirectory
pub fn connect_directory(&self) -> ConnectDirectory
Constructs a fluent builder for the ConnectDirectory
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The fully qualified name of your self-managed directory, such as
corp.example.com
.short_name(impl Into<String>)
/set_short_name(Option<String>)
:The NetBIOS name of your self-managed directory, such as
CORP
.password(impl Into<String>)
/set_password(Option<String>)
:The password for your self-managed user account.
description(impl Into<String>)
/set_description(Option<String>)
:A description for the directory.
size(DirectorySize)
/set_size(Option<DirectorySize>)
:The size of the directory.
connect_settings(DirectoryConnectSettings)
/set_connect_settings(Option<DirectoryConnectSettings>)
:A
DirectoryConnectSettings
object that contains additional information for the operation.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_alias(&self) -> CreateAlias
pub fn create_alias(&self) -> CreateAlias
Constructs a fluent builder for the CreateAlias
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to create the alias.
alias(impl Into<String>)
/set_alias(Option<String>)
: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>
sourcepub fn create_computer(&self) -> CreateComputer
pub fn create_computer(&self) -> CreateComputer
Constructs a fluent builder for the CreateComputer
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory in which to create the computer account.
computer_name(impl Into<String>)
/set_computer_name(Option<String>)
:The name of the computer account.
password(impl Into<String>)
/set_password(Option<String>)
:A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.
organizational_unit_distinguished_name(impl Into<String>)
/set_organizational_unit_distinguished_name(Option<String>)
:The fully-qualified distinguished name of the organizational unit to place the computer account in.
computer_attributes(Vec<Attribute>)
/set_computer_attributes(Option<Vec<Attribute>>)
: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>
sourcepub fn create_conditional_forwarder(&self) -> CreateConditionalForwarder
pub fn create_conditional_forwarder(&self) -> CreateConditionalForwarder
Constructs a fluent builder for the CreateConditionalForwarder
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
:The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
dns_ip_addrs(Vec<String>)
/set_dns_ip_addrs(Option<Vec<String>>)
:The IP addresses of the remote DNS server associated with RemoteDomainName.
- On success, responds with
CreateConditionalForwarderOutput
- On failure, responds with
SdkError<CreateConditionalForwarderError>
sourcepub fn create_directory(&self) -> CreateDirectory
pub fn create_directory(&self) -> CreateDirectory
Constructs a fluent builder for the CreateDirectory
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The fully qualified name for the directory, such as
corp.example.com
.short_name(impl Into<String>)
/set_short_name(Option<String>)
:The NetBIOS name of the directory, such as
CORP
.password(impl Into<String>)
/set_password(Option<String>)
:The password for the directory administrator. The directory creation process creates a directory administrator account with the user name
Administrator
and this password.If you need to change the password for the administrator account, you can use the
ResetUserPassword
API call.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)(?=.1)(?=.[a-z])
-
Special characters and upper case and lower case (?=.1)(?=.[A-Z])(?=.[a-z])
-
Numbers and upper case and special characters (?=.\d)(?=.[A-Z])(?=.1)
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>)
:A description for the directory.
size(DirectorySize)
/set_size(Option<DirectorySize>)
:The size of the directory.
vpc_settings(DirectoryVpcSettings)
/set_vpc_settings(Option<DirectoryVpcSettings>)
:A
DirectoryVpcSettings
object that contains additional information for the operation.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_log_subscription(&self) -> CreateLogSubscription
pub fn create_log_subscription(&self) -> CreateLogSubscription
Constructs a fluent builder for the CreateLogSubscription
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:Identifier of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.
log_group_name(impl Into<String>)
/set_log_group_name(Option<String>)
: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>
sourcepub fn create_microsoft_ad(&self) -> CreateMicrosoftAD
pub fn create_microsoft_ad(&self) -> CreateMicrosoftAD
Constructs a fluent builder for the CreateMicrosoftAD
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
: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>)
: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 DNScorp.example.com
.password(impl Into<String>)
/set_password(Option<String>)
:The password for the default administrative user named
Admin
.If you need to change the password for the administrator account, you can use the
ResetUserPassword
API call.description(impl Into<String>)
/set_description(Option<String>)
: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>)
:Contains VPC information for the
CreateDirectory
orCreateMicrosoftAD
operation.edition(DirectoryEdition)
/set_edition(Option<DirectoryEdition>)
:Managed Microsoft AD is available in two editions:
Standard
andEnterprise
.Enterprise
is the default.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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>
sourcepub fn create_snapshot(&self) -> CreateSnapshot
pub fn create_snapshot(&self) -> CreateSnapshot
Constructs a fluent builder for the CreateSnapshot
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory of which to take a snapshot.
name(impl Into<String>)
/set_name(Option<String>)
: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>
sourcepub fn create_trust(&self) -> CreateTrust
pub fn create_trust(&self) -> CreateTrust
Constructs a fluent builder for the CreateTrust
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
: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>)
:The trust password. The 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>)
:The direction of the trust relationship.
trust_type(TrustType)
/set_trust_type(Option<TrustType>)
:The trust relationship type.
Forest
is the default.conditional_forwarder_ip_addrs(Vec<String>)
/set_conditional_forwarder_ip_addrs(Option<Vec<String>>)
:The IP addresses of the remote DNS server associated with RemoteDomainName.
selective_auth(SelectiveAuth)
/set_selective_auth(Option<SelectiveAuth>)
: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>
sourcepub fn delete_conditional_forwarder(&self) -> DeleteConditionalForwarder
pub fn delete_conditional_forwarder(&self) -> DeleteConditionalForwarder
Constructs a fluent builder for the DeleteConditionalForwarder
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The directory ID for which you are deleting the conditional forwarder.
remote_domain_name(impl Into<String>)
/set_remote_domain_name(Option<String>)
: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>
sourcepub fn delete_directory(&self) -> DeleteDirectory
pub fn delete_directory(&self) -> DeleteDirectory
Constructs a fluent builder for the DeleteDirectory
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>
sourcepub fn delete_log_subscription(&self) -> DeleteLogSubscription
pub fn delete_log_subscription(&self) -> DeleteLogSubscription
Constructs a fluent builder for the DeleteLogSubscription
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:Identifier of the directory whose log subscription you want to delete.
- On success, responds with
DeleteLogSubscriptionOutput
- On failure, responds with
SdkError<DeleteLogSubscriptionError>
sourcepub fn delete_snapshot(&self) -> DeleteSnapshot
pub fn delete_snapshot(&self) -> DeleteSnapshot
Constructs a fluent builder for the DeleteSnapshot
operation.
- The fluent builder is configurable:
snapshot_id(impl Into<String>)
/set_snapshot_id(Option<String>)
: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>
sourcepub fn delete_trust(&self) -> DeleteTrust
pub fn delete_trust(&self) -> DeleteTrust
Constructs a fluent builder for the DeleteTrust
operation.
- The fluent builder is configurable:
trust_id(impl Into<String>)
/set_trust_id(Option<String>)
:The Trust ID of the trust relationship to be deleted.
delete_associated_conditional_forwarder(bool)
/set_delete_associated_conditional_forwarder(bool)
: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>
sourcepub fn deregister_certificate(&self) -> DeregisterCertificate
pub fn deregister_certificate(&self) -> DeregisterCertificate
Constructs a fluent builder for the DeregisterCertificate
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory.
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
:The identifier of the certificate.
- On success, responds with
DeregisterCertificateOutput
- On failure, responds with
SdkError<DeregisterCertificateError>
sourcepub fn deregister_event_topic(&self) -> DeregisterEventTopic
pub fn deregister_event_topic(&self) -> DeregisterEventTopic
Constructs a fluent builder for the DeregisterEventTopic
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
: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>
sourcepub fn describe_certificate(&self) -> DescribeCertificate
pub fn describe_certificate(&self) -> DescribeCertificate
Constructs a fluent builder for the DescribeCertificate
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory.
certificate_id(impl Into<String>)
/set_certificate_id(Option<String>)
: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>
sourcepub fn describe_client_authentication_settings(
&self
) -> DescribeClientAuthenticationSettings
pub fn describe_client_authentication_settings(
&self
) -> DescribeClientAuthenticationSettings
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>)
:The identifier of the directory for which to retrieve information.
r#type(ClientAuthenticationType)
/set_type(Option<ClientAuthenticationType>)
: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>)
:The DescribeClientAuthenticationSettingsResult.NextToken value from a previous call to
DescribeClientAuthenticationSettings
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn describe_conditional_forwarders(&self) -> DescribeConditionalForwarders
pub fn describe_conditional_forwarders(&self) -> DescribeConditionalForwarders
Constructs a fluent builder for the DescribeConditionalForwarders
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The directory ID for which to get the list of associated conditional forwarders.
remote_domain_names(Vec<String>)
/set_remote_domain_names(Option<Vec<String>>)
:The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.
- 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>
sourcepub fn describe_directories(&self) -> DescribeDirectories
pub fn describe_directories(&self) -> DescribeDirectories
Constructs a fluent builder for the DescribeDirectories
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
directory_ids(Vec<String>)
/set_directory_ids(Option<Vec<String>>)
:A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.
An empty list results in an
InvalidParameterException
being thrown.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
DescribeDirectoriesResult.NextToken
value from a previous call toDescribeDirectories
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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
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 toDescribeDirectories
to retrieve the next set of items.
- On failure, responds with
SdkError<DescribeDirectoriesError>
sourcepub fn describe_domain_controllers(&self) -> DescribeDomainControllers
pub fn describe_domain_controllers(&self) -> DescribeDomainControllers
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>)
:Identifier of the directory for which to retrieve the domain controller information.
domain_controller_ids(Vec<String>)
/set_domain_controller_ids(Option<Vec<String>>)
:A list of identifiers for the domain controllers whose information will be provided.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The DescribeDomainControllers.NextToken value from a previous call to
DescribeDomainControllers
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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 toDescribeDomainControllers
retrieve the next set of items.
- On failure, responds with
SdkError<DescribeDomainControllersError>
sourcepub fn describe_event_topics(&self) -> DescribeEventTopics
pub fn describe_event_topics(&self) -> DescribeEventTopics
Constructs a fluent builder for the DescribeEventTopics
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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(Vec<String>)
/set_topic_names(Option<Vec<String>>)
: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>
sourcepub fn describe_ldaps_settings(&self) -> DescribeLDAPSSettings
pub fn describe_ldaps_settings(&self) -> DescribeLDAPSSettings
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>)
:The identifier of the directory.
r#type(LdapsType)
/set_type(Option<LdapsType>)
:The type of LDAP security to enable. Currently only the value
Client
is supported.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The type of next token used for pagination.
limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn describe_regions(&self) -> DescribeRegions
pub fn describe_regions(&self) -> DescribeRegions
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>)
:The identifier of the directory.
region_name(impl Into<String>)
/set_region_name(Option<String>)
:The name of the Region. For example,
us-east-1
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
DescribeRegionsResult.NextToken
value from a previous call toDescribeRegions
. 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 toDescribeRegions
to retrieve the next set of items.
- On failure, responds with
SdkError<DescribeRegionsError>
sourcepub fn describe_settings(&self) -> DescribeSettings
pub fn describe_settings(&self) -> DescribeSettings
Constructs a fluent builder for the DescribeSettings
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to retrieve information.
status(DirectoryConfigurationStatus)
/set_status(Option<DirectoryConfigurationStatus>)
:The status of the directory settings for which to retrieve information.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
DescribeSettingsResult.NextToken
value from a previous call toDescribeSettings
. 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 toDescribeSettings
to retrieve the next set of items.
- On failure, responds with
SdkError<DescribeSettingsError>
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>)
:Returns the identifier of the directory in the directory owner account.
shared_directory_ids(Vec<String>)
/set_shared_directory_ids(Option<Vec<String>>)
:A list of identifiers of all shared directories in your account.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
DescribeSharedDirectoriesResult.NextToken
value from a previous call toDescribeSharedDirectories
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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 toDescribeSharedDirectories
to retrieve the next set of items.
- On failure, responds with
SdkError<DescribeSharedDirectoriesError>
sourcepub fn describe_snapshots(&self) -> DescribeSnapshots
pub fn describe_snapshots(&self) -> DescribeSnapshots
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>)
:The identifier of the directory for which to retrieve snapshot information.
snapshot_ids(Vec<String>)
/set_snapshot_ids(Option<Vec<String>>)
:A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The DescribeSnapshotsResult.NextToken value from a previous call to
DescribeSnapshots
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn describe_trusts(&self) -> DescribeTrusts
pub fn describe_trusts(&self) -> DescribeTrusts
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>)
:The Directory ID of the Amazon Web Services directory that is a part of the requested trust relationship.
trust_ids(Vec<String>)
/set_trust_ids(Option<Vec<String>>)
:A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.
An empty list results in an
InvalidParameterException
being thrown.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The DescribeTrustsResult.NextToken value from a previous call to
DescribeTrusts
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn describe_update_directory(&self) -> DescribeUpdateDirectory
pub fn describe_update_directory(&self) -> DescribeUpdateDirectory
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>)
:The unique identifier of the directory.
update_type(UpdateType)
/set_update_type(Option<UpdateType>)
:The type of updates you want to describe for the directory.
region_name(impl Into<String>)
/set_region_name(Option<String>)
:The name of the Region.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
DescribeUpdateDirectoryResult
. NextToken value from a previous call toDescribeUpdateDirectory
. 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>
sourcepub fn disable_client_authentication(&self) -> DisableClientAuthentication
pub fn disable_client_authentication(&self) -> DisableClientAuthentication
Constructs a fluent builder for the DisableClientAuthentication
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory
r#type(ClientAuthenticationType)
/set_type(Option<ClientAuthenticationType>)
:The type of client authentication to disable. Currently, only the parameter,
SmartCard
is supported.
- On success, responds with
DisableClientAuthenticationOutput
- On failure, responds with
SdkError<DisableClientAuthenticationError>
sourcepub fn disable_ldaps(&self) -> DisableLDAPS
pub fn disable_ldaps(&self) -> DisableLDAPS
Constructs a fluent builder for the DisableLDAPS
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory.
r#type(LdapsType)
/set_type(Option<LdapsType>)
: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>
sourcepub fn disable_radius(&self) -> DisableRadius
pub fn disable_radius(&self) -> DisableRadius
Constructs a fluent builder for the DisableRadius
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to disable MFA.
- On success, responds with
DisableRadiusOutput
- On failure, responds with
SdkError<DisableRadiusError>
sourcepub fn disable_sso(&self) -> DisableSso
pub fn disable_sso(&self) -> DisableSso
Constructs a fluent builder for the DisableSso
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to disable single-sign on.
user_name(impl Into<String>)
/set_user_name(Option<String>)
:The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.
If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
password(impl Into<String>)
/set_password(Option<String>)
:The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
- On success, responds with
DisableSsoOutput
- On failure, responds with
SdkError<DisableSsoError>
sourcepub fn enable_client_authentication(&self) -> EnableClientAuthentication
pub fn enable_client_authentication(&self) -> EnableClientAuthentication
Constructs a fluent builder for the EnableClientAuthentication
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the specified directory.
r#type(ClientAuthenticationType)
/set_type(Option<ClientAuthenticationType>)
: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>
sourcepub fn enable_ldaps(&self) -> EnableLDAPS
pub fn enable_ldaps(&self) -> EnableLDAPS
Constructs a fluent builder for the EnableLDAPS
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory.
r#type(LdapsType)
/set_type(Option<LdapsType>)
: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>
sourcepub fn enable_radius(&self) -> EnableRadius
pub fn enable_radius(&self) -> EnableRadius
Constructs a fluent builder for the EnableRadius
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to enable MFA.
radius_settings(RadiusSettings)
/set_radius_settings(Option<RadiusSettings>)
:A
RadiusSettings
object that contains information about the RADIUS server.
- On success, responds with
EnableRadiusOutput
- On failure, responds with
SdkError<EnableRadiusError>
sourcepub fn enable_sso(&self) -> EnableSso
pub fn enable_sso(&self) -> EnableSso
Constructs a fluent builder for the EnableSso
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to enable single-sign on.
user_name(impl Into<String>)
/set_user_name(Option<String>)
:The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.
If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
password(impl Into<String>)
/set_password(Option<String>)
:The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.
- On success, responds with
EnableSsoOutput
- On failure, responds with
SdkError<EnableSsoError>
sourcepub fn get_directory_limits(&self) -> GetDirectoryLimits
pub fn get_directory_limits(&self) -> GetDirectoryLimits
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>
sourcepub fn get_snapshot_limits(&self) -> GetSnapshotLimits
pub fn get_snapshot_limits(&self) -> GetSnapshotLimits
Constructs a fluent builder for the GetSnapshotLimits
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>
sourcepub fn list_certificates(&self) -> ListCertificates
pub fn list_certificates(&self) -> ListCertificates
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>)
:The identifier of the directory.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A token for requesting another page of certificates if the
NextToken
response element indicates that more certificates are available. Use the value of the returnedNextToken
element in your request until the token comes back asnull
. Passnull
if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn list_ip_routes(&self) -> ListIpRoutes
pub fn list_ip_routes(&self) -> ListIpRoutes
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>)
:Identifier (ID) of the directory for which you want to retrieve the IP addresses.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The ListIpRoutes.NextToken value from a previous call to
ListIpRoutes
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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
IpRoute
s.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>
sourcepub fn list_log_subscriptions(&self) -> ListLogSubscriptions
pub fn list_log_subscriptions(&self) -> ListLogSubscriptions
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>)
: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>)
:The token for the next set of items to return.
limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn list_schema_extensions(&self) -> ListSchemaExtensions
pub fn list_schema_extensions(&self) -> ListSchemaExtensions
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>)
:The identifier of the directory from which to retrieve the schema extension information.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
ListSchemaExtensions.NextToken
value from a previous call toListSchemaExtensions
. Pass null if this is the first call.limit(i32)
/set_limit(Option<i32>)
: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 toListSchemaExtensions
to retrieve the next set of items.
- On failure, responds with
SdkError<ListSchemaExtensionsError>
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>)
:Identifier (ID) of the directory for which you want to retrieve tags.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Reserved for future use.
limit(i32)
/set_limit(Option<i32>)
: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>
sourcepub fn register_certificate(&self) -> RegisterCertificate
pub fn register_certificate(&self) -> RegisterCertificate
Constructs a fluent builder for the RegisterCertificate
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory.
certificate_data(impl Into<String>)
/set_certificate_data(Option<String>)
:The certificate PEM string that needs to be registered.
r#type(CertificateType)
/set_type(Option<CertificateType>)
:The function that the registered certificate performs. Valid values include
ClientLDAPS
orClientCertAuth
. The default value isClientLDAPS
.client_cert_auth_settings(ClientCertAuthSettings)
/set_client_cert_auth_settings(Option<ClientCertAuthSettings>)
: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>
sourcepub fn register_event_topic(&self) -> RegisterEventTopic
pub fn register_event_topic(&self) -> RegisterEventTopic
Constructs a fluent builder for the RegisterEventTopic
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The Directory ID that will publish status messages to the Amazon SNS topic.
topic_name(impl Into<String>)
/set_topic_name(Option<String>)
: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>
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>)
: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>
sourcepub fn remove_ip_routes(&self) -> RemoveIpRoutes
pub fn remove_ip_routes(&self) -> RemoveIpRoutes
Constructs a fluent builder for the RemoveIpRoutes
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:Identifier (ID) of the directory from which you want to remove the IP addresses.
cidr_ips(Vec<String>)
/set_cidr_ips(Option<Vec<String>>)
:IP address blocks that you want to remove.
- On success, responds with
RemoveIpRoutesOutput
- On failure, responds with
SdkError<RemoveIpRoutesError>
sourcepub fn remove_region(&self) -> RemoveRegion
pub fn remove_region(&self) -> RemoveRegion
Constructs a fluent builder for the RemoveRegion
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which you want to remove Region replication.
- On success, responds with
RemoveRegionOutput
- On failure, responds with
SdkError<RemoveRegionError>
Constructs a fluent builder for the RemoveTagsFromResource
operation.
- The fluent builder is configurable:
resource_id(impl Into<String>)
/set_resource_id(Option<String>)
:Identifier (ID) of the directory from which to remove the tag.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag key (name) of the tag to be removed.
- On success, responds with
RemoveTagsFromResourceOutput
- On failure, responds with
SdkError<RemoveTagsFromResourceError>
sourcepub fn reset_user_password(&self) -> ResetUserPassword
pub fn reset_user_password(&self) -> ResetUserPassword
Constructs a fluent builder for the ResetUserPassword
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
:The user name of the user whose password will be reset.
new_password(impl Into<String>)
/set_new_password(Option<String>)
:The new password that will be reset.
- On success, responds with
ResetUserPasswordOutput
- On failure, responds with
SdkError<ResetUserPasswordError>
sourcepub fn restore_from_snapshot(&self) -> RestoreFromSnapshot
pub fn restore_from_snapshot(&self) -> RestoreFromSnapshot
Constructs a fluent builder for the RestoreFromSnapshot
operation.
- The fluent builder is configurable:
snapshot_id(impl Into<String>)
/set_snapshot_id(Option<String>)
:The identifier of the snapshot to restore from.
- On success, responds with
RestoreFromSnapshotOutput
- On failure, responds with
SdkError<RestoreFromSnapshotError>
Constructs a fluent builder for the ShareDirectory
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
: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>)
:Identifier for the directory consumer account with whom the directory is to be shared.
share_method(ShareMethod)
/set_share_method(Option<ShareMethod>)
: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>
sourcepub fn start_schema_extension(&self) -> StartSchemaExtension
pub fn start_schema_extension(&self) -> StartSchemaExtension
Constructs a fluent builder for the StartSchemaExtension
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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(bool)
:If true, creates a snapshot of the directory before applying the schema extension.
ldif_content(impl Into<String>)
/set_ldif_content(Option<String>)
:The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.
description(impl Into<String>)
/set_description(Option<String>)
: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>
Constructs a fluent builder for the UnshareDirectory
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the Managed Microsoft AD directory that you want to stop sharing.
unshare_target(UnshareTarget)
/set_unshare_target(Option<UnshareTarget>)
: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>
sourcepub fn update_conditional_forwarder(&self) -> UpdateConditionalForwarder
pub fn update_conditional_forwarder(&self) -> UpdateConditionalForwarder
Constructs a fluent builder for the UpdateConditionalForwarder
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
: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>)
:The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
dns_ip_addrs(Vec<String>)
/set_dns_ip_addrs(Option<Vec<String>>)
: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>
sourcepub fn update_directory_setup(&self) -> UpdateDirectorySetup
pub fn update_directory_setup(&self) -> UpdateDirectorySetup
Constructs a fluent builder for the UpdateDirectorySetup
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory on which you want to perform the update.
update_type(UpdateType)
/set_update_type(Option<UpdateType>)
: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>)
: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>)
: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>
sourcepub fn update_number_of_domain_controllers(
&self
) -> UpdateNumberOfDomainControllers
pub fn update_number_of_domain_controllers(
&self
) -> UpdateNumberOfDomainControllers
Constructs a fluent builder for the UpdateNumberOfDomainControllers
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:Identifier of the directory to which the domain controllers will be added or removed.
desired_number(i32)
/set_desired_number(i32)
:The number of domain controllers desired in the directory.
- On success, responds with
UpdateNumberOfDomainControllersOutput
- On failure, responds with
SdkError<UpdateNumberOfDomainControllersError>
sourcepub fn update_radius(&self) -> UpdateRadius
pub fn update_radius(&self) -> UpdateRadius
Constructs a fluent builder for the UpdateRadius
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to update the RADIUS server information.
radius_settings(RadiusSettings)
/set_radius_settings(Option<RadiusSettings>)
:A
RadiusSettings
object that contains information about the RADIUS server.
- On success, responds with
UpdateRadiusOutput
- On failure, responds with
SdkError<UpdateRadiusError>
sourcepub fn update_settings(&self) -> UpdateSettings
pub fn update_settings(&self) -> UpdateSettings
Constructs a fluent builder for the UpdateSettings
operation.
- The fluent builder is configurable:
directory_id(impl Into<String>)
/set_directory_id(Option<String>)
:The identifier of the directory for which to update settings.
settings(Vec<Setting>)
/set_settings(Option<Vec<Setting>>)
: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>
sourcepub fn update_trust(&self) -> UpdateTrust
pub fn update_trust(&self) -> UpdateTrust
Constructs a fluent builder for the UpdateTrust
operation.
- The fluent builder is configurable:
trust_id(impl Into<String>)
/set_trust_id(Option<String>)
:Identifier of the trust relationship.
selective_auth(SelectiveAuth)
/set_selective_auth(Option<SelectiveAuth>)
: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>
sourcepub fn verify_trust(&self) -> VerifyTrust
pub fn verify_trust(&self) -> VerifyTrust
Constructs a fluent builder for the VerifyTrust
operation.
- The fluent builder is configurable:
trust_id(impl Into<String>)
/set_trust_id(Option<String>)
: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>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
- This method will panic if the
conf
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
conf
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.