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 on-premises 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 an on-premises 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 AWS 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 AWS account.
-
#create_microsoft_ad(params = {}) ⇒ Types::CreateMicrosoftADResult
Creates a Microsoft AD directory in the AWS Cloud.
-
#create_snapshot(params = {}) ⇒ Types::CreateSnapshotResult
Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.
-
#create_trust(params = {}) ⇒ Types::CreateTrustResult
AWS 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 AWS directory.
-
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResult
Deletes an AWS 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 AWS 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 SNS topic.
-
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResult
Displays information about the certificate registered for secure LDAP or client certificate authentication.
-
#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 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_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.
-
#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 AWS 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 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 AWS 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 AWS account (directory owner) with another AWS 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 AWS 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_trust(params = {}) ⇒ Types::UpdateTrustResult
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
-
#verify_trust(params = {}) ⇒ Types::VerifyTrustResult
AWS 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.
334 335 336 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 334 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.
373 374 375 376 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 373 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 on-premises 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 AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
476 477 478 479 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 476 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.
513 514 515 516 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 513 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.
546 547 548 549 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 546 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
.
577 578 579 580 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 577 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 an on-premises 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 AWS Directory Service API Permissions: Actions,
Resources, and Conditions Reference.
651 652 653 654 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 651 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.
694 695 696 697 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 694 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.
753 754 755 756 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 753 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 AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.
789 790 791 792 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 789 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 AWS 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 AWS Directory Service API Permissions: Actions,
Resources, and Conditions Reference.
898 899 900 901 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 898 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 AWS account.
928 929 930 931 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 928 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 AWS Cloud. For more information, see AWS Managed Microsoft AD in the AWS 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 AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.
1012 1013 1014 1015 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1012 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 AWS cloud.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1049 def create_snapshot(params = {}, = {}) req = build_request(:create_snapshot, params) req.send_request() end |
#create_trust(params = {}) ⇒ Types::CreateTrustResult
AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises 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 AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1115 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 AWS directory.
1143 1144 1145 1146 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1143 def delete_conditional_forwarder(params = {}, = {}) req = build_request(:delete_conditional_forwarder, params) req.send_request() end |
#delete_directory(params = {}) ⇒ Types::DeleteDirectoryResult
Deletes an AWS 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 AWS Directory Service API Permissions: Actions,
Resources, and Conditions Reference.
1181 1182 1183 1184 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1181 def delete_directory(params = {}, = {}) req = build_request(:delete_directory, params) req.send_request() end |
#delete_log_subscription(params = {}) ⇒ Struct
Deletes the specified log subscription.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1203 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.
1231 1232 1233 1234 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1231 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 AWS Managed Microsoft AD directory and an external domain.
1264 1265 1266 1267 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1264 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.
1291 1292 1293 1294 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1291 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 SNS topic.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1320 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1360 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1403 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.
1529 1530 1531 1532 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1529 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.
1586 1587 1588 1589 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1586 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 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.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1633 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1679 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1730 def describe_regions(params = {}, = {}) req = build_request(:describe_regions, params) req.send_request() end |
#describe_shared_directories(params = {}) ⇒ Types::DescribeSharedDirectoriesResult
Returns the shared directories in your account.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1784 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.
1845 1846 1847 1848 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1845 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.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1908 def describe_trusts(params = {}, = {}) req = build_request(:describe_trusts, params) req.send_request() end |
#disable_client_authentication(params = {}) ⇒ Struct
Disables alternative client authentication methods for the specified directory.
1936 1937 1938 1939 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1936 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.
1963 1964 1965 1966 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1963 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.
1987 1988 1989 1990 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1987 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.
2027 2028 2029 2030 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2027 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.
2057 2058 2059 2060 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2057 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.
2085 2086 2087 2088 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2085 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.
2123 2124 2125 2126 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2123 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 AWS services from a computer joined to the directory without having to enter their credentials separately.
2165 2166 2167 2168 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2165 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.
2192 2193 2194 2195 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2192 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.
2222 2223 2224 2225 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2222 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.
2269 2270 2271 2272 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2269 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.
2316 2317 2318 2319 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2316 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 AWS account.
2361 2362 2363 2364 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2361 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.
2408 2409 2410 2411 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2408 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.
2448 2449 2450 2451 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2448 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.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2494 def register_certificate(params = {}, = {}) req = build_request(:register_certificate, params) req.send_request() end |
#register_event_topic(params = {}) ⇒ Struct
Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified 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.
2527 2528 2529 2530 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2527 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.
2557 2558 2559 2560 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2557 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.
2584 2585 2586 2587 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2584 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.
2609 2610 2611 2612 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2609 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.
2635 2636 2637 2638 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2635 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 AWS 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 AWS 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 AWS Reserved OU. For more information about the OU structure for an AWS Managed Microsoft AD directory, see What Gets Created in the AWS Directory Service Administration Guide.
2686 2687 2688 2689 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2686 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.
2717 2718 2719 2720 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2717 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 AWS account
(directory owner) with another AWS account (directory consumer). With
this operation you can use your directory from any AWS account and
from any Amazon VPC within an AWS Region.
When you share your AWS Managed Microsoft AD directory, AWS 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 AWS accounts inside the same AWS organization
(ORGANIZATIONS
). It also determines whether you can share the
directory with any other AWS 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.
2786 2787 2788 2789 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2786 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.
2831 2832 2833 2834 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2831 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.
2869 2870 2871 2872 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2869 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 AWS directory.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2903 def update_conditional_forwarder(params = {}, = {}) req = build_request(:update_conditional_forwarder, 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.
2935 2936 2937 2938 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2935 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.
2973 2974 2975 2976 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2973 def update_radius(params = {}, = {}) req = build_request(:update_radius, params) req.send_request() end |
#update_trust(params = {}) ⇒ Types::UpdateTrustResult
Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.
3008 3009 3010 3011 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3008 def update_trust(params = {}, = {}) req = build_request(:update_trust, params) req.send_request() end |
#verify_trust(params = {}) ⇒ Types::VerifyTrustResult
AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.
This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.
3040 3041 3042 3043 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3040 def verify_trust(params = {}, = {}) req = build_request(:verify_trust, params) req.send_request() end |