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_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_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_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_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_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_client_authentication(params = {}) ⇒ Struct
Disables alternative client authentication methods 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_client_authentication(params = {}) ⇒ Struct
Enables alternative client authentication methods 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_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_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 the directory for a particular update type.
-
#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.
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.
429 430 431 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 429 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.
468 469 470 471 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 468 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.
572 573 574 575 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 572 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.
609 610 611 612 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 609 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.
642 643 644 645 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 642 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
.
673 674 675 676 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 673 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.
747 748 749 750 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 747 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.
790 791 792 793 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 790 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.
849 850 851 852 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 849 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.
885 886 887 888 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 885 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.
994 995 996 997 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 994 def create_directory(params = {}, = {}) req = build_request(:create_directory, 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.
1024 1025 1026 1027 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1024 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.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1109 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.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1146 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.
1212 1213 1214 1215 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1212 def create_trust(params = {}, = {}) req = build_request(:create_trust, 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.
1240 1241 1242 1243 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1240 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1278 def delete_directory(params = {}, = {}) req = build_request(:delete_directory, params) req.send_request() end |
#delete_log_subscription(params = {}) ⇒ Struct
Deletes the specified log subscription.
1300 1301 1302 1303 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1300 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.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1328 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.
1361 1362 1363 1364 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1361 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.
1388 1389 1390 1391 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1388 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.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1417 def deregister_event_topic(params = {}, = {}) req = build_request(:deregister_event_topic, params) req.send_request() end |
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResult
Displays information about the certificate registered for secure LDAP or client certificate authentication.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1457 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.
1514 1515 1516 1517 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1514 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1557 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.
1686 1687 1688 1689 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1686 def describe_directories(params = {}, = {}) req = build_request(:describe_directories, 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.
1743 1744 1745 1746 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1743 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.
1790 1791 1792 1793 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1790 def describe_event_topics(params = {}, = {}) req = build_request(:describe_event_topics, 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.
1838 1839 1840 1841 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1838 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.
1891 1892 1893 1894 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1891 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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1946 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.
2002 2003 2004 2005 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2002 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.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2065 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.
2130 2131 2132 2133 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2130 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.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2183 def describe_update_directory(params = {}, = {}) req = build_request(:describe_update_directory, params) req.send_request() end |
#disable_client_authentication(params = {}) ⇒ Struct
Disables alternative client authentication methods for the specified directory.
2211 2212 2213 2214 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2211 def disable_client_authentication(params = {}, = {}) req = build_request(:disable_client_authentication, params) req.send_request() end |
#disable_ldaps(params = {}) ⇒ Struct
Deactivates LDAP secure calls for the specified directory.
2238 2239 2240 2241 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2238 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.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2262 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.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2302 def disable_sso(params = {}, = {}) req = build_request(:disable_sso, params) req.send_request() end |
#enable_client_authentication(params = {}) ⇒ Struct
Enables alternative client authentication methods for the specified directory.
2332 2333 2334 2335 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2332 def enable_client_authentication(params = {}, = {}) req = build_request(:enable_client_authentication, params) req.send_request() end |
#enable_ldaps(params = {}) ⇒ Struct
Activates the switch for the specific directory to always use LDAP secure calls.
2360 2361 2362 2363 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2360 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.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2398 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.
2441 2442 2443 2444 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2441 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.
2468 2469 2470 2471 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2468 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.
2498 2499 2500 2501 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2498 def get_snapshot_limits(params = {}, = {}) req = build_request(:get_snapshot_limits, 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.
2547 2548 2549 2550 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2547 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.
2596 2597 2598 2599 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2596 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.
2644 2645 2646 2647 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2644 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.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2693 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.
2735 2736 2737 2738 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2735 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.
2781 2782 2783 2784 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2781 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.
2815 2816 2817 2818 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2815 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.
2845 2846 2847 2848 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2845 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.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2872 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.
2897 2898 2899 2900 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2897 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.
2923 2924 2925 2926 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2923 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.
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.
2974 2975 2976 2977 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2974 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.
3005 3006 3007 3008 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3005 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.
3075 3076 3077 3078 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3075 def share_directory(params = {}, = {}) req = build_request(:share_directory, params) req.send_request() end |
#start_schema_extension(params = {}) ⇒ Types::StartSchemaExtensionResult
Applies a schema extension to a Microsoft AD directory.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3120 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.
3158 3159 3160 3161 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3158 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.
3192 3193 3194 3195 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3192 def update_conditional_forwarder(params = {}, = {}) req = build_request(:update_conditional_forwarder, params) req.send_request() end |
#update_directory_setup(params = {}) ⇒ Struct
Updates the directory for a particular update type.
3232 3233 3234 3235 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3232 def update_directory_setup(params = {}, = {}) req = build_request(:update_directory_setup, 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.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3264 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.
3302 3303 3304 3305 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3302 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.
3339 3340 3341 3342 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3339 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.
3374 3375 3376 3377 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3374 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.
3406 3407 3408 3409 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3406 def verify_trust(params = {}, = {}) req = build_request(:verify_trust, params) req.send_request() end |