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_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 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_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 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.
358 359 360 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 358 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.
397 398 399 400 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 397 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.
501 502 503 504 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 501 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.
538 539 540 541 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 538 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.
571 572 573 574 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 571 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
.
602 603 604 605 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 602 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.
676 677 678 679 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 676 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.
719 720 721 722 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 719 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.
778 779 780 781 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 778 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.
814 815 816 817 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 814 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.
923 924 925 926 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 923 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.
953 954 955 956 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 953 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.
1038 1039 1040 1041 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1038 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.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1075 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.
1141 1142 1143 1144 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1141 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.
1169 1170 1171 1172 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1169 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.
1207 1208 1209 1210 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1207 def delete_directory(params = {}, = {}) req = build_request(:delete_directory, params) req.send_request() end |
#delete_log_subscription(params = {}) ⇒ Struct
Deletes the specified log subscription.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1229 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.
1257 1258 1259 1260 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1257 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.
1290 1291 1292 1293 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1290 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.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1317 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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1346 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.
1386 1387 1388 1389 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1386 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.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1441 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1484 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.
1610 1611 1612 1613 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1610 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.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1667 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.
1714 1715 1716 1717 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1714 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.
1760 1761 1762 1763 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1760 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.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1811 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.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1865 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.
1926 1927 1928 1929 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1926 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.
1989 1990 1991 1992 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 1989 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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2017 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.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2044 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.
2068 2069 2070 2071 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2068 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.
2108 2109 2110 2111 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2108 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.
2138 2139 2140 2141 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2138 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.
2166 2167 2168 2169 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2166 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.
2204 2205 2206 2207 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2204 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.
2247 2248 2249 2250 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2247 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.
2274 2275 2276 2277 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2274 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.
2304 2305 2306 2307 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2304 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.
2351 2352 2353 2354 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2351 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.
2398 2399 2400 2401 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2398 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.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2444 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.
2491 2492 2493 2494 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2491 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.
2531 2532 2533 2534 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2531 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.
2577 2578 2579 2580 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2577 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.
2611 2612 2613 2614 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2611 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.
2641 2642 2643 2644 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2641 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.
2668 2669 2670 2671 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2668 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.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2693 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.
2719 2720 2721 2722 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2719 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.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2770 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.
2801 2802 2803 2804 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2801 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.
2871 2872 2873 2874 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2871 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.
2916 2917 2918 2919 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2916 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.
2954 2955 2956 2957 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2954 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.
2988 2989 2990 2991 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 2988 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.
3020 3021 3022 3023 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3020 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.
3058 3059 3060 3061 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3058 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 Managed Microsoft AD directory and an self-managed Active Directory.
3093 3094 3095 3096 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3093 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.
3125 3126 3127 3128 |
# File 'gems/aws-sdk-directoryservice/lib/aws-sdk-directoryservice/client.rb', line 3125 def verify_trust(params = {}, = {}) req = build_request(:verify_trust, params) req.send_request() end |