Class: Aws::DirectoryServiceData::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb

Overview

An API client for DirectoryServiceData. To construct a client, you need to configure a :region and :credentials.

client = Aws::DirectoryServiceData::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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See Aws::DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::DirectoryServiceData::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::DirectoryServiceData::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#add_group_member(params = {}) ⇒ Struct

Adds an existing user, group, or computer as a group member.

Examples:

Request syntax with placeholder values


resp = client.add_group_member({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  group_name: "GroupName", # required
  member_name: "MemberName", # required
  member_realm: "Realm",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :group_name (required, String) —

    The name of the group.

  • :member_name (required, String) —

    The SAMAccountName of the user, group, or computer to add as a group member.

  • :member_realm (String) —

    The domain name that's associated with the group member. This parameter is required only when adding a member outside of your Managed Microsoft AD domain to a group inside of your Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain.

    This parameter is case insensitive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



545
546
547
548
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 545

def add_group_member(params = {}, options = {})
  req = build_request(:add_group_member, params)
  req.send_request(options)
end

#create_group(params = {}) ⇒ Types::CreateGroupResult

Creates a new group.

Examples:

Request syntax with placeholder values


resp = client.create_group({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  group_scope: "DomainLocal", # accepts DomainLocal, Global, Universal, BuiltinLocal
  group_type: "Distribution", # accepts Distribution, Security
  other_attributes: {
    "LdapDisplayName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  sam_account_name: "GroupName", # required
})

Response structure


resp.directory_id #=> String
resp. #=> String
resp.sid #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :group_scope (String) —

    The scope of the AD group. For details, see Active Directory security group scope.

  • :group_type (String) —

    The AD group type. For details, see Active Directory security group type.

  • :other_attributes (Hash<String,Types::AttributeValue>) —

    An expression that defines one or more attributes with the data type and value of each attribute.

  • :sam_account_name (required, String) —

    The name of the group.

Returns:

See Also:



629
630
631
632
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 629

def create_group(params = {}, options = {})
  req = build_request(:create_group, params)
  req.send_request(options)
end

#create_user(params = {}) ⇒ Types::CreateUserResult

Creates a new user.

Examples:

Request syntax with placeholder values


resp = client.create_user({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  email_address: "EmailAddress",
  given_name: "GivenName",
  other_attributes: {
    "LdapDisplayName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  sam_account_name: "UserName", # required
  surname: "Surname",
})

Response structure


resp.directory_id #=> String
resp. #=> String
resp.sid #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that’s associated with the user.

  • :email_address (String) —

    The email address of the user.

  • :given_name (String) —

    The first name of the user.

  • :other_attributes (Hash<String,Types::AttributeValue>) —

    An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

    Attribute names are case insensitive.

  • :sam_account_name (required, String) —

    The name of the user.

  • :surname (String) —

    The last name of the user.

Returns:

See Also:



716
717
718
719
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 716

def create_user(params = {}, options = {})
  req = build_request(:create_user, params)
  req.send_request(options)
end

#delete_group(params = {}) ⇒ Struct

Deletes a group.

Examples:

Request syntax with placeholder values


resp = client.delete_group({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  sam_account_name: "GroupName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :sam_account_name (required, String) —

    The name of the group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



765
766
767
768
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 765

def delete_group(params = {}, options = {})
  req = build_request(:delete_group, params)
  req.send_request(options)
end

#delete_user(params = {}) ⇒ Struct

Deletes a user.

Examples:

Request syntax with placeholder values


resp = client.delete_user({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  sam_account_name: "UserName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :sam_account_name (required, String) —

    The name of the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



813
814
815
816
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 813

def delete_user(params = {}, options = {})
  req = build_request(:delete_user, params)
  req.send_request(options)
end

#describe_group(params = {}) ⇒ Types::DescribeGroupResult

Returns information about a specific group.

Examples:

Request syntax with placeholder values


resp = client.describe_group({
  directory_id: "DirectoryId", # required
  other_attributes: ["LdapDisplayName"],
  realm: "Realm",
  sam_account_name: "GroupName", # required
})

Response structure


resp.directory_id #=> String
resp.distinguished_name #=> String
resp.group_scope #=> String, one of "DomainLocal", "Global", "Universal", "BuiltinLocal"
resp.group_type #=> String, one of "Distribution", "Security"
resp.other_attributes #=> Hash
resp.other_attributes["LdapDisplayName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.realm #=> String
resp. #=> String
resp.sid #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The Identifier (ID) of the directory associated with the group.

  • :other_attributes (Array<String>) —

    One or more attributes to be returned for the group. For a list of supported attributes, see Directory Service Data Attributes.

  • :realm (String) —

    The domain name that's associated with the group.

    This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

    This value is case insensitive.

  • :sam_account_name (required, String) —

    The name of the group.

Returns:

See Also:



881
882
883
884
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 881

def describe_group(params = {}, options = {})
  req = build_request(:describe_group, params)
  req.send_request(options)
end

#describe_user(params = {}) ⇒ Types::DescribeUserResult

Returns information about a specific user.

Examples:

Request syntax with placeholder values


resp = client.describe_user({
  directory_id: "DirectoryId", # required
  other_attributes: ["LdapDisplayName"],
  realm: "Realm",
  sam_account_name: "UserName", # required
})

Response structure


resp.directory_id #=> String
resp.distinguished_name #=> String
resp.email_address #=> String
resp.enabled #=> Boolean
resp.given_name #=> String
resp.other_attributes #=> Hash
resp.other_attributes["LdapDisplayName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.realm #=> String
resp. #=> String
resp.sid #=> String
resp.surname #=> String
resp.user_principal_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :other_attributes (Array<String>) —

    One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

  • :realm (String) —

    The domain name that's associated with the user.

    This parameter is optional, so you can return users outside your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

    This value is case insensitive.

  • :sam_account_name (required, String) —

    The name of the user.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 956

def describe_user(params = {}, options = {})
  req = build_request(:describe_user, params)
  req.send_request(options)
end

#disable_user(params = {}) ⇒ Struct

Deactivates an active user account. For information about how to enable an inactive user account, see ResetUserPassword in the Directory Service API Reference.

Examples:

Request syntax with placeholder values


resp = client.disable_user({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  sam_account_name: "UserName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :sam_account_name (required, String) —

    The name of the user.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1010
1011
1012
1013
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1010

def disable_user(params = {}, options = {})
  req = build_request(:disable_user, params)
  req.send_request(options)
end

#list_group_members(params = {}) ⇒ Types::ListGroupMembersResult

Returns member information for the specified group.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupMembers.NextToken member contains a token that you pass in the next call to ListGroupMembers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_group_members({
  directory_id: "DirectoryId", # required
  max_results: 1,
  member_realm: "Realm",
  next_token: "NextToken",
  realm: "Realm",
  sam_account_name: "GroupName", # required
})

Response structure


resp.directory_id #=> String
resp.member_realm #=> String
resp.members #=> Array
resp.members[0].member_type #=> String, one of "USER", "GROUP", "COMPUTER"
resp.members[0]. #=> String
resp.members[0].sid #=> String
resp.next_token #=> String
resp.realm #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :member_realm (String) —

    The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain.

    This parameter is optional and case insensitive.

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name that's associated with the group.

    This parameter is optional, so you can return members from a group outside of your Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are returned.

    This value is case insensitive.

  • :sam_account_name (required, String) —

    The name of the group.

Returns:

See Also:



1095
1096
1097
1098
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1095

def list_group_members(params = {}, options = {})
  req = build_request(:list_group_members, params)
  req.send_request(options)
end

#list_groups(params = {}) ⇒ Types::ListGroupsResult

Returns group information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroups.NextToken member contains a token that you pass in the next call to ListGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups({
  directory_id: "DirectoryId", # required
  max_results: 1,
  next_token: "NextToken",
  realm: "Realm",
})

Response structure


resp.directory_id #=> String
resp.groups #=> Array
resp.groups[0].group_scope #=> String, one of "DomainLocal", "Global", "Universal", "BuiltinLocal"
resp.groups[0].group_type #=> String, one of "Distribution", "Security"
resp.groups[0]. #=> String
resp.groups[0].sid #=> String
resp.next_token #=> String
resp.realm #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name associated with the directory.

    This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

    This value is case insensitive.

Returns:

See Also:



1165
1166
1167
1168
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1165

def list_groups(params = {}, options = {})
  req = build_request(:list_groups, params)
  req.send_request(options)
end

#list_groups_for_member(params = {}) ⇒ Types::ListGroupsForMemberResult

Returns group information for the specified member.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroupsForMember.NextToken member contains a token that you pass in the next call to ListGroupsForMember. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_groups_for_member({
  directory_id: "DirectoryId", # required
  max_results: 1,
  member_realm: "Realm",
  next_token: "NextToken",
  realm: "Realm",
  sam_account_name: "MemberName", # required
})

Response structure


resp.directory_id #=> String
resp.groups #=> Array
resp.groups[0].group_scope #=> String, one of "DomainLocal", "Global", "Universal", "BuiltinLocal"
resp.groups[0].group_type #=> String, one of "Distribution", "Security"
resp.groups[0]. #=> String
resp.groups[0].sid #=> String
resp.member_realm #=> String
resp.next_token #=> String
resp.realm #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the member.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :member_realm (String) —

    The domain name that's associated with the group member.

    This parameter is optional, so you can limit your results to the group members in a specific domain.

    This parameter is case insensitive and defaults to Realm

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name that's associated with the group.

    This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

    This value is case insensitive and defaults to your Managed Microsoft AD domain.

  • :sam_account_name (required, String) —

    The SAMAccountName of the user, group, or computer that's a member of the group.

Returns:

See Also:



1255
1256
1257
1258
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1255

def list_groups_for_member(params = {}, options = {})
  req = build_request(:list_groups_for_member, params)
  req.send_request(options)
end

#list_users(params = {}) ⇒ Types::ListUsersResult

Returns user information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListUsers.NextToken member contains a token that you pass in the next call to ListUsers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_users({
  directory_id: "DirectoryId", # required
  max_results: 1,
  next_token: "NextToken",
  realm: "Realm",
})

Response structure


resp.directory_id #=> String
resp.next_token #=> String
resp.realm #=> String
resp.users #=> Array
resp.users[0].enabled #=> Boolean
resp.users[0].given_name #=> String
resp.users[0]. #=> String
resp.users[0].sid #=> String
resp.users[0].surname #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name that's associated with the user.

    This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

    This value is case insensitive.

Returns:

See Also:



1325
1326
1327
1328
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1325

def list_users(params = {}, options = {})
  req = build_request(:list_users, params)
  req.send_request(options)
end

#remove_group_member(params = {}) ⇒ Struct

Removes a member from a group.

Examples:

Request syntax with placeholder values


resp = client.remove_group_member({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  group_name: "GroupName", # required
  member_name: "MemberName", # required
  member_realm: "Realm",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the member.

  • :group_name (required, String) —

    The name of the group.

  • :member_name (required, String) —

    The SAMAccountName of the user, group, or computer to remove from the group.

  • :member_realm (String) —

    The domain name that's associated with the group member. This parameter defaults to the Managed Microsoft AD domain.

    This parameter is optional and case insensitive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1388
1389
1390
1391
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1388

def remove_group_member(params = {}, options = {})
  req = build_request(:remove_group_member, params)
  req.send_request(options)
end

#search_groups(params = {}) ⇒ Types::SearchGroupsResult

Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchGroups.NextToken member contains a token that you pass in the next call to SearchGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_groups({
  directory_id: "DirectoryId", # required
  max_results: 1,
  next_token: "NextToken",
  realm: "Realm",
  search_attributes: ["LdapDisplayName"], # required
  search_string: "SearchString", # required
})

Response structure


resp.directory_id #=> String
resp.groups #=> Array
resp.groups[0].distinguished_name #=> String
resp.groups[0].group_scope #=> String, one of "DomainLocal", "Global", "Universal", "BuiltinLocal"
resp.groups[0].group_type #=> String, one of "Distribution", "Security"
resp.groups[0].other_attributes #=> Hash
resp.groups[0].other_attributes["LdapDisplayName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.groups[0]. #=> String
resp.groups[0].sid #=> String
resp.next_token #=> String
resp.realm #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name that's associated with the group.

    This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

    This value is case insensitive.

  • :search_attributes (required, Array<String>) —

    One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.

  • :search_string (required, String) —

    The attribute value that you want to search for.

    Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.

Returns:

See Also:



1486
1487
1488
1489
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1486

def search_groups(params = {}, options = {})
  req = build_request(:search_groups, params)
  req.send_request(options)
end

#search_users(params = {}) ⇒ Types::SearchUsersResult

Searches the specified directory for a user. You can find users that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchUsers.NextToken member contains a token that you pass in the next call to SearchUsers. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_users({
  directory_id: "DirectoryId", # required
  max_results: 1,
  next_token: "NextToken",
  realm: "Realm",
  search_attributes: ["LdapDisplayName"], # required
  search_string: "SearchString", # required
})

Response structure


resp.directory_id #=> String
resp.next_token #=> String
resp.realm #=> String
resp.users #=> Array
resp.users[0].distinguished_name #=> String
resp.users[0].email_address #=> String
resp.users[0].enabled #=> Boolean
resp.users[0].given_name #=> String
resp.users[0].other_attributes #=> Hash
resp.users[0].other_attributes["LdapDisplayName"] #=> <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
resp.users[0]. #=> String
resp.users[0].sid #=> String
resp.users[0].surname #=> String
resp.users[0].user_principal_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :max_results (Integer) —

    The maximum number of results to be returned per request.

  • :next_token (String) —

    An encoded paging token for paginated calls that can be passed back to retrieve the next page.

  • :realm (String) —

    The domain name that's associated with the user.

    This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned.

    This value is case insensitive.

  • :search_attributes (required, Array<String>) —

    One or more data attributes that are used to search for a user. For a list of supported attributes, see Directory Service Data Attributes.

  • :search_string (required, String) —

    The attribute value that you want to search for.

    Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.

Returns:

See Also:



1586
1587
1588
1589
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1586

def search_users(params = {}, options = {})
  req = build_request(:search_users, params)
  req.send_request(options)
end

#update_group(params = {}) ⇒ Struct

Updates group information.

Examples:

Request syntax with placeholder values


resp = client.update_group({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  group_scope: "DomainLocal", # accepts DomainLocal, Global, Universal, BuiltinLocal
  group_type: "Distribution", # accepts Distribution, Security
  other_attributes: {
    "LdapDisplayName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  sam_account_name: "GroupName", # required
  update_type: "ADD", # accepts ADD, REPLACE, REMOVE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the group.

  • :group_scope (String) —

    The scope of the AD group. For details, see Active Directory security groups.

  • :group_type (String) —

    The AD group type. For details, see Active Directory security group type.

  • :other_attributes (Hash<String,Types::AttributeValue>) —

    An expression that defines one or more attributes with the data type and the value of each attribute.

  • :sam_account_name (required, String) —

    The name of the group.

  • :update_type (String) —

    The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1666
1667
1668
1669
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1666

def update_group(params = {}, options = {})
  req = build_request(:update_group, params)
  req.send_request(options)
end

#update_user(params = {}) ⇒ Struct

Updates user information.

Examples:

Request syntax with placeholder values


resp = client.update_user({
  client_token: "ClientToken",
  directory_id: "DirectoryId", # required
  email_address: "EmailAddress",
  given_name: "GivenName",
  other_attributes: {
    "LdapDisplayName" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  },
  sam_account_name: "UserName", # required
  surname: "Surname",
  update_type: "ADD", # accepts ADD, REPLACE, REMOVE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

    A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

    If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ConflictException.

    This parameter is optional when using the CLI or SDK.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :directory_id (required, String) —

    The identifier (ID) of the directory that's associated with the user.

  • :email_address (String) —

    The email address of the user.

  • :given_name (String) —

    The first name of the user.

  • :other_attributes (Hash<String,Types::AttributeValue>) —

    An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see Directory Service Data Attributes.

    Attribute names are case insensitive.

  • :sam_account_name (required, String) —

    The name of the user.

  • :surname (String) —

    The last name of the user.

  • :update_type (String) —

    The type of update to be performed. If no value exists for the attribute, use ADD. Otherwise, use REPLACE to change an attribute value or REMOVE to clear the attribute value.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1749
1750
1751
1752
 
# File 'gems/aws-sdk-directoryservicedata/lib/aws-sdk-directoryservicedata/client.rb', line 1749

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end