Class: Aws::DirectoryService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::DirectoryService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb
Overview
An API client for DirectoryService. To construct a client, you need to configure a :region and :credentials.
client = Aws::DirectoryService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_shared_directory(params = {}) ⇒ Types::AcceptSharedDirectoryResult
Accepts a directory sharing request that was sent from the directory owner account.
-
#add_ip_routes(params = {}) ⇒ Struct
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services.
-
#add_region(params = {}) ⇒ Struct
Adds two domain controllers in the specified Region for the specified directory.
-
#add_tags_to_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified directory.
-
#cancel_schema_extension(params = {}) ⇒ Struct
Cancels an in-progress schema extension to a Microsoft AD directory.
-
#connect_directory(params = {}) ⇒ Types::ConnectDirectoryResult
Creates an AD Connector to connect to a self-managed directory.
-
#create_alias(params = {}) ⇒ Types::CreateAliasResult
Creates an alias for a directory and assigns the alias to the directory.
-
#create_computer(params = {}) ⇒ Types::CreateComputerResult
Creates an Active Directory computer object in the specified directory.
-
#create_conditional_forwarder(params = {}) ⇒ Struct
Creates a conditional forwarder associated with your Amazon Web Services directory.
-
#create_directory(params = {}) ⇒ Types::CreateDirectoryResult
Creates a Simple AD directory.
-
#create_hybrid_ad(params = {}) ⇒ Types::CreateHybridADResult
Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.
-
#create_log_subscription(params = {}) ⇒ Struct
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
-
#create_microsoft_ad(params = {}) ⇒ Types::CreateMicrosoftADResult
Creates a Microsoft AD directory in the Amazon Web Services Cloud.
-
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResult
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
-
#create_trust(params = {}) ⇒ Types::CreateTrustResult
Directory Service for Microsoft Active Directory allows you to configure trust relationships.
-
#delete_ad_assessment(params = {}) ⇒ Types::DeleteADAssessmentResult
Deletes a directory assessment and all associated data.
-
#delete_conditional_forwarder(params = {}) ⇒ Struct
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
-
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResult
Deletes an Directory Service directory.
-
#delete_log_subscription(params = {}) ⇒ Struct
Deletes the specified log subscription.
-
#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResult
Deletes a directory snapshot.
-
#delete_trust(params = {}) ⇒ Types::DeleteTrustResult
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
-
#deregister_certificate(params = {}) ⇒ Struct
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
-
#deregister_event_topic(params = {}) ⇒ Struct
Removes the specified directory as a publisher to the specified Amazon SNS topic.
-
#describe_ad_assessment(params = {}) ⇒ Types::DescribeADAssessmentResult
Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details.
-
#describe_ca_enrollment_policy(params = {}) ⇒ Types::DescribeCAEnrollmentPolicyResult
Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory.
-
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResult
Displays information about the certificate registered for secure LDAP or client certificate authentication.
-
#describe_client_authentication_settings(params = {}) ⇒ Types::DescribeClientAuthenticationSettingsResult
Retrieves information about the type of client authentication for the specified directory, if the type is specified.
-
#describe_conditional_forwarders(params = {}) ⇒ Types::DescribeConditionalForwardersResult
Obtains information about the conditional forwarders for this account.
-
#describe_directories(params = {}) ⇒ Types::DescribeDirectoriesResult
Obtains information about the directories that belong to this account.
-
#describe_directory_data_access(params = {}) ⇒ Types::DescribeDirectoryDataAccessResult
Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
-
#describe_domain_controllers(params = {}) ⇒ Types::DescribeDomainControllersResult
Provides information about any domain controllers in your directory.
-
#describe_event_topics(params = {}) ⇒ Types::DescribeEventTopicsResult
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
-
#describe_hybrid_ad_update(params = {}) ⇒ Types::DescribeHybridADUpdateResult
Retrieves information about update activities for a hybrid directory.
-
#describe_ldaps_settings(params = {}) ⇒ Types::DescribeLDAPSSettingsResult
Describes the status of LDAP security for the specified directory.
-
#describe_regions(params = {}) ⇒ Types::DescribeRegionsResult
Provides information about the Regions that are configured for multi-Region replication.
-
#describe_settings(params = {}) ⇒ Types::DescribeSettingsResult
Retrieves information about the configurable settings for the specified directory.
-
#describe_shared_directories(params = {}) ⇒ Types::DescribeSharedDirectoriesResult
Returns the shared directories in your account.
-
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult
Obtains information about the directory snapshots that belong to this account.
-
#describe_trusts(params = {}) ⇒ Types::DescribeTrustsResult
Obtains information about the trust relationships for this account.
-
#describe_update_directory(params = {}) ⇒ Types::DescribeUpdateDirectoryResult
Describes the updates of a directory for a particular update type.
-
#disable_ca_enrollment_policy(params = {}) ⇒ Struct
Disables the certificate authority (CA) enrollment policy for the specified directory.
-
#disable_client_authentication(params = {}) ⇒ Struct
Disables alternative client authentication methods for the specified directory.
-
#disable_directory_data_access(params = {}) ⇒ Struct
Deactivates access to directory data via the Directory Service Data API for the specified directory.
-
#disable_ldaps(params = {}) ⇒ Struct
Deactivates LDAP secure calls for the specified directory.
-
#disable_radius(params = {}) ⇒ Struct
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
-
#disable_sso(params = {}) ⇒ Struct
Disables single-sign on for a directory.
-
#enable_ca_enrollment_policy(params = {}) ⇒ Struct
Enables certificate authority (CA) enrollment policy for the specified directory.
-
#enable_client_authentication(params = {}) ⇒ Struct
Enables alternative client authentication methods for the specified directory.
-
#enable_directory_data_access(params = {}) ⇒ Struct
Enables access to directory data via the Directory Service Data API for the specified directory.
-
#enable_ldaps(params = {}) ⇒ Struct
Activates the switch for the specific directory to always use LDAP secure calls.
-
#enable_radius(params = {}) ⇒ Struct
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
-
#enable_sso(params = {}) ⇒ Struct
Enables single sign-on for a directory.
-
#get_directory_limits(params = {}) ⇒ Types::GetDirectoryLimitsResult
Obtains directory limit information for the current Region.
-
#get_snapshot_limits(params = {}) ⇒ Types::GetSnapshotLimitsResult
Obtains the manual snapshot limits for a directory.
-
#list_ad_assessments(params = {}) ⇒ Types::ListADAssessmentsResult
Retrieves a list of directory assessments for the specified directory or all assessments in your account.
-
#list_certificates(params = {}) ⇒ Types::ListCertificatesResult
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
-
#list_ip_routes(params = {}) ⇒ Types::ListIpRoutesResult
Lists the address blocks that you have added to a directory.
-
#list_log_subscriptions(params = {}) ⇒ Types::ListLogSubscriptionsResult
Lists the active log subscriptions for the Amazon Web Services account.
-
#list_schema_extensions(params = {}) ⇒ Types::ListSchemaExtensionsResult
Lists all schema extensions applied to a Microsoft AD Directory.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists all tags on a directory.
-
#register_certificate(params = {}) ⇒ Types::RegisterCertificateResult
Registers a certificate for a secure LDAP or client certificate authentication.
-
#register_event_topic(params = {}) ⇒ Struct
Associates a directory with an Amazon SNS topic.
-
#reject_shared_directory(params = {}) ⇒ Types::RejectSharedDirectoryResult
Rejects a directory sharing request that was sent from the directory owner account.
-
#remove_ip_routes(params = {}) ⇒ Struct
Removes IP address blocks from a directory.
-
#remove_region(params = {}) ⇒ Struct
Stops all replication and removes the domain controllers from the specified Region.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes tags from a directory.
-
#reset_user_password(params = {}) ⇒ Struct
Resets the password for any user in your Managed Microsoft AD or Simple AD directory.
-
#restore_from_snapshot(params = {}) ⇒ Struct
Restores a directory using an existing directory snapshot.
-
#share_directory(params = {}) ⇒ Types::ShareDirectoryResult
Shares a specified directory (
DirectoryId) in your Amazon Web Services account (directory owner) with another Amazon Web Services account (directory consumer). -
#start_ad_assessment(params = {}) ⇒ Types::StartADAssessmentResult
Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join.
-
#start_schema_extension(params = {}) ⇒ Types::StartSchemaExtensionResult
Applies a schema extension to a Microsoft AD directory.
-
#unshare_directory(params = {}) ⇒ Types::UnshareDirectoryResult
Stops the directory sharing between the directory owner and consumer accounts.
-
#update_conditional_forwarder(params = {}) ⇒ Struct
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
-
#update_directory_setup(params = {}) ⇒ Struct
Updates directory configuration for the specified update type.
-
#update_hybrid_ad(params = {}) ⇒ Types::UpdateHybridADResult
Updates the configuration of an existing hybrid directory.
-
#update_number_of_domain_controllers(params = {}) ⇒ Struct
Adds or removes domain controllers to or from the directory.
-
#update_radius(params = {}) ⇒ Struct
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
-
#update_settings(params = {}) ⇒ Types::UpdateSettingsResult
Updates the configurable settings for the specified directory.
-
#update_trust(params = {}) ⇒ Types::UpdateTrustResult
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
-
#verify_trust(params = {}) ⇒ Types::VerifyTrustResult
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
486 487 488 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#accept_shared_directory(params = {}) ⇒ Types::AcceptSharedDirectoryResult
Accepts a directory sharing request that was sent from the directory owner account.
525 526 527 528 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 525 def accept_shared_directory(params = {}, = {}) req = build_request(:accept_shared_directory, params) req.send_request() end |
#add_ip_routes(params = {}) ⇒ Struct
If the DNS server for your self-managed domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on Amazon Web Services to a peer VPC.
Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
664 665 666 667 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 664 def add_ip_routes(params = {}, = {}) req = build_request(:add_ip_routes, params) req.send_request() end |
#add_region(params = {}) ⇒ Struct
Adds two domain controllers in the specified Region for the specified directory.
701 702 703 704 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 701 def add_region(params = {}, = {}) req = build_request(:add_region, params) req.send_request() end |
#add_tags_to_resource(params = {}) ⇒ Struct
Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.
753 754 755 756 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 753 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#cancel_schema_extension(params = {}) ⇒ Struct
Cancels an in-progress schema extension to a Microsoft AD directory.
Once a schema extension has started replicating to all domain
controllers, the task can no longer be canceled. A schema extension
can be canceled during any of the following states; Initializing,
CreatingSnapshot, and UpdatingSchema.
798 799 800 801 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 798 def cancel_schema_extension(params = {}, = {}) req = build_request(:cancel_schema_extension, params) req.send_request() end |
#connect_directory(params = {}) ⇒ Types::ConnectDirectoryResult
Creates an AD Connector to connect to a self-managed directory.
Before you call ConnectDirectory, ensure that all of the required
permissions have been explicitly granted through a policy. For details
about what permissions are required to run the ConnectDirectory
operation, see Directory Service API Permissions: Actions, Resources,
and Conditions Reference.
907 908 909 910 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 907 def connect_directory(params = {}, = {}) req = build_request(:connect_directory, params) req.send_request() end |
#create_alias(params = {}) ⇒ Types::CreateAliasResult
Creates an alias for a directory and assigns the alias to the
directory. The alias is used to construct the access URL for the
directory, such as http://<alias>.awsapps.com.
After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
966 967 968 969 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 966 def create_alias(params = {}, = {}) req = build_request(:create_alias, params) req.send_request() end |
#create_computer(params = {}) ⇒ Types::CreateComputerResult
Creates an Active Directory computer object in the specified directory.
1061 1062 1063 1064 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1061 def create_computer(params = {}, = {}) req = build_request(:create_computer, params) req.send_request() end |
#create_conditional_forwarder(params = {}) ⇒ Struct
Creates a conditional forwarder associated with your Amazon Web Services directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1119 def create_conditional_forwarder(params = {}, = {}) req = build_request(:create_conditional_forwarder, params) req.send_request() end |
#create_directory(params = {}) ⇒ Types::CreateDirectoryResult
Creates a Simple AD directory. For more information, see Simple Active Directory in the Directory Service Admin Guide.
Before you call CreateDirectory, ensure that all of the required
permissions have been explicitly granted through a policy. For details
about what permissions are required to run the CreateDirectory
operation, see Directory Service API Permissions: Actions, Resources,
and Conditions Reference.
1258 1259 1260 1261 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1258 def create_directory(params = {}, = {}) req = build_request(:create_directory, params) req.send_request() end |
#create_hybrid_ad(params = {}) ⇒ Types::CreateHybridADResult
Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services.
You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation.
Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.
1318 1319 1320 1321 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1318 def create_hybrid_ad(params = {}, = {}) req = build_request(:create_hybrid_ad, params) req.send_request() end |
#create_log_subscription(params = {}) ⇒ Struct
Creates a subscription to forward real-time Directory Service domain controller security logs to the specified Amazon CloudWatch log group in your Amazon Web Services account.
1348 1349 1350 1351 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1348 def create_log_subscription(params = {}, = {}) req = build_request(:create_log_subscription, params) req.send_request() end |
#create_microsoft_ad(params = {}) ⇒ Types::CreateMicrosoftADResult
Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide.
Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.
1462 1463 1464 1465 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1462 def create_microsoft_ad(params = {}, = {}) req = build_request(:create_microsoft_ad, params) req.send_request() end |
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResult
Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1514 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#create_trust(params = {}) ⇒ Types::CreateTrustResult
Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Managed Microsoft AD directory, and your existing self-managed Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.
This action initiates the creation of the Amazon Web Services side of a trust relationship between an Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
1606 1607 1608 1609 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1606 def create_trust(params = {}, = {}) req = build_request(:create_trust, params) req.send_request() end |
#delete_ad_assessment(params = {}) ⇒ Types::DeleteADAssessmentResult
Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.
You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1639 def delete_ad_assessment(params = {}, = {}) req = build_request(:delete_ad_assessment, params) req.send_request() end |
#delete_conditional_forwarder(params = {}) ⇒ Struct
Deletes a conditional forwarder that has been set up for your Amazon Web Services directory.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1681 def delete_conditional_forwarder(params = {}, = {}) req = build_request(:delete_conditional_forwarder, params) req.send_request() end |
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResult
Deletes an Directory Service directory.
Before you call DeleteDirectory, ensure that all of the required
permissions have been explicitly granted through a policy. For details
about what permissions are required to run the DeleteDirectory
operation, see Directory Service API Permissions: Actions, Resources,
and Conditions Reference.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1733 def delete_directory(params = {}, = {}) req = build_request(:delete_directory, params) req.send_request() end |
#delete_log_subscription(params = {}) ⇒ Struct
Deletes the specified log subscription.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1755 def delete_log_subscription(params = {}, = {}) req = build_request(:delete_log_subscription, params) req.send_request() end |
#delete_snapshot(params = {}) ⇒ Types::DeleteSnapshotResult
Deletes a directory snapshot.
1797 1798 1799 1800 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1797 def delete_snapshot(params = {}, = {}) req = build_request(:delete_snapshot, params) req.send_request() end |
#delete_trust(params = {}) ⇒ Types::DeleteTrustResult
Deletes an existing trust relationship between your Managed Microsoft AD directory and an external domain.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1845 def delete_trust(params = {}, = {}) req = build_request(:delete_trust, params) req.send_request() end |
#deregister_certificate(params = {}) ⇒ Struct
Deletes from the system the certificate that was registered for secure LDAP or client certificate authentication.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1872 def deregister_certificate(params = {}, = {}) req = build_request(:deregister_certificate, params) req.send_request() end |
#deregister_event_topic(params = {}) ⇒ Struct
Removes the specified directory as a publisher to the specified Amazon SNS topic.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1915 def deregister_event_topic(params = {}, = {}) req = build_request(:deregister_event_topic, params) req.send_request() end |
#describe_ad_assessment(params = {}) ⇒ Types::DescribeADAssessmentResult
Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1974 def describe_ad_assessment(params = {}, = {}) req = build_request(:describe_ad_assessment, params) req.send_request() end |
#describe_ca_enrollment_policy(params = {}) ⇒ Types::DescribeCAEnrollmentPolicyResult
Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.
2014 2015 2016 2017 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2014 def describe_ca_enrollment_policy(params = {}, = {}) req = build_request(:describe_ca_enrollment_policy, params) req.send_request() end |
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResult
Displays information about the certificate registered for secure LDAP or client certificate authentication.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2054 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, params) req.send_request() end |
#describe_client_authentication_settings(params = {}) ⇒ Types::DescribeClientAuthenticationSettingsResult
Retrieves information about the type of client authentication for the
specified directory, if the type is specified. If no type is
specified, information about all client authentication types that are
supported for the specified directory is retrieved. Currently, only
SmartCard is supported.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2111 2112 2113 2114 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2111 def describe_client_authentication_settings(params = {}, = {}) req = build_request(:describe_client_authentication_settings, params) req.send_request() end |
#describe_conditional_forwarders(params = {}) ⇒ Types::DescribeConditionalForwardersResult
Obtains information about the conditional forwarders for this account.
If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2174 def describe_conditional_forwarders(params = {}, = {}) req = build_request(:describe_conditional_forwarders, params) req.send_request() end |
#describe_directories(params = {}) ⇒ Types::DescribeDirectoriesResult
Obtains information about the directories that belong to this account.
You can retrieve information about specific directories by passing the
directory identifiers in the DirectoryIds parameter. Otherwise, all
directories that belong to the current account are returned.
This operation supports pagination with the use of the NextToken
request and response parameters. If more results are available, the
DescribeDirectoriesResult.NextToken member contains a token that you
pass in the next call to DescribeDirectories to retrieve the next set
of items.
You can also specify a maximum number of return results with the
Limit parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2364 2365 2366 2367 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2364 def describe_directories(params = {}, = {}) req = build_request(:describe_directories, params) req.send_request() end |
#describe_directory_data_access(params = {}) ⇒ Types::DescribeDirectoryDataAccessResult
Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
2393 2394 2395 2396 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2393 def describe_directory_data_access(params = {}, = {}) req = build_request(:describe_directory_data_access, params) req.send_request() end |
#describe_domain_controllers(params = {}) ⇒ Types::DescribeDomainControllersResult
Provides information about any domain controllers in your directory.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2451 def describe_domain_controllers(params = {}, = {}) req = build_request(:describe_domain_controllers, params) req.send_request() end |
#describe_event_topics(params = {}) ⇒ Types::DescribeEventTopicsResult
Obtains information about which Amazon SNS topics receive status messages from the specified directory.
If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.
2522 2523 2524 2525 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2522 def describe_event_topics(params = {}, = {}) req = build_request(:describe_event_topics, params) req.send_request() end |
#describe_hybrid_ad_update(params = {}) ⇒ Types::DescribeHybridADUpdateResult
Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).
The following waiters are defined for this operation (see #wait_until for detailed usage):
- hybrid_ad_updated
2600 2601 2602 2603 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2600 def describe_hybrid_ad_update(params = {}, = {}) req = build_request(:describe_hybrid_ad_update, params) req.send_request() end |
#describe_ldaps_settings(params = {}) ⇒ Types::DescribeLDAPSSettingsResult
Describes the status of LDAP security for the specified directory.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2648 2649 2650 2651 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2648 def describe_ldaps_settings(params = {}, = {}) req = build_request(:describe_ldaps_settings, params) req.send_request() end |
#describe_regions(params = {}) ⇒ Types::DescribeRegionsResult
Provides information about the Regions that are configured for multi-Region replication.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2701 2702 2703 2704 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2701 def describe_regions(params = {}, = {}) req = build_request(:describe_regions, params) req.send_request() end |
#describe_settings(params = {}) ⇒ Types::DescribeSettingsResult
Retrieves information about the configurable settings for the specified directory.
2756 2757 2758 2759 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2756 def describe_settings(params = {}, = {}) req = build_request(:describe_settings, params) req.send_request() end |
#describe_shared_directories(params = {}) ⇒ Types::DescribeSharedDirectoriesResult
Returns the shared directories in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2812 2813 2814 2815 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2812 def describe_shared_directories(params = {}, = {}) req = build_request(:describe_shared_directories, params) req.send_request() end |
#describe_snapshots(params = {}) ⇒ Types::DescribeSnapshotsResult
Obtains information about the directory snapshots that belong to this account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.
You can also specify a maximum number of return results with the Limit parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2901 2902 2903 2904 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2901 def describe_snapshots(params = {}, = {}) req = build_request(:describe_snapshots, params) req.send_request() end |
#describe_trusts(params = {}) ⇒ Types::DescribeTrustsResult
Obtains information about the trust relationships for this account.
If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2997 2998 2999 3000 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2997 def describe_trusts(params = {}, = {}) req = build_request(:describe_trusts, params) req.send_request() end |
#describe_update_directory(params = {}) ⇒ Types::DescribeUpdateDirectoryResult
Describes the updates of a directory for a particular update type.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3050 3051 3052 3053 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3050 def describe_update_directory(params = {}, = {}) req = build_request(:describe_update_directory, params) req.send_request() end |
#disable_ca_enrollment_policy(params = {}) ⇒ Struct
Disables the certificate authority (CA) enrollment policy for the specified directory. This stops automatic certificate enrollment and management for domain-joined clients, but does not affect existing certificates.
Disabling the CA enrollment policy prevents new certificates from being automatically enrolled, but existing certificates remain valid and functional until they expire.
3080 3081 3082 3083 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3080 def disable_ca_enrollment_policy(params = {}, = {}) req = build_request(:disable_ca_enrollment_policy, params) req.send_request() end |
#disable_client_authentication(params = {}) ⇒ Struct
Disables alternative client authentication methods for the specified directory.
3108 3109 3110 3111 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3108 def disable_client_authentication(params = {}, = {}) req = build_request(:disable_client_authentication, params) req.send_request() end |
#disable_directory_data_access(params = {}) ⇒ Struct
Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
3136 3137 3138 3139 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3136 def disable_directory_data_access(params = {}, = {}) req = build_request(:disable_directory_data_access, params) req.send_request() end |
#disable_ldaps(params = {}) ⇒ Struct
Deactivates LDAP secure calls for the specified directory.
3163 3164 3165 3166 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3163 def disable_ldaps(params = {}, = {}) req = build_request(:disable_ldaps, params) req.send_request() end |
#disable_radius(params = {}) ⇒ Struct
Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
3201 3202 3203 3204 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3201 def disable_radius(params = {}, = {}) req = build_request(:disable_radius, params) req.send_request() end |
#disable_sso(params = {}) ⇒ Struct
Disables single-sign on for a directory.
3256 3257 3258 3259 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3256 def disable_sso(params = {}, = {}) req = build_request(:disable_sso, params) req.send_request() end |
#enable_ca_enrollment_policy(params = {}) ⇒ Struct
Enables certificate authority (CA) enrollment policy for the specified directory. This allows domain-joined clients to automatically request and receive certificates from the specified Amazon Web Services Private Certificate Authority.
3298 3299 3300 3301 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3298 def enable_ca_enrollment_policy(params = {}, = {}) req = build_request(:enable_ca_enrollment_policy, params) req.send_request() end |
#enable_client_authentication(params = {}) ⇒ Struct
Enables alternative client authentication methods for the specified directory.
3328 3329 3330 3331 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3328 def enable_client_authentication(params = {}, = {}) req = build_request(:enable_client_authentication, params) req.send_request() end |
#enable_directory_data_access(params = {}) ⇒ Struct
Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3356 def enable_directory_data_access(params = {}, = {}) req = build_request(:enable_directory_data_access, params) req.send_request() end |
#enable_ldaps(params = {}) ⇒ Struct
Activates the switch for the specific directory to always use LDAP secure calls.
3384 3385 3386 3387 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3384 def enable_ldaps(params = {}, = {}) req = build_request(:enable_ldaps, params) req.send_request() end |
#enable_radius(params = {}) ⇒ Struct
Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.
3449 3450 3451 3452 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3449 def enable_radius(params = {}, = {}) req = build_request(:enable_radius, params) req.send_request() end |
#enable_sso(params = {}) ⇒ Struct
Enables single sign-on for a directory. Single sign-on allows users in your directory to access certain Amazon Web Services services from a computer joined to the directory without having to enter their credentials separately.
3507 3508 3509 3510 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3507 def enable_sso(params = {}, = {}) req = build_request(:enable_sso, params) req.send_request() end |
#get_directory_limits(params = {}) ⇒ Types::GetDirectoryLimitsResult
Obtains directory limit information for the current Region.
3557 3558 3559 3560 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3557 def get_directory_limits(params = {}, = {}) req = build_request(:get_directory_limits, params) req.send_request() end |
#get_snapshot_limits(params = {}) ⇒ Types::GetSnapshotLimitsResult
Obtains the manual snapshot limits for a directory.
3605 3606 3607 3608 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3605 def get_snapshot_limits(params = {}, = {}) req = build_request(:get_snapshot_limits, params) req.send_request() end |
#list_ad_assessments(params = {}) ⇒ Types::ListADAssessmentsResult
Retrieves a list of directory assessments for the specified directory or all assessments in your account. Use this operation to monitor assessment status and manage multiple assessments.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3658 3659 3660 3661 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3658 def list_ad_assessments(params = {}, = {}) req = build_request(:list_ad_assessments, params) req.send_request() end |
#list_certificates(params = {}) ⇒ Types::ListCertificatesResult
For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3707 3708 3709 3710 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3707 def list_certificates(params = {}, = {}) req = build_request(:list_certificates, params) req.send_request() end |
#list_ip_routes(params = {}) ⇒ Types::ListIpRoutesResult
Lists the address blocks that you have added to a directory.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3780 3781 3782 3783 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3780 def list_ip_routes(params = {}, = {}) req = build_request(:list_ip_routes, params) req.send_request() end |
#list_log_subscriptions(params = {}) ⇒ Types::ListLogSubscriptionsResult
Lists the active log subscriptions for the Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3828 3829 3830 3831 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3828 def list_log_subscriptions(params = {}, = {}) req = build_request(:list_log_subscriptions, params) req.send_request() end |
#list_schema_extensions(params = {}) ⇒ Types::ListSchemaExtensionsResult
Lists all schema extensions applied to a Microsoft AD Directory.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3902 3903 3904 3905 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3902 def list_schema_extensions(params = {}, = {}) req = build_request(:list_schema_extensions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Lists all tags on a directory.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3964 3965 3966 3967 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3964 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#register_certificate(params = {}) ⇒ Types::RegisterCertificateResult
Registers a certificate for a secure LDAP or client certificate authentication.
4010 4011 4012 4013 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4010 def register_certificate(params = {}, = {}) req = build_request(:register_certificate, params) req.send_request() end |
#register_event_topic(params = {}) ⇒ Struct
Associates a directory with an Amazon SNS topic. This establishes the directory as a publisher to the specified Amazon SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.
4058 4059 4060 4061 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4058 def register_event_topic(params = {}, = {}) req = build_request(:register_event_topic, params) req.send_request() end |
#reject_shared_directory(params = {}) ⇒ Types::RejectSharedDirectoryResult
Rejects a directory sharing request that was sent from the directory owner account.
4088 4089 4090 4091 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4088 def reject_shared_directory(params = {}, = {}) req = build_request(:reject_shared_directory, params) req.send_request() end |
#remove_ip_routes(params = {}) ⇒ Struct
Removes IP address blocks from a directory.
4135 4136 4137 4138 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4135 def remove_ip_routes(params = {}, = {}) req = build_request(:remove_ip_routes, params) req.send_request() end |
#remove_region(params = {}) ⇒ Struct
Stops all replication and removes the domain controllers from the
specified Region. You cannot remove the primary Region with this
operation. Instead, use the DeleteDirectory API.
4160 4161 4162 4163 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4160 def remove_region(params = {}, = {}) req = build_request(:remove_region, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes tags from a directory.
4202 4203 4204 4205 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4202 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#reset_user_password(params = {}) ⇒ Struct
Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.
You can reset the password for any user in your directory with the following exceptions:
For Simple AD, you cannot reset the password for any user that is a member of either the Domain Admins or Enterprise Admins group except for the administrator user.
For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the Amazon Web Services Reserved OU. For more information about the OU structure for an Managed Microsoft AD directory, see What Gets Created in the Directory Service Administration Guide.
4254 4255 4256 4257 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4254 def reset_user_password(params = {}, = {}) req = build_request(:reset_user_password, params) req.send_request() end |
#restore_from_snapshot(params = {}) ⇒ Struct
Restores a directory using an existing directory snapshot.
When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.
This action returns as soon as the restore operation is initiated. You
can monitor the progress of the restore operation by calling the
DescribeDirectories operation with the directory identifier. When the
DirectoryDescription.Stage value changes to Active, the restore
operation is complete.
4298 4299 4300 4301 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4298 def restore_from_snapshot(params = {}, = {}) req = build_request(:restore_from_snapshot, params) req.send_request() end |
#share_directory(params = {}) ⇒ Types::ShareDirectoryResult
Shares a specified directory (DirectoryId) in your Amazon Web
Services account (directory owner) with another Amazon Web Services
account (directory consumer). With this operation you can use your
directory from any Amazon Web Services account and from any Amazon VPC
within an Amazon Web Services Region.
When you share your Managed Microsoft AD directory, Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.
The ShareMethod parameter determines whether the specified directory
can be shared between Amazon Web Services accounts inside the same
Amazon Web Services organization (ORGANIZATIONS). It also determines
whether you can share the directory with any other Amazon Web Services
account either inside or outside of the organization (HANDSHAKE).
The ShareNotes parameter is only used when HANDSHAKE is called,
which sends a directory sharing request to the directory consumer.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4368 def share_directory(params = {}, = {}) req = build_request(:share_directory, params) req.send_request() end |
#start_ad_assessment(params = {}) ⇒ Types::StartADAssessmentResult
Initiates a directory assessment to validate your self-managed AD environment for hybrid domain join. The assessment checks compatibility and connectivity of the self-managed AD environment.
A directory assessment is automatically created when you create a
hybrid directory. There are two types of assessments: CUSTOMER and
SYSTEM. Your Amazon Web Services account has a limit of 100
CUSTOMER directory assessments.
The assessment process typically takes 30 minutes or more to complete.
The assessment process is asynchronous and you can monitor it with
DescribeADAssessment.
The InstanceIds must have a one-to-one correspondence with
CustomerDnsIps, meaning that if the IP address for instance
i-10243410 is 10.24.34.100 and the IP address for instance i-10243420
is 10.24.34.200, then the input arrays must maintain the same order
relationship, either [10.24.34.100, 10.24.34.200] paired with
[i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired
with [i-10243420, i-10243410].
Note: You must provide exactly one DirectoryId or
AssessmentConfiguration.
4435 4436 4437 4438 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4435 def start_ad_assessment(params = {}, = {}) req = build_request(:start_ad_assessment, params) req.send_request() end |
#start_schema_extension(params = {}) ⇒ Types::StartSchemaExtensionResult
Applies a schema extension to a Microsoft AD directory.
4497 4498 4499 4500 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4497 def start_schema_extension(params = {}, = {}) req = build_request(:start_schema_extension, params) req.send_request() end |
#unshare_directory(params = {}) ⇒ Types::UnshareDirectoryResult
Stops the directory sharing between the directory owner and consumer accounts.
4535 4536 4537 4538 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4535 def unshare_directory(params = {}, = {}) req = build_request(:unshare_directory, params) req.send_request() end |
#update_conditional_forwarder(params = {}) ⇒ Struct
Updates a conditional forwarder that has been set up for your Amazon Web Services directory.
4591 4592 4593 4594 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4591 def update_conditional_forwarder(params = {}, = {}) req = build_request(:update_conditional_forwarder, params) req.send_request() end |
#update_directory_setup(params = {}) ⇒ Struct
Updates directory configuration for the specified update type.
4642 4643 4644 4645 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4642 def update_directory_setup(params = {}, = {}) req = build_request(:update_directory_setup, params) req.send_request() end |
#update_hybrid_ad(params = {}) ⇒ Types::UpdateHybridADResult
Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings.
Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes.
The InstanceIds must have a one-to-one correspondence with
CustomerDnsIps, meaning that if the IP address for instance
i-10243410 is 10.24.34.100 and the IP address for instance i-10243420
is 10.24.34.200, then the input arrays must maintain the same order
relationship, either [10.24.34.100, 10.24.34.200] paired with
[i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired
with [i-10243420, i-10243410].
4718 4719 4720 4721 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4718 def update_hybrid_ad(params = {}, = {}) req = build_request(:update_hybrid_ad, params) req.send_request() end |
#update_number_of_domain_controllers(params = {}) ⇒ Struct
Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.
4750 4751 4752 4753 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4750 def update_number_of_domain_controllers(params = {}, = {}) req = build_request(:update_number_of_domain_controllers, params) req.send_request() end |
#update_radius(params = {}) ⇒ Struct
Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.
4815 4816 4817 4818 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4815 def update_radius(params = {}, = {}) req = build_request(:update_radius, params) req.send_request() end |
#update_settings(params = {}) ⇒ Types::UpdateSettingsResult
Updates the configurable settings for the specified directory.
4852 4853 4854 4855 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4852 def update_settings(params = {}, = {}) req = build_request(:update_settings, params) req.send_request() end |
#update_trust(params = {}) ⇒ Types::UpdateTrustResult
Updates the trust that has been set up between your Managed Microsoft AD directory and an self-managed Active Directory.
4887 4888 4889 4890 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4887 def update_trust(params = {}, = {}) req = build_request(:update_trust, params) req.send_request() end |
#verify_trust(params = {}) ⇒ Types::VerifyTrustResult
Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your Managed Microsoft AD directory and an external domain.
4933 4934 4935 4936 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 4933 def verify_trust(params = {}, = {}) req = build_request(:verify_trust, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay and :max_attempts values.
| waiter_name | params | :delay | :max_attempts |
|---|---|---|---|
| hybrid_ad_updated | #describe_hybrid_ad_update | 120 | 60 |
5048 5049 5050 5051 5052 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 5048 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |