# frozen_string_literal: true

# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

require 'seahorse/client/plugins/content_length'
require 'aws-sdk-core/plugins/credentials_configuration'
require 'aws-sdk-core/plugins/logging'
require 'aws-sdk-core/plugins/param_converter'
require 'aws-sdk-core/plugins/param_validator'
require 'aws-sdk-core/plugins/user_agent'
require 'aws-sdk-core/plugins/helpful_socket_errors'
require 'aws-sdk-core/plugins/retry_errors'
require 'aws-sdk-core/plugins/global_configuration'
require 'aws-sdk-core/plugins/regional_endpoint'
require 'aws-sdk-core/plugins/endpoint_discovery'
require 'aws-sdk-core/plugins/endpoint_pattern'
require 'aws-sdk-core/plugins/response_paging'
require 'aws-sdk-core/plugins/stub_responses'
require 'aws-sdk-core/plugins/idempotency_token'
require 'aws-sdk-core/plugins/invocation_id'
require 'aws-sdk-core/plugins/jsonvalue_converter'
require 'aws-sdk-core/plugins/client_metrics_plugin'
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
require 'aws-sdk-core/plugins/transfer_encoding'
require 'aws-sdk-core/plugins/http_checksum'
require 'aws-sdk-core/plugins/checksum_algorithm'
require 'aws-sdk-core/plugins/request_compression'
require 'aws-sdk-core/plugins/defaults_mode'
require 'aws-sdk-core/plugins/recursion_detection'
require 'aws-sdk-core/plugins/telemetry'
require 'aws-sdk-core/plugins/sign'
require 'aws-sdk-core/plugins/protocols/json_rpc'

module Aws::WorkMail
  # An API client for WorkMail.  To construct a client, you need to configure a `:region` and `:credentials`.
  #
  #     client = Aws::WorkMail::Client.new(
  #       region: region_name,
  #       credentials: credentials,
  #       # ...
  #     )
  #
  # For details on configuring region and credentials see
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
  #
  # See {#initialize} for a full list of supported configuration options.
  class Client < Seahorse::Client::Base

    include Aws::ClientStubs

    @identifier = :workmail

    set_api(ClientApi::API)

    add_plugin(Seahorse::Client::Plugins::ContentLength)
    add_plugin(Aws::Plugins::CredentialsConfiguration)
    add_plugin(Aws::Plugins::Logging)
    add_plugin(Aws::Plugins::ParamConverter)
    add_plugin(Aws::Plugins::ParamValidator)
    add_plugin(Aws::Plugins::UserAgent)
    add_plugin(Aws::Plugins::HelpfulSocketErrors)
    add_plugin(Aws::Plugins::RetryErrors)
    add_plugin(Aws::Plugins::GlobalConfiguration)
    add_plugin(Aws::Plugins::RegionalEndpoint)
    add_plugin(Aws::Plugins::EndpointDiscovery)
    add_plugin(Aws::Plugins::EndpointPattern)
    add_plugin(Aws::Plugins::ResponsePaging)
    add_plugin(Aws::Plugins::StubResponses)
    add_plugin(Aws::Plugins::IdempotencyToken)
    add_plugin(Aws::Plugins::InvocationId)
    add_plugin(Aws::Plugins::JsonvalueConverter)
    add_plugin(Aws::Plugins::ClientMetricsPlugin)
    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
    add_plugin(Aws::Plugins::TransferEncoding)
    add_plugin(Aws::Plugins::HttpChecksum)
    add_plugin(Aws::Plugins::ChecksumAlgorithm)
    add_plugin(Aws::Plugins::RequestCompression)
    add_plugin(Aws::Plugins::DefaultsMode)
    add_plugin(Aws::Plugins::RecursionDetection)
    add_plugin(Aws::Plugins::Telemetry)
    add_plugin(Aws::Plugins::Sign)
    add_plugin(Aws::Plugins::Protocols::JsonRpc)
    add_plugin(Aws::WorkMail::Plugins::Endpoints)

    # @overload initialize(options)
    #   @param [Hash] options
    #
    #   @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
    #     A list of plugins to apply to the client. Each plugin is either a
    #     class name or an instance of a plugin class.
    #
    #   @option options [required, Aws::CredentialProvider] :credentials
    #     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`.
    #
    #   @option options [required, String] :region
    #     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`
    #
    #   @option options [String] :access_key_id
    #
    #   @option options [String] :account_id
    #
    #   @option options [Boolean] :active_endpoint_cache (false)
    #     When set to `true`, a thread polling for endpoints will be running in
    #     the background every 60 secs (default). Defaults to `false`.
    #
    #   @option options [Boolean] :adaptive_retry_wait_to_fill (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.
    #
    #   @option options [Array<String>] :auth_scheme_preference
    #     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.
    #
    #   @option options [Boolean] :client_side_monitoring (false)
    #     When `true`, client-side metrics will be collected for all API requests from
    #     this client.
    #
    #   @option options [String] :client_side_monitoring_client_id ("")
    #     Allows you to provide an identifier for this client which will be attached to
    #     all generated client side metrics. Defaults to an empty string.
    #
    #   @option options [String] :client_side_monitoring_host ("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.
    #
    #   @option options [Integer] :client_side_monitoring_port (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.
    #
    #   @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
    #     Allows you to provide a custom client-side monitoring publisher class. By default,
    #     will use the Client Side Monitoring Agent Publisher.
    #
    #   @option options [Boolean] :convert_params (true)
    #     When `true`, an attempt is made to coerce request parameters into
    #     the required types.
    #
    #   @option options [Boolean] :correct_clock_skew (true)
    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
    #     a clock skew correction and retry requests with skewed client clocks.
    #
    #   @option options [String] :defaults_mode ("legacy")
    #     See {Aws::DefaultsModeConfiguration} for a list of the
    #     accepted modes and the configuration defaults that are included.
    #
    #   @option options [Boolean] :disable_host_prefix_injection (false)
    #     When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
    #
    #   @option options [Boolean] :disable_request_compression (false)
    #     When set to 'true' the request body will not be compressed
    #     for supported operations.
    #
    #   @option options [String, URI::HTTPS, URI::HTTP] :endpoint
    #     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'
    #
    #   @option options [Integer] :endpoint_cache_max_entries (1000)
    #     Used for the maximum size limit of the LRU cache storing endpoints data
    #     for endpoint discovery enabled operations. Defaults to 1000.
    #
    #   @option options [Integer] :endpoint_cache_max_threads (10)
    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
    #
    #   @option options [Integer] :endpoint_cache_poll_interval (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.
    #
    #   @option options [Boolean] :endpoint_discovery (false)
    #     When set to `true`, endpoint discovery will be enabled for operations when available.
    #
    #   @option options [Boolean] :ignore_configured_endpoint_urls
    #     Setting to true disables use of endpoint URLs provided via environment
    #     variables and the shared configuration file.
    #
    #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
    #     The log formatter.
    #
    #   @option options [Symbol] :log_level (:info)
    #     The log level to send messages to the `:logger` at.
    #
    #   @option options [Logger] :logger
    #     The Logger instance to send log messages to.  If this option
    #     is not set, logging will be disabled.
    #
    #   @option options [Integer] :max_attempts (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.
    #
    #   @option options [String] :profile ("default")
    #     Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
    #     When not specified, 'default' is used.
    #
    #   @option options [String] :request_checksum_calculation ("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.
    #
    #   @option options [Integer] :request_min_compression_size_bytes (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.
    #
    #   @option options [String] :response_checksum_validation ("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`.
    #
    #   @option options [Proc] :retry_backoff
    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
    #     This option is only used in the `legacy` retry mode.
    #
    #   @option options [Float] :retry_base_delay (0.3)
    #     The base delay in seconds used by the default backoff function. This option
    #     is only used in the `legacy` retry mode.
    #
    #   @option options [Symbol] :retry_jitter (: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
    #
    #   @option options [Integer] :retry_limit (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.
    #
    #   @option options [Integer] :retry_max_delay (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.
    #
    #   @option options [String] :retry_mode ("legacy")
    #     Specifies which retry algorithm to use. Values are:
    #
    #     * `legacy` - The pre-existing retry behavior.  This is 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` - An experimental retry mode that includes all the
    #       functionality of `standard` mode along with automatic client side
    #       throttling.  This is a provisional mode that may change behavior
    #       in the future.
    #
    #   @option options [String] :sdk_ua_app_id
    #     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.
    #
    #   @option options [String] :secret_access_key
    #
    #   @option options [String] :session_token
    #
    #   @option options [Array] :sigv4a_signing_region_set
    #     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`
    #
    #   @option options [Boolean] :simple_json (false)
    #     Disables request parameter conversion, validation, and formatting.
    #     Also disables response data type conversions. The request parameters
    #     hash must be formatted exactly as the API expects.This option is useful
    #     when you want to ensure the highest level of performance by avoiding
    #     overhead of walking request parameters and response data structures.
    #
    #   @option options [Boolean] :stub_responses (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.
    #
    #   @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (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.
    #
    #   @option options [Aws::TokenProvider] :token_provider
    #     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.
    #
    #   @option options [Boolean] :use_dualstack_endpoint
    #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
    #     will be used if available.
    #
    #   @option options [Boolean] :use_fips_endpoint
    #     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`.
    #
    #   @option options [Boolean] :validate_params (true)
    #     When `true`, request parameters are validated before
    #     sending the request.
    #
    #   @option options [Aws::WorkMail::EndpointProvider] :endpoint_provider
    #     The endpoint provider used to resolve endpoints. Any object that responds to
    #     `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
    #     `Aws::WorkMail::EndpointParameters`.
    #
    #   @option options [Float] :http_continue_timeout (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.
    #
    #   @option options [Float] :http_idle_timeout (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.
    #
    #   @option options [Float] :http_open_timeout (15)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [URI::HTTP,String] :http_proxy
    #     A proxy to send requests through.  Formatted like 'http://proxy.com:123'.
    #
    #   @option options [Float] :http_read_timeout (60)
    #     The default number of seconds to wait for response data.
    #     This value can safely be set per-request on the session.
    #
    #   @option options [Boolean] :http_wire_trace (false)
    #     When `true`,  HTTP debug output will be sent to the `:logger`.
    #
    #   @option options [Proc] :on_chunk_received
    #     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`).
    #
    #   @option options [Proc] :on_chunk_sent
    #     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.
    #
    #   @option options [Boolean] :raise_response_errors (true)
    #     When `true`, response errors are raised.
    #
    #   @option options [String] :ssl_ca_bundle
    #     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.
    #
    #   @option options [String] :ssl_ca_directory
    #     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.
    #
    #   @option options [String] :ssl_ca_store
    #     Sets the X509::Store to verify peer certificate.
    #
    #   @option options [OpenSSL::X509::Certificate] :ssl_cert
    #     Sets a client certificate when creating http connections.
    #
    #   @option options [OpenSSL::PKey] :ssl_key
    #     Sets a client key when creating http connections.
    #
    #   @option options [Float] :ssl_timeout
    #     Sets the SSL timeout in seconds
    #
    #   @option options [Boolean] :ssl_verify_peer (true)
    #     When `true`, SSL peer certificates are verified when establishing a connection.
    #
    def initialize(*args)
      super
    end

    # @!group API Operations

    # Adds a member (user or group) to the resource's set of delegates.
    #
    # @option params [required, String] :organization_id
    #   The organization under which the resource exists.
    #
    # @option params [required, String] :resource_id
    #   The resource for which members (users or groups) are associated.
    #
    #   The identifier can accept *ResourceId*, *Resourcename*, or *email*.
    #   The following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Email address: resource@domain.tld
    #
    #   * Resource name: resource
    #
    # @option params [required, String] :entity_id
    #   The member (user or group) to associate to the resource.
    #
    #   The entity ID can accept *UserId or GroupID*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Entity: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity: entity
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.associate_delegate_to_resource({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #     entity_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateDelegateToResource AWS API Documentation
    #
    # @overload associate_delegate_to_resource(params = {})
    # @param [Hash] params ({})
    def associate_delegate_to_resource(params = {}, options = {})
      req = build_request(:associate_delegate_to_resource, params)
      req.send_request(options)
    end

    # Adds a member (user or group) to the group's set.
    #
    # @option params [required, String] :organization_id
    #   The organization under which the group exists.
    #
    # @option params [required, String] :group_id
    #   The group to which the member (user or group) is associated.
    #
    #   The identifier can accept *GroupId*, *Groupname*, or *email*. The
    #   following identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: group@domain.tld
    #
    #   * Group name: group
    #
    # @option params [required, String] :member_id
    #   The member (user or group) to associate to the group.
    #
    #   The member ID can accept *UserID or GroupId*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Member: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: member@domain.tld
    #
    #   * Member name: member
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.associate_member_to_group({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #     member_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssociateMemberToGroup AWS API Documentation
    #
    # @overload associate_member_to_group(params = {})
    # @param [Hash] params ({})
    def associate_member_to_group(params = {}, options = {})
      req = build_request(:associate_member_to_group, params)
      req.send_request(options)
    end

    # Assumes an impersonation role for the given WorkMail organization.
    # This method returns an authentication token you can use to make
    # impersonated calls.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which the impersonation role will be
    #   assumed.
    #
    # @option params [required, String] :impersonation_role_id
    #   The impersonation role ID to assume.
    #
    # @return [Types::AssumeImpersonationRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::AssumeImpersonationRoleResponse#token #token} => String
    #   * {Types::AssumeImpersonationRoleResponse#expires_in #expires_in} => Integer
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.assume_impersonation_role({
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_id: "ImpersonationRoleId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.token #=> String
    #   resp.expires_in #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/AssumeImpersonationRole AWS API Documentation
    #
    # @overload assume_impersonation_role(params = {})
    # @param [Hash] params ({})
    def assume_impersonation_role(params = {}, options = {})
      req = build_request(:assume_impersonation_role, params)
      req.send_request(options)
    end

    # Cancels a mailbox export job.
    #
    # <note markdown="1"> If the mailbox export job is near completion, it might not be possible
    # to cancel it.
    #
    #  </note>
    #
    # @option params [required, String] :client_token
    #   The idempotency token for the client request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :job_id
    #   The job ID.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.cancel_mailbox_export_job({
    #     client_token: "IdempotencyClientToken", # required
    #     job_id: "MailboxExportJobId", # required
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CancelMailboxExportJob AWS API Documentation
    #
    # @overload cancel_mailbox_export_job(params = {})
    # @param [Hash] params ({})
    def cancel_mailbox_export_job(params = {}, options = {})
      req = build_request(:cancel_mailbox_export_job, params)
      req.send_request(options)
    end

    # Adds an alias to the set of a given member (user or group) of
    # WorkMail.
    #
    # @option params [required, String] :organization_id
    #   The organization under which the member (user or group) exists.
    #
    # @option params [required, String] :entity_id
    #   The member (user or group) to which this alias is added.
    #
    # @option params [required, String] :alias
    #   The alias to add to the member set.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_alias({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "WorkMailIdentifier", # required
    #     alias: "EmailAddress", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAlias AWS API Documentation
    #
    # @overload create_alias(params = {})
    # @param [Hash] params ({})
    def create_alias(params = {}, options = {})
      req = build_request(:create_alias, params)
      req.send_request(options)
    end

    # Creates an `AvailabilityConfiguration` for the given WorkMail
    # organization and domain.
    #
    # @option params [String] :client_token
    #   An idempotent token that ensures that an API request is executed only
    #   once.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the `AvailabilityConfiguration`
    #   will be created.
    #
    # @option params [required, String] :domain_name
    #   The domain to which the provider applies.
    #
    # @option params [Types::EwsAvailabilityProvider] :ews_provider
    #   Exchange Web Services (EWS) availability provider definition. The
    #   request must contain exactly one provider definition, either
    #   `EwsProvider` or `LambdaProvider`.
    #
    # @option params [Types::LambdaAvailabilityProvider] :lambda_provider
    #   Lambda availability provider definition. The request must contain
    #   exactly one provider definition, either `EwsProvider` or
    #   `LambdaProvider`.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_availability_configuration({
    #     client_token: "IdempotencyClientToken",
    #     organization_id: "OrganizationId", # required
    #     domain_name: "DomainName", # required
    #     ews_provider: {
    #       ews_endpoint: "Url", # required
    #       ews_username: "ExternalUserName", # required
    #       ews_password: "Password", # required
    #     },
    #     lambda_provider: {
    #       lambda_arn: "LambdaArn", # required
    #     },
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateAvailabilityConfiguration AWS API Documentation
    #
    # @overload create_availability_configuration(params = {})
    # @param [Hash] params ({})
    def create_availability_configuration(params = {}, options = {})
      req = build_request(:create_availability_configuration, params)
      req.send_request(options)
    end

    # Creates a group that can be used in WorkMail by calling the
    # RegisterToWorkMail operation.
    #
    # @option params [required, String] :organization_id
    #   The organization under which the group is to be created.
    #
    # @option params [required, String] :name
    #   The name of the group.
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If this parameter is enabled, the group will be hidden from the
    #   address book.
    #
    # @return [Types::CreateGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateGroupResponse#group_id #group_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_group({
    #     organization_id: "OrganizationId", # required
    #     name: "GroupName", # required
    #     hidden_from_global_address_list: false,
    #   })
    #
    # @example Response structure
    #
    #   resp.group_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateGroup AWS API Documentation
    #
    # @overload create_group(params = {})
    # @param [Hash] params ({})
    def create_group(params = {}, options = {})
      req = build_request(:create_group, params)
      req.send_request(options)
    end

    # Creates the WorkMail application in IAM Identity Center that can be
    # used later in the WorkMail - IdC integration. For more information,
    # see PutIdentityProviderConfiguration. This action does not affect the
    # authentication settings for any WorkMail organizations.
    #
    # @option params [required, String] :name
    #   The name of the IAM Identity Center application.
    #
    # @option params [required, String] :instance_arn
    #   The Amazon Resource Name (ARN) of the instance.
    #
    # @option params [String] :client_token
    #   The idempotency token associated with the request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @return [Types::CreateIdentityCenterApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateIdentityCenterApplicationResponse#application_arn #application_arn} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_identity_center_application({
    #     name: "IdentityCenterApplicationName", # required
    #     instance_arn: "InstanceArn", # required
    #     client_token: "IdempotencyClientToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.application_arn #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateIdentityCenterApplication AWS API Documentation
    #
    # @overload create_identity_center_application(params = {})
    # @param [Hash] params ({})
    def create_identity_center_application(params = {}, options = {})
      req = build_request(:create_identity_center_application, params)
      req.send_request(options)
    end

    # Creates an impersonation role for the given WorkMail organization.
    #
    # *Idempotency* ensures that an API request completes no more than one
    # time. With an idempotent request, if the original request completes
    # successfully, any subsequent retries also complete successfully
    # without performing any further actions.
    #
    # @option params [String] :client_token
    #   The idempotency token for the client request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization to create the new impersonation role within.
    #
    # @option params [required, String] :name
    #   The name of the new impersonation role.
    #
    # @option params [required, String] :type
    #   The impersonation role's type. The available impersonation role types
    #   are `READ_ONLY` or `FULL_ACCESS`.
    #
    # @option params [String] :description
    #   The description of the new impersonation role.
    #
    # @option params [required, Array<Types::ImpersonationRule>] :rules
    #   The list of rules for the impersonation role.
    #
    # @return [Types::CreateImpersonationRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateImpersonationRoleResponse#impersonation_role_id #impersonation_role_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_impersonation_role({
    #     client_token: "IdempotencyClientToken",
    #     organization_id: "OrganizationId", # required
    #     name: "ImpersonationRoleName", # required
    #     type: "FULL_ACCESS", # required, accepts FULL_ACCESS, READ_ONLY
    #     description: "ImpersonationRoleDescription",
    #     rules: [ # required
    #       {
    #         impersonation_rule_id: "ImpersonationRuleId", # required
    #         name: "ImpersonationRuleName",
    #         description: "ImpersonationRuleDescription",
    #         effect: "ALLOW", # required, accepts ALLOW, DENY
    #         target_users: ["EntityIdentifier"],
    #         not_target_users: ["EntityIdentifier"],
    #       },
    #     ],
    #   })
    #
    # @example Response structure
    #
    #   resp.impersonation_role_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateImpersonationRole AWS API Documentation
    #
    # @overload create_impersonation_role(params = {})
    # @param [Hash] params ({})
    def create_impersonation_role(params = {}, options = {})
      req = build_request(:create_impersonation_role, params)
      req.send_request(options)
    end

    # Creates a new mobile device access rule for the specified WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which the rule will be created.
    #
    # @option params [String] :client_token
    #   The idempotency token for the client request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :name
    #   The rule name.
    #
    # @option params [String] :description
    #   The rule description.
    #
    # @option params [required, String] :effect
    #   The effect of the rule when it matches. Allowed values are `ALLOW` or
    #   `DENY`.
    #
    # @option params [Array<String>] :device_types
    #   Device types that the rule will match.
    #
    # @option params [Array<String>] :not_device_types
    #   Device types that the rule **will not** match. All other device types
    #   will match.
    #
    # @option params [Array<String>] :device_models
    #   Device models that the rule will match.
    #
    # @option params [Array<String>] :not_device_models
    #   Device models that the rule **will not** match. All other device
    #   models will match.
    #
    # @option params [Array<String>] :device_operating_systems
    #   Device operating systems that the rule will match.
    #
    # @option params [Array<String>] :not_device_operating_systems
    #   Device operating systems that the rule **will not** match. All other
    #   device operating systems will match.
    #
    # @option params [Array<String>] :device_user_agents
    #   Device user agents that the rule will match.
    #
    # @option params [Array<String>] :not_device_user_agents
    #   Device user agents that the rule **will not** match. All other device
    #   user agents will match.
    #
    # @return [Types::CreateMobileDeviceAccessRuleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateMobileDeviceAccessRuleResponse#mobile_device_access_rule_id #mobile_device_access_rule_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_mobile_device_access_rule({
    #     organization_id: "OrganizationId", # required
    #     client_token: "IdempotencyClientToken",
    #     name: "MobileDeviceAccessRuleName", # required
    #     description: "MobileDeviceAccessRuleDescription",
    #     effect: "ALLOW", # required, accepts ALLOW, DENY
    #     device_types: ["DeviceType"],
    #     not_device_types: ["DeviceType"],
    #     device_models: ["DeviceModel"],
    #     not_device_models: ["DeviceModel"],
    #     device_operating_systems: ["DeviceOperatingSystem"],
    #     not_device_operating_systems: ["DeviceOperatingSystem"],
    #     device_user_agents: ["DeviceUserAgent"],
    #     not_device_user_agents: ["DeviceUserAgent"],
    #   })
    #
    # @example Response structure
    #
    #   resp.mobile_device_access_rule_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateMobileDeviceAccessRule AWS API Documentation
    #
    # @overload create_mobile_device_access_rule(params = {})
    # @param [Hash] params ({})
    def create_mobile_device_access_rule(params = {}, options = {})
      req = build_request(:create_mobile_device_access_rule, params)
      req.send_request(options)
    end

    # Creates a new WorkMail organization. Optionally, you can choose to
    # associate an existing AWS Directory Service directory with your
    # organization. If an AWS Directory Service directory ID is specified,
    # the organization alias must match the directory alias. If you choose
    # not to associate an existing directory with your organization, then we
    # create a new WorkMail directory for you. For more information, see
    # [Adding an organization][1] in the *WorkMail Administrator Guide*.
    #
    # You can associate multiple email domains with an organization, then
    # choose your default email domain from the WorkMail console. You can
    # also associate a domain that is managed in an Amazon Route 53 public
    # hosted zone. For more information, see [Adding a domain][2] and
    # [Choosing the default domain][3] in the *WorkMail Administrator
    # Guide*.
    #
    # Optionally, you can use a customer managed key from AWS Key Management
    # Service (AWS KMS) to encrypt email for your organization. If you
    # don't associate an AWS KMS key, WorkMail creates a default, AWS
    # managed key for you.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_new_organization.html
    # [2]: https://docs.aws.amazon.com/workmail/latest/adminguide/add_domain.html
    # [3]: https://docs.aws.amazon.com/workmail/latest/adminguide/default_domain.html
    #
    # @option params [String] :directory_id
    #   The AWS Directory Service directory ID.
    #
    # @option params [required, String] :alias
    #   The organization alias.
    #
    # @option params [String] :client_token
    #   The idempotency token associated with the request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [Array<Types::Domain>] :domains
    #   The email domains to associate with the organization.
    #
    # @option params [String] :kms_key_arn
    #   The Amazon Resource Name (ARN) of a customer managed key from AWS KMS.
    #
    # @option params [Boolean] :enable_interoperability
    #   When `true`, allows organization interoperability between WorkMail and
    #   Microsoft Exchange. If `true`, you must include a AD Connector
    #   directory ID in the request.
    #
    # @return [Types::CreateOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateOrganizationResponse#organization_id #organization_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_organization({
    #     directory_id: "DirectoryId",
    #     alias: "OrganizationName", # required
    #     client_token: "IdempotencyClientToken",
    #     domains: [
    #       {
    #         domain_name: "DomainName", # required
    #         hosted_zone_id: "HostedZoneId",
    #       },
    #     ],
    #     kms_key_arn: "KmsKeyArn",
    #     enable_interoperability: false,
    #   })
    #
    # @example Response structure
    #
    #   resp.organization_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateOrganization AWS API Documentation
    #
    # @overload create_organization(params = {})
    # @param [Hash] params ({})
    def create_organization(params = {}, options = {})
      req = build_request(:create_organization, params)
      req.send_request(options)
    end

    # Creates a new WorkMail resource.
    #
    # @option params [required, String] :organization_id
    #   The identifier associated with the organization for which the resource
    #   is created.
    #
    # @option params [required, String] :name
    #   The name of the new resource.
    #
    # @option params [required, String] :type
    #   The type of the new resource. The available types are `equipment` and
    #   `room`.
    #
    # @option params [String] :description
    #   Resource description.
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If this parameter is enabled, the resource will be hidden from the
    #   address book.
    #
    # @return [Types::CreateResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateResourceResponse#resource_id #resource_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_resource({
    #     organization_id: "OrganizationId", # required
    #     name: "ResourceName", # required
    #     type: "ROOM", # required, accepts ROOM, EQUIPMENT
    #     description: "ResourceDescription",
    #     hidden_from_global_address_list: false,
    #   })
    #
    # @example Response structure
    #
    #   resp.resource_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateResource AWS API Documentation
    #
    # @overload create_resource(params = {})
    # @param [Hash] params ({})
    def create_resource(params = {}, options = {})
      req = build_request(:create_resource, params)
      req.send_request(options)
    end

    # Creates a user who can be used in WorkMail by calling the
    # RegisterToWorkMail operation.
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization for which the user is created.
    #
    # @option params [required, String] :name
    #   The name for the new user. WorkMail directory user names have a
    #   maximum length of 64. All others have a maximum length of 20.
    #
    # @option params [required, String] :display_name
    #   The display name for the new user.
    #
    # @option params [String] :password
    #   The password for the new user.
    #
    # @option params [String] :role
    #   The role of the new user.
    #
    #   You cannot pass *SYSTEM\_USER* or *RESOURCE* role in a single request.
    #   When a user role is not selected, the default role of *USER* is
    #   selected.
    #
    # @option params [String] :first_name
    #   The first name of the new user.
    #
    # @option params [String] :last_name
    #   The last name of the new user.
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If this parameter is enabled, the user will be hidden from the address
    #   book.
    #
    # @option params [String] :identity_provider_user_id
    #   User ID from the IAM Identity Center. If this parameter is empty it
    #   will be updated automatically when the user logs in for the first time
    #   to the mailbox associated with WorkMail.
    #
    # @return [Types::CreateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::CreateUserResponse#user_id #user_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.create_user({
    #     organization_id: "OrganizationId", # required
    #     name: "UserName", # required
    #     display_name: "UserAttribute", # required
    #     password: "Password",
    #     role: "USER", # accepts USER, RESOURCE, SYSTEM_USER, REMOTE_USER
    #     first_name: "UserAttribute",
    #     last_name: "UserAttribute",
    #     hidden_from_global_address_list: false,
    #     identity_provider_user_id: "IdentityProviderUserId",
    #   })
    #
    # @example Response structure
    #
    #   resp.user_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/CreateUser AWS API Documentation
    #
    # @overload create_user(params = {})
    # @param [Hash] params ({})
    def create_user(params = {}, options = {})
      req = build_request(:create_user, params)
      req.send_request(options)
    end

    # Deletes an access control rule for the specified WorkMail
    # organization.
    #
    # <note markdown="1"> Deleting already deleted and non-existing rules does not produce an
    # error. In those cases, the service sends back an HTTP 200 response
    # with an empty HTTP body.
    #
    #  </note>
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization.
    #
    # @option params [required, String] :name
    #   The name of the access control rule.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_access_control_rule({
    #     organization_id: "OrganizationId", # required
    #     name: "AccessControlRuleName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAccessControlRule AWS API Documentation
    #
    # @overload delete_access_control_rule(params = {})
    # @param [Hash] params ({})
    def delete_access_control_rule(params = {}, options = {})
      req = build_request(:delete_access_control_rule, params)
      req.send_request(options)
    end

    # Remove one or more specified aliases from a set of aliases for a given
    # user.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the user exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier for the member (user or group) from which to have the
    #   aliases removed.
    #
    # @option params [required, String] :alias
    #   The aliases to be removed from the user's set of aliases. Duplicate
    #   entries in the list are collapsed into single entries (the list is
    #   transformed into a set).
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_alias({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "WorkMailIdentifier", # required
    #     alias: "EmailAddress", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAlias AWS API Documentation
    #
    # @overload delete_alias(params = {})
    # @param [Hash] params ({})
    def delete_alias(params = {}, options = {})
      req = build_request(:delete_alias, params)
      req.send_request(options)
    end

    # Deletes the `AvailabilityConfiguration` for the given WorkMail
    # organization and domain.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the `AvailabilityConfiguration`
    #   will be deleted.
    #
    # @option params [required, String] :domain_name
    #   The domain for which the `AvailabilityConfiguration` will be deleted.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_availability_configuration({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "DomainName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteAvailabilityConfiguration AWS API Documentation
    #
    # @overload delete_availability_configuration(params = {})
    # @param [Hash] params ({})
    def delete_availability_configuration(params = {}, options = {})
      req = build_request(:delete_availability_configuration, params)
      req.send_request(options)
    end

    # Deletes the email monitoring configuration for a specified
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The ID of the organization from which the email monitoring
    #   configuration is deleted.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_email_monitoring_configuration({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteEmailMonitoringConfiguration AWS API Documentation
    #
    # @overload delete_email_monitoring_configuration(params = {})
    # @param [Hash] params ({})
    def delete_email_monitoring_configuration(params = {}, options = {})
      req = build_request(:delete_email_monitoring_configuration, params)
      req.send_request(options)
    end

    # Deletes a group from WorkMail.
    #
    # @option params [required, String] :organization_id
    #   The organization that contains the group.
    #
    # @option params [required, String] :group_id
    #   The identifier of the group to be deleted.
    #
    #   The identifier can be the *GroupId*, or *Groupname*. The following
    #   identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Group name: group
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_group({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteGroup AWS API Documentation
    #
    # @overload delete_group(params = {})
    # @param [Hash] params ({})
    def delete_group(params = {}, options = {})
      req = build_request(:delete_group, params)
      req.send_request(options)
    end

    # Deletes the IAM Identity Center application from WorkMail. This action
    # does not affect the authentication settings for any WorkMail
    # organizations.
    #
    # @option params [required, String] :application_arn
    #   The Amazon Resource Name (ARN) of the application.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_identity_center_application({
    #     application_arn: "ApplicationArn", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteIdentityCenterApplication AWS API Documentation
    #
    # @overload delete_identity_center_application(params = {})
    # @param [Hash] params ({})
    def delete_identity_center_application(params = {}, options = {})
      req = build_request(:delete_identity_center_application, params)
      req.send_request(options)
    end

    # Disables the integration between IdC and WorkMail. Authentication will
    # continue with the directory as it was before the IdC integration. You
    # might have to reset your directory passwords and reconfigure your
    # desktop and mobile email clients.
    #
    # @option params [required, String] :organization_id
    #   The Organization ID.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_identity_provider_configuration({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteIdentityProviderConfiguration AWS API Documentation
    #
    # @overload delete_identity_provider_configuration(params = {})
    # @param [Hash] params ({})
    def delete_identity_provider_configuration(params = {}, options = {})
      req = build_request(:delete_identity_provider_configuration, params)
      req.send_request(options)
    end

    # Deletes an impersonation role for the given WorkMail organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization from which to delete the impersonation role.
    #
    # @option params [required, String] :impersonation_role_id
    #   The ID of the impersonation role to delete.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_impersonation_role({
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_id: "ImpersonationRoleId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteImpersonationRole AWS API Documentation
    #
    # @overload delete_impersonation_role(params = {})
    # @param [Hash] params ({})
    def delete_impersonation_role(params = {}, options = {})
      req = build_request(:delete_impersonation_role, params)
      req.send_request(options)
    end

    # Deletes permissions granted to a member (user or group).
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization under which the member (user or
    #   group) exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier of the entity that owns the mailbox.
    #
    #   The identifier can be *UserId or Group Id*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [required, String] :grantee_id
    #   The identifier of the entity for which to delete granted permissions.
    #
    #   The identifier can be *UserId, ResourceID, or Group Id*, *Username or
    #   Groupname*, or *email*.
    #
    #   * Grantee ID:
    #     12345678-1234-1234-1234-123456789012,r-0123456789a0123456789b0123456789,
    #     or S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: grantee@domain.tld
    #
    #   * Grantee name: grantee
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_mailbox_permissions({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     grantee_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMailboxPermissions AWS API Documentation
    #
    # @overload delete_mailbox_permissions(params = {})
    # @param [Hash] params ({})
    def delete_mailbox_permissions(params = {}, options = {})
      req = build_request(:delete_mailbox_permissions, params)
      req.send_request(options)
    end

    # Deletes the mobile device access override for the given WorkMail
    # organization, user, and device.
    #
    # <note markdown="1"> Deleting already deleted and non-existing overrides does not produce
    # an error. In those cases, the service sends back an HTTP 200 response
    # with an empty HTTP body.
    #
    #  </note>
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the access override will be
    #   deleted.
    #
    # @option params [required, String] :user_id
    #   The WorkMail user for which you want to delete the override. Accepts
    #   the following types of user identities:
    #
    #   * User ID: `12345678-1234-1234-1234-123456789012` or
    #     `S-1-1-12-1234567890-123456789-123456789-1234`
    #
    #   * Email address: `user@domain.tld`
    #
    #   * User name: `user`
    #
    # @option params [required, String] :device_id
    #   The mobile device for which you delete the override. `DeviceId` is
    #   case insensitive.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_mobile_device_access_override({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #     device_id: "DeviceId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessOverride AWS API Documentation
    #
    # @overload delete_mobile_device_access_override(params = {})
    # @param [Hash] params ({})
    def delete_mobile_device_access_override(params = {}, options = {})
      req = build_request(:delete_mobile_device_access_override, params)
      req.send_request(options)
    end

    # Deletes a mobile device access rule for the specified WorkMail
    # organization.
    #
    # <note markdown="1"> Deleting already deleted and non-existing rules does not produce an
    # error. In those cases, the service sends back an HTTP 200 response
    # with an empty HTTP body.
    #
    #  </note>
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which the rule will be deleted.
    #
    # @option params [required, String] :mobile_device_access_rule_id
    #   The identifier of the rule to be deleted.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_mobile_device_access_rule({
    #     organization_id: "OrganizationId", # required
    #     mobile_device_access_rule_id: "MobileDeviceAccessRuleId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteMobileDeviceAccessRule AWS API Documentation
    #
    # @overload delete_mobile_device_access_rule(params = {})
    # @param [Hash] params ({})
    def delete_mobile_device_access_rule(params = {}, options = {})
      req = build_request(:delete_mobile_device_access_rule, params)
      req.send_request(options)
    end

    # Deletes an WorkMail organization and all underlying AWS resources
    # managed by WorkMail as part of the organization. You can choose
    # whether to delete the associated directory. For more information, see
    # [Removing an organization][1] in the *WorkMail Administrator Guide*.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/remove_organization.html
    #
    # @option params [String] :client_token
    #   The idempotency token associated with the request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @option params [required, Boolean] :delete_directory
    #   If true, deletes the AWS Directory Service directory associated with
    #   the organization.
    #
    # @option params [Boolean] :force_delete
    #   Deletes a WorkMail organization even if the organization has enabled
    #   users.
    #
    # @option params [Boolean] :delete_identity_center_application
    #   Deletes IAM Identity Center application for WorkMail. This action does
    #   not affect authentication settings for any organization.
    #
    # @return [Types::DeleteOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DeleteOrganizationResponse#organization_id #organization_id} => String
    #   * {Types::DeleteOrganizationResponse#state #state} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_organization({
    #     client_token: "IdempotencyClientToken",
    #     organization_id: "OrganizationId", # required
    #     delete_directory: false, # required
    #     force_delete: false,
    #     delete_identity_center_application: false,
    #   })
    #
    # @example Response structure
    #
    #   resp.organization_id #=> String
    #   resp.state #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteOrganization AWS API Documentation
    #
    # @overload delete_organization(params = {})
    # @param [Hash] params ({})
    def delete_organization(params = {}, options = {})
      req = build_request(:delete_organization, params)
      req.send_request(options)
    end

    # Deletes the Personal Access Token from the provided WorkMail
    # Organization.
    #
    # @option params [required, String] :organization_id
    #   The Organization ID.
    #
    # @option params [required, String] :personal_access_token_id
    #   The Personal Access Token ID.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_personal_access_token({
    #     organization_id: "OrganizationId", # required
    #     personal_access_token_id: "PersonalAccessTokenId", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeletePersonalAccessToken AWS API Documentation
    #
    # @overload delete_personal_access_token(params = {})
    # @param [Hash] params ({})
    def delete_personal_access_token(params = {}, options = {})
      req = build_request(:delete_personal_access_token, params)
      req.send_request(options)
    end

    # Deletes the specified resource.
    #
    # @option params [required, String] :organization_id
    #   The identifier associated with the organization from which the
    #   resource is deleted.
    #
    # @option params [required, String] :resource_id
    #   The identifier of the resource to be deleted.
    #
    #   The identifier can accept *ResourceId*, or *Resourcename*. The
    #   following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Resource name: resource
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_resource({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteResource AWS API Documentation
    #
    # @overload delete_resource(params = {})
    # @param [Hash] params ({})
    def delete_resource(params = {}, options = {})
      req = build_request(:delete_resource, params)
      req.send_request(options)
    end

    # Deletes the specified retention policy from the specified
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @option params [required, String] :id
    #   The retention policy ID.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_retention_policy({
    #     organization_id: "OrganizationId", # required
    #     id: "ShortString", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteRetentionPolicy AWS API Documentation
    #
    # @overload delete_retention_policy(params = {})
    # @param [Hash] params ({})
    def delete_retention_policy(params = {}, options = {})
      req = build_request(:delete_retention_policy, params)
      req.send_request(options)
    end

    # Deletes a user from WorkMail and all subsequent systems. Before you
    # can delete a user, the user state must be `DISABLED`. Use the
    # DescribeUser action to confirm the user state.
    #
    # Deleting a user is permanent and cannot be undone. WorkMail archives
    # user mailboxes for 30 days before they are permanently removed.
    #
    # @option params [required, String] :organization_id
    #   The organization that contains the user to be deleted.
    #
    # @option params [required, String] :user_id
    #   The identifier of the user to be deleted.
    #
    #   The identifier can be the *UserId* or *Username*. The following
    #   identity formats are available:
    #
    #   * User ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * User name: user
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.delete_user({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeleteUser AWS API Documentation
    #
    # @overload delete_user(params = {})
    # @param [Hash] params ({})
    def delete_user(params = {}, options = {})
      req = build_request(:delete_user, params)
      req.send_request(options)
    end

    # Mark a user, group, or resource as no longer used in WorkMail. This
    # action disassociates the mailbox and schedules it for clean-up.
    # WorkMail keeps mailboxes for 30 days before they are permanently
    # removed. The functionality in the console is *Disable*.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the WorkMail entity
    #   exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier for the member to be updated.
    #
    #   The identifier can be *UserId, ResourceId, or Group Id*, *Username,
    #   Resourcename, or Groupname*, or *email*.
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.deregister_from_work_mail({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterFromWorkMail AWS API Documentation
    #
    # @overload deregister_from_work_mail(params = {})
    # @param [Hash] params ({})
    def deregister_from_work_mail(params = {}, options = {})
      req = build_request(:deregister_from_work_mail, params)
      req.send_request(options)
    end

    # Removes a domain from WorkMail, stops email routing to WorkMail, and
    # removes the authorization allowing WorkMail use. SES keeps the domain
    # because other applications may use it. You must first remove any email
    # address used by WorkMail entities before you remove the domain.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the domain will be deregistered.
    #
    # @option params [required, String] :domain_name
    #   The domain to deregister in WorkMail and SES.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.deregister_mail_domain({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "WorkMailDomainName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DeregisterMailDomain AWS API Documentation
    #
    # @overload deregister_mail_domain(params = {})
    # @param [Hash] params ({})
    def deregister_mail_domain(params = {}, options = {})
      req = build_request(:deregister_mail_domain, params)
      req.send_request(options)
    end

    # Describes the current email monitoring configuration for a specified
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The ID of the organization for which the email monitoring
    #   configuration is described.
    #
    # @return [Types::DescribeEmailMonitoringConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeEmailMonitoringConfigurationResponse#role_arn #role_arn} => String
    #   * {Types::DescribeEmailMonitoringConfigurationResponse#log_group_arn #log_group_arn} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_email_monitoring_configuration({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.role_arn #=> String
    #   resp.log_group_arn #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeEmailMonitoringConfiguration AWS API Documentation
    #
    # @overload describe_email_monitoring_configuration(params = {})
    # @param [Hash] params ({})
    def describe_email_monitoring_configuration(params = {}, options = {})
      req = build_request(:describe_email_monitoring_configuration, params)
      req.send_request(options)
    end

    # Returns basic details about an entity in WorkMail.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the entity exists.
    #
    # @option params [required, String] :email
    #   The email under which the entity exists.
    #
    # @return [Types::DescribeEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeEntityResponse#entity_id #entity_id} => String
    #   * {Types::DescribeEntityResponse#name #name} => String
    #   * {Types::DescribeEntityResponse#type #type} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_entity({
    #     organization_id: "OrganizationId", # required
    #     email: "EmailAddress", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.entity_id #=> String
    #   resp.name #=> String
    #   resp.type #=> String, one of "GROUP", "USER", "RESOURCE"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeEntity AWS API Documentation
    #
    # @overload describe_entity(params = {})
    # @param [Hash] params ({})
    def describe_entity(params = {}, options = {})
      req = build_request(:describe_entity, params)
      req.send_request(options)
    end

    # Returns the data available for the group.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the group exists.
    #
    # @option params [required, String] :group_id
    #   The identifier for the group to be described.
    #
    #   The identifier can accept *GroupId*, *Groupname*, or *email*. The
    #   following identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: group@domain.tld
    #
    #   * Group name: group
    #
    # @return [Types::DescribeGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeGroupResponse#group_id #group_id} => String
    #   * {Types::DescribeGroupResponse#name #name} => String
    #   * {Types::DescribeGroupResponse#email #email} => String
    #   * {Types::DescribeGroupResponse#state #state} => String
    #   * {Types::DescribeGroupResponse#enabled_date #enabled_date} => Time
    #   * {Types::DescribeGroupResponse#disabled_date #disabled_date} => Time
    #   * {Types::DescribeGroupResponse#hidden_from_global_address_list #hidden_from_global_address_list} => Boolean
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_group({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.group_id #=> String
    #   resp.name #=> String
    #   resp.email #=> String
    #   resp.state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.enabled_date #=> Time
    #   resp.disabled_date #=> Time
    #   resp.hidden_from_global_address_list #=> Boolean
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeGroup AWS API Documentation
    #
    # @overload describe_group(params = {})
    # @param [Hash] params ({})
    def describe_group(params = {}, options = {})
      req = build_request(:describe_group, params)
      req.send_request(options)
    end

    # Returns detailed information on the current IdC setup for the WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The Organization ID.
    #
    # @return [Types::DescribeIdentityProviderConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeIdentityProviderConfigurationResponse#authentication_mode #authentication_mode} => String
    #   * {Types::DescribeIdentityProviderConfigurationResponse#identity_center_configuration #identity_center_configuration} => Types::IdentityCenterConfiguration
    #   * {Types::DescribeIdentityProviderConfigurationResponse#personal_access_token_configuration #personal_access_token_configuration} => Types::PersonalAccessTokenConfiguration
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_identity_provider_configuration({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.authentication_mode #=> String, one of "IDENTITY_PROVIDER_ONLY", "IDENTITY_PROVIDER_AND_DIRECTORY"
    #   resp.identity_center_configuration.instance_arn #=> String
    #   resp.identity_center_configuration.application_arn #=> String
    #   resp.personal_access_token_configuration.status #=> String, one of "ACTIVE", "INACTIVE"
    #   resp.personal_access_token_configuration.lifetime_in_days #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeIdentityProviderConfiguration AWS API Documentation
    #
    # @overload describe_identity_provider_configuration(params = {})
    # @param [Hash] params ({})
    def describe_identity_provider_configuration(params = {}, options = {})
      req = build_request(:describe_identity_provider_configuration, params)
      req.send_request(options)
    end

    # Lists the settings in a DMARC policy for a specified organization.
    #
    # @option params [required, String] :organization_id
    #   Lists the ID of the given organization.
    #
    # @return [Types::DescribeInboundDmarcSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeInboundDmarcSettingsResponse#enforced #enforced} => Boolean
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_inbound_dmarc_settings({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.enforced #=> Boolean
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeInboundDmarcSettings AWS API Documentation
    #
    # @overload describe_inbound_dmarc_settings(params = {})
    # @param [Hash] params ({})
    def describe_inbound_dmarc_settings(params = {}, options = {})
      req = build_request(:describe_inbound_dmarc_settings, params)
      req.send_request(options)
    end

    # Describes the current status of a mailbox export job.
    #
    # @option params [required, String] :job_id
    #   The mailbox export job ID.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @return [Types::DescribeMailboxExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeMailboxExportJobResponse#entity_id #entity_id} => String
    #   * {Types::DescribeMailboxExportJobResponse#description #description} => String
    #   * {Types::DescribeMailboxExportJobResponse#role_arn #role_arn} => String
    #   * {Types::DescribeMailboxExportJobResponse#kms_key_arn #kms_key_arn} => String
    #   * {Types::DescribeMailboxExportJobResponse#s3_bucket_name #s3_bucket_name} => String
    #   * {Types::DescribeMailboxExportJobResponse#s3_prefix #s3_prefix} => String
    #   * {Types::DescribeMailboxExportJobResponse#s3_path #s3_path} => String
    #   * {Types::DescribeMailboxExportJobResponse#estimated_progress #estimated_progress} => Integer
    #   * {Types::DescribeMailboxExportJobResponse#state #state} => String
    #   * {Types::DescribeMailboxExportJobResponse#error_info #error_info} => String
    #   * {Types::DescribeMailboxExportJobResponse#start_time #start_time} => Time
    #   * {Types::DescribeMailboxExportJobResponse#end_time #end_time} => Time
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_mailbox_export_job({
    #     job_id: "MailboxExportJobId", # required
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.entity_id #=> String
    #   resp.description #=> String
    #   resp.role_arn #=> String
    #   resp.kms_key_arn #=> String
    #   resp.s3_bucket_name #=> String
    #   resp.s3_prefix #=> String
    #   resp.s3_path #=> String
    #   resp.estimated_progress #=> Integer
    #   resp.state #=> String, one of "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
    #   resp.error_info #=> String
    #   resp.start_time #=> Time
    #   resp.end_time #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeMailboxExportJob AWS API Documentation
    #
    # @overload describe_mailbox_export_job(params = {})
    # @param [Hash] params ({})
    def describe_mailbox_export_job(params = {}, options = {})
      req = build_request(:describe_mailbox_export_job, params)
      req.send_request(options)
    end

    # Provides more information regarding a given organization based on its
    # identifier.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization to be described.
    #
    # @return [Types::DescribeOrganizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeOrganizationResponse#organization_id #organization_id} => String
    #   * {Types::DescribeOrganizationResponse#alias #alias} => String
    #   * {Types::DescribeOrganizationResponse#state #state} => String
    #   * {Types::DescribeOrganizationResponse#directory_id #directory_id} => String
    #   * {Types::DescribeOrganizationResponse#directory_type #directory_type} => String
    #   * {Types::DescribeOrganizationResponse#default_mail_domain #default_mail_domain} => String
    #   * {Types::DescribeOrganizationResponse#completed_date #completed_date} => Time
    #   * {Types::DescribeOrganizationResponse#error_message #error_message} => String
    #   * {Types::DescribeOrganizationResponse#arn #arn} => String
    #   * {Types::DescribeOrganizationResponse#migration_admin #migration_admin} => String
    #   * {Types::DescribeOrganizationResponse#interoperability_enabled #interoperability_enabled} => Boolean
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_organization({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.organization_id #=> String
    #   resp.alias #=> String
    #   resp.state #=> String
    #   resp.directory_id #=> String
    #   resp.directory_type #=> String
    #   resp.default_mail_domain #=> String
    #   resp.completed_date #=> Time
    #   resp.error_message #=> String
    #   resp.arn #=> String
    #   resp.migration_admin #=> String
    #   resp.interoperability_enabled #=> Boolean
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeOrganization AWS API Documentation
    #
    # @overload describe_organization(params = {})
    # @param [Hash] params ({})
    def describe_organization(params = {}, options = {})
      req = build_request(:describe_organization, params)
      req.send_request(options)
    end

    # Returns the data available for the resource.
    #
    # @option params [required, String] :organization_id
    #   The identifier associated with the organization for which the resource
    #   is described.
    #
    # @option params [required, String] :resource_id
    #   The identifier of the resource to be described.
    #
    #   The identifier can accept *ResourceId*, *Resourcename*, or *email*.
    #   The following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Email address: resource@domain.tld
    #
    #   * Resource name: resource
    #
    # @return [Types::DescribeResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeResourceResponse#resource_id #resource_id} => String
    #   * {Types::DescribeResourceResponse#email #email} => String
    #   * {Types::DescribeResourceResponse#name #name} => String
    #   * {Types::DescribeResourceResponse#type #type} => String
    #   * {Types::DescribeResourceResponse#booking_options #booking_options} => Types::BookingOptions
    #   * {Types::DescribeResourceResponse#state #state} => String
    #   * {Types::DescribeResourceResponse#enabled_date #enabled_date} => Time
    #   * {Types::DescribeResourceResponse#disabled_date #disabled_date} => Time
    #   * {Types::DescribeResourceResponse#description #description} => String
    #   * {Types::DescribeResourceResponse#hidden_from_global_address_list #hidden_from_global_address_list} => Boolean
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_resource({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.resource_id #=> String
    #   resp.email #=> String
    #   resp.name #=> String
    #   resp.type #=> String, one of "ROOM", "EQUIPMENT"
    #   resp.booking_options.auto_accept_requests #=> Boolean
    #   resp.booking_options.auto_decline_recurring_requests #=> Boolean
    #   resp.booking_options.auto_decline_conflicting_requests #=> Boolean
    #   resp.state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.enabled_date #=> Time
    #   resp.disabled_date #=> Time
    #   resp.description #=> String
    #   resp.hidden_from_global_address_list #=> Boolean
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeResource AWS API Documentation
    #
    # @overload describe_resource(params = {})
    # @param [Hash] params ({})
    def describe_resource(params = {}, options = {})
      req = build_request(:describe_resource, params)
      req.send_request(options)
    end

    # Provides information regarding the user.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the user exists.
    #
    # @option params [required, String] :user_id
    #   The identifier for the user to be described.
    #
    #   The identifier can be the *UserId*, *Username*, or *email*. The
    #   following identity formats are available:
    #
    #   * User ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: user@domain.tld
    #
    #   * User name: user
    #
    # @return [Types::DescribeUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::DescribeUserResponse#user_id #user_id} => String
    #   * {Types::DescribeUserResponse#name #name} => String
    #   * {Types::DescribeUserResponse#email #email} => String
    #   * {Types::DescribeUserResponse#display_name #display_name} => String
    #   * {Types::DescribeUserResponse#state #state} => String
    #   * {Types::DescribeUserResponse#user_role #user_role} => String
    #   * {Types::DescribeUserResponse#enabled_date #enabled_date} => Time
    #   * {Types::DescribeUserResponse#disabled_date #disabled_date} => Time
    #   * {Types::DescribeUserResponse#mailbox_provisioned_date #mailbox_provisioned_date} => Time
    #   * {Types::DescribeUserResponse#mailbox_deprovisioned_date #mailbox_deprovisioned_date} => Time
    #   * {Types::DescribeUserResponse#first_name #first_name} => String
    #   * {Types::DescribeUserResponse#last_name #last_name} => String
    #   * {Types::DescribeUserResponse#hidden_from_global_address_list #hidden_from_global_address_list} => Boolean
    #   * {Types::DescribeUserResponse#initials #initials} => String
    #   * {Types::DescribeUserResponse#telephone #telephone} => String
    #   * {Types::DescribeUserResponse#street #street} => String
    #   * {Types::DescribeUserResponse#job_title #job_title} => String
    #   * {Types::DescribeUserResponse#city #city} => String
    #   * {Types::DescribeUserResponse#company #company} => String
    #   * {Types::DescribeUserResponse#zip_code #zip_code} => String
    #   * {Types::DescribeUserResponse#department #department} => String
    #   * {Types::DescribeUserResponse#country #country} => String
    #   * {Types::DescribeUserResponse#office #office} => String
    #   * {Types::DescribeUserResponse#identity_provider_user_id #identity_provider_user_id} => String
    #   * {Types::DescribeUserResponse#identity_provider_identity_store_id #identity_provider_identity_store_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.describe_user({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.user_id #=> String
    #   resp.name #=> String
    #   resp.email #=> String
    #   resp.display_name #=> String
    #   resp.state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.user_role #=> String, one of "USER", "RESOURCE", "SYSTEM_USER", "REMOTE_USER"
    #   resp.enabled_date #=> Time
    #   resp.disabled_date #=> Time
    #   resp.mailbox_provisioned_date #=> Time
    #   resp.mailbox_deprovisioned_date #=> Time
    #   resp.first_name #=> String
    #   resp.last_name #=> String
    #   resp.hidden_from_global_address_list #=> Boolean
    #   resp.initials #=> String
    #   resp.telephone #=> String
    #   resp.street #=> String
    #   resp.job_title #=> String
    #   resp.city #=> String
    #   resp.company #=> String
    #   resp.zip_code #=> String
    #   resp.department #=> String
    #   resp.country #=> String
    #   resp.office #=> String
    #   resp.identity_provider_user_id #=> String
    #   resp.identity_provider_identity_store_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DescribeUser AWS API Documentation
    #
    # @overload describe_user(params = {})
    # @param [Hash] params ({})
    def describe_user(params = {}, options = {})
      req = build_request(:describe_user, params)
      req.send_request(options)
    end

    # Removes a member from the resource's set of delegates.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the resource exists.
    #
    # @option params [required, String] :resource_id
    #   The identifier of the resource from which delegates' set members are
    #   removed.
    #
    #   The identifier can accept *ResourceId*, *Resourcename*, or *email*.
    #   The following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Email address: resource@domain.tld
    #
    #   * Resource name: resource
    #
    # @option params [required, String] :entity_id
    #   The identifier for the member (user, group) to be removed from the
    #   resource's delegates.
    #
    #   The entity ID can accept *UserId or GroupID*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Entity: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity: entity
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.disassociate_delegate_from_resource({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #     entity_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateDelegateFromResource AWS API Documentation
    #
    # @overload disassociate_delegate_from_resource(params = {})
    # @param [Hash] params ({})
    def disassociate_delegate_from_resource(params = {}, options = {})
      req = build_request(:disassociate_delegate_from_resource, params)
      req.send_request(options)
    end

    # Removes a member from a group.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the group exists.
    #
    # @option params [required, String] :group_id
    #   The identifier for the group from which members are removed.
    #
    #   The identifier can accept *GroupId*, *Groupname*, or *email*. The
    #   following identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: group@domain.tld
    #
    #   * Group name: group
    #
    # @option params [required, String] :member_id
    #   The identifier for the member to be removed from the group.
    #
    #   The member ID can accept *UserID or GroupId*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Member ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: member@domain.tld
    #
    #   * Member name: member
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.disassociate_member_from_group({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #     member_id: "EntityIdentifier", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/DisassociateMemberFromGroup AWS API Documentation
    #
    # @overload disassociate_member_from_group(params = {})
    # @param [Hash] params ({})
    def disassociate_member_from_group(params = {}, options = {})
      req = build_request(:disassociate_member_from_group, params)
      req.send_request(options)
    end

    # Gets the effects of an organization's access control rules as they
    # apply to a specified IPv4 address, access protocol action, and user ID
    # or impersonation role ID. You must provide either the user ID or
    # impersonation role ID. Impersonation role ID can only be used with
    # Action EWS.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization.
    #
    # @option params [required, String] :ip_address
    #   The IPv4 address.
    #
    # @option params [required, String] :action
    #   The access protocol action. Valid values include `ActiveSync`,
    #   `AutoDiscover`, `EWS`, `IMAP`, `SMTP`, `WindowsOutlook`, and
    #   `WebMail`.
    #
    # @option params [String] :user_id
    #   The user ID.
    #
    # @option params [String] :impersonation_role_id
    #   The impersonation role ID.
    #
    # @return [Types::GetAccessControlEffectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetAccessControlEffectResponse#effect #effect} => String
    #   * {Types::GetAccessControlEffectResponse#matched_rules #matched_rules} => Array&lt;String&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_access_control_effect({
    #     organization_id: "OrganizationId", # required
    #     ip_address: "IpAddress", # required
    #     action: "AccessControlRuleAction", # required
    #     user_id: "WorkMailIdentifier",
    #     impersonation_role_id: "ImpersonationRoleId",
    #   })
    #
    # @example Response structure
    #
    #   resp.effect #=> String, one of "ALLOW", "DENY"
    #   resp.matched_rules #=> Array
    #   resp.matched_rules[0] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetAccessControlEffect AWS API Documentation
    #
    # @overload get_access_control_effect(params = {})
    # @param [Hash] params ({})
    def get_access_control_effect(params = {}, options = {})
      req = build_request(:get_access_control_effect, params)
      req.send_request(options)
    end

    # Gets the default retention policy details for the specified
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @return [Types::GetDefaultRetentionPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetDefaultRetentionPolicyResponse#id #id} => String
    #   * {Types::GetDefaultRetentionPolicyResponse#name #name} => String
    #   * {Types::GetDefaultRetentionPolicyResponse#description #description} => String
    #   * {Types::GetDefaultRetentionPolicyResponse#folder_configurations #folder_configurations} => Array&lt;Types::FolderConfiguration&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_default_retention_policy({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.id #=> String
    #   resp.name #=> String
    #   resp.description #=> String
    #   resp.folder_configurations #=> Array
    #   resp.folder_configurations[0].name #=> String, one of "INBOX", "DELETED_ITEMS", "SENT_ITEMS", "DRAFTS", "JUNK_EMAIL"
    #   resp.folder_configurations[0].action #=> String, one of "NONE", "DELETE", "PERMANENTLY_DELETE"
    #   resp.folder_configurations[0].period #=> Integer
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetDefaultRetentionPolicy AWS API Documentation
    #
    # @overload get_default_retention_policy(params = {})
    # @param [Hash] params ({})
    def get_default_retention_policy(params = {}, options = {})
      req = build_request(:get_default_retention_policy, params)
      req.send_request(options)
    end

    # Gets the impersonation role details for the given WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization from which to retrieve the impersonation
    #   role.
    #
    # @option params [required, String] :impersonation_role_id
    #   The impersonation role ID to retrieve.
    #
    # @return [Types::GetImpersonationRoleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetImpersonationRoleResponse#impersonation_role_id #impersonation_role_id} => String
    #   * {Types::GetImpersonationRoleResponse#name #name} => String
    #   * {Types::GetImpersonationRoleResponse#type #type} => String
    #   * {Types::GetImpersonationRoleResponse#description #description} => String
    #   * {Types::GetImpersonationRoleResponse#rules #rules} => Array&lt;Types::ImpersonationRule&gt;
    #   * {Types::GetImpersonationRoleResponse#date_created #date_created} => Time
    #   * {Types::GetImpersonationRoleResponse#date_modified #date_modified} => Time
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_impersonation_role({
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_id: "ImpersonationRoleId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.impersonation_role_id #=> String
    #   resp.name #=> String
    #   resp.type #=> String, one of "FULL_ACCESS", "READ_ONLY"
    #   resp.description #=> String
    #   resp.rules #=> Array
    #   resp.rules[0].impersonation_rule_id #=> String
    #   resp.rules[0].name #=> String
    #   resp.rules[0].description #=> String
    #   resp.rules[0].effect #=> String, one of "ALLOW", "DENY"
    #   resp.rules[0].target_users #=> Array
    #   resp.rules[0].target_users[0] #=> String
    #   resp.rules[0].not_target_users #=> Array
    #   resp.rules[0].not_target_users[0] #=> String
    #   resp.date_created #=> Time
    #   resp.date_modified #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRole AWS API Documentation
    #
    # @overload get_impersonation_role(params = {})
    # @param [Hash] params ({})
    def get_impersonation_role(params = {}, options = {})
      req = build_request(:get_impersonation_role, params)
      req.send_request(options)
    end

    # Tests whether the given impersonation role can impersonate a target
    # user.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization where the impersonation role is defined.
    #
    # @option params [required, String] :impersonation_role_id
    #   The impersonation role ID to test.
    #
    # @option params [required, String] :target_user
    #   The WorkMail organization user chosen to test the impersonation role.
    #   The following identity formats are available:
    #
    #   * User ID: `12345678-1234-1234-1234-123456789012` or
    #     `S-1-1-12-1234567890-123456789-123456789-1234`
    #
    #   * Email address: `user@domain.tld`
    #
    #   * User name: `user`
    #
    # @return [Types::GetImpersonationRoleEffectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetImpersonationRoleEffectResponse#type #type} => String
    #   * {Types::GetImpersonationRoleEffectResponse#effect #effect} => String
    #   * {Types::GetImpersonationRoleEffectResponse#matched_rules #matched_rules} => Array&lt;Types::ImpersonationMatchedRule&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_impersonation_role_effect({
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_id: "ImpersonationRoleId", # required
    #     target_user: "EntityIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.type #=> String, one of "FULL_ACCESS", "READ_ONLY"
    #   resp.effect #=> String, one of "ALLOW", "DENY"
    #   resp.matched_rules #=> Array
    #   resp.matched_rules[0].impersonation_rule_id #=> String
    #   resp.matched_rules[0].name #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetImpersonationRoleEffect AWS API Documentation
    #
    # @overload get_impersonation_role_effect(params = {})
    # @param [Hash] params ({})
    def get_impersonation_role_effect(params = {}, options = {})
      req = build_request(:get_impersonation_role_effect, params)
      req.send_request(options)
    end

    # Gets details for a mail domain, including domain records required to
    # configure your domain with recommended security.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the domain is retrieved.
    #
    # @option params [required, String] :domain_name
    #   The domain from which you want to retrieve details.
    #
    # @return [Types::GetMailDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetMailDomainResponse#records #records} => Array&lt;Types::DnsRecord&gt;
    #   * {Types::GetMailDomainResponse#is_test_domain #is_test_domain} => Boolean
    #   * {Types::GetMailDomainResponse#is_default #is_default} => Boolean
    #   * {Types::GetMailDomainResponse#ownership_verification_status #ownership_verification_status} => String
    #   * {Types::GetMailDomainResponse#dkim_verification_status #dkim_verification_status} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_mail_domain({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "WorkMailDomainName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.records #=> Array
    #   resp.records[0].type #=> String
    #   resp.records[0].hostname #=> String
    #   resp.records[0].value #=> String
    #   resp.is_test_domain #=> Boolean
    #   resp.is_default #=> Boolean
    #   resp.ownership_verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED"
    #   resp.dkim_verification_status #=> String, one of "PENDING", "VERIFIED", "FAILED"
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailDomain AWS API Documentation
    #
    # @overload get_mail_domain(params = {})
    # @param [Hash] params ({})
    def get_mail_domain(params = {}, options = {})
      req = build_request(:get_mail_domain, params)
      req.send_request(options)
    end

    # Requests a user's mailbox details for a specified organization and
    # user.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization that contains the user whose
    #   mailbox details are being requested.
    #
    # @option params [required, String] :user_id
    #   The identifier for the user whose mailbox details are being requested.
    #
    #   The identifier can be the *UserId*, *Username*, or *email*. The
    #   following identity formats are available:
    #
    #   * User ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: user@domain.tld
    #
    #   * User name: user
    #
    # @return [Types::GetMailboxDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetMailboxDetailsResponse#mailbox_quota #mailbox_quota} => Integer
    #   * {Types::GetMailboxDetailsResponse#mailbox_size #mailbox_size} => Float
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_mailbox_details({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.mailbox_quota #=> Integer
    #   resp.mailbox_size #=> Float
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMailboxDetails AWS API Documentation
    #
    # @overload get_mailbox_details(params = {})
    # @param [Hash] params ({})
    def get_mailbox_details(params = {}, options = {})
      req = build_request(:get_mailbox_details, params)
      req.send_request(options)
    end

    # Simulates the effect of the mobile device access rules for the given
    # attributes of a sample access event. Use this method to test the
    # effects of the current set of mobile device access rules for the
    # WorkMail organization for a particular user's attributes.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization to simulate the access effect for.
    #
    # @option params [String] :device_type
    #   Device type the simulated user will report.
    #
    # @option params [String] :device_model
    #   Device model the simulated user will report.
    #
    # @option params [String] :device_operating_system
    #   Device operating system the simulated user will report.
    #
    # @option params [String] :device_user_agent
    #   Device user agent the simulated user will report.
    #
    # @return [Types::GetMobileDeviceAccessEffectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetMobileDeviceAccessEffectResponse#effect #effect} => String
    #   * {Types::GetMobileDeviceAccessEffectResponse#matched_rules #matched_rules} => Array&lt;Types::MobileDeviceAccessMatchedRule&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_mobile_device_access_effect({
    #     organization_id: "OrganizationId", # required
    #     device_type: "DeviceType",
    #     device_model: "DeviceModel",
    #     device_operating_system: "DeviceOperatingSystem",
    #     device_user_agent: "DeviceUserAgent",
    #   })
    #
    # @example Response structure
    #
    #   resp.effect #=> String, one of "ALLOW", "DENY"
    #   resp.matched_rules #=> Array
    #   resp.matched_rules[0].mobile_device_access_rule_id #=> String
    #   resp.matched_rules[0].name #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessEffect AWS API Documentation
    #
    # @overload get_mobile_device_access_effect(params = {})
    # @param [Hash] params ({})
    def get_mobile_device_access_effect(params = {}, options = {})
      req = build_request(:get_mobile_device_access_effect, params)
      req.send_request(options)
    end

    # Gets the mobile device access override for the given WorkMail
    # organization, user, and device.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization to which you want to apply the override.
    #
    # @option params [required, String] :user_id
    #   Identifies the WorkMail user for the override. Accepts the following
    #   types of user identities:
    #
    #   * User ID: `12345678-1234-1234-1234-123456789012` or
    #     `S-1-1-12-1234567890-123456789-123456789-1234`
    #
    #   * Email address: `user@domain.tld`
    #
    #   * User name: `user`
    #
    # @option params [required, String] :device_id
    #   The mobile device to which the override applies. `DeviceId` is case
    #   insensitive.
    #
    # @return [Types::GetMobileDeviceAccessOverrideResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetMobileDeviceAccessOverrideResponse#user_id #user_id} => String
    #   * {Types::GetMobileDeviceAccessOverrideResponse#device_id #device_id} => String
    #   * {Types::GetMobileDeviceAccessOverrideResponse#effect #effect} => String
    #   * {Types::GetMobileDeviceAccessOverrideResponse#description #description} => String
    #   * {Types::GetMobileDeviceAccessOverrideResponse#date_created #date_created} => Time
    #   * {Types::GetMobileDeviceAccessOverrideResponse#date_modified #date_modified} => Time
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_mobile_device_access_override({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #     device_id: "DeviceId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.user_id #=> String
    #   resp.device_id #=> String
    #   resp.effect #=> String, one of "ALLOW", "DENY"
    #   resp.description #=> String
    #   resp.date_created #=> Time
    #   resp.date_modified #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetMobileDeviceAccessOverride AWS API Documentation
    #
    # @overload get_mobile_device_access_override(params = {})
    # @param [Hash] params ({})
    def get_mobile_device_access_override(params = {}, options = {})
      req = build_request(:get_mobile_device_access_override, params)
      req.send_request(options)
    end

    # Requests details of a specific Personal Access Token within the
    # WorkMail organization.
    #
    # @option params [required, String] :organization_id
    #   The Organization ID.
    #
    # @option params [required, String] :personal_access_token_id
    #   The Personal Access Token ID.
    #
    # @return [Types::GetPersonalAccessTokenMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::GetPersonalAccessTokenMetadataResponse#personal_access_token_id #personal_access_token_id} => String
    #   * {Types::GetPersonalAccessTokenMetadataResponse#user_id #user_id} => String
    #   * {Types::GetPersonalAccessTokenMetadataResponse#name #name} => String
    #   * {Types::GetPersonalAccessTokenMetadataResponse#date_created #date_created} => Time
    #   * {Types::GetPersonalAccessTokenMetadataResponse#date_last_used #date_last_used} => Time
    #   * {Types::GetPersonalAccessTokenMetadataResponse#expires_time #expires_time} => Time
    #   * {Types::GetPersonalAccessTokenMetadataResponse#scopes #scopes} => Array&lt;String&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.get_personal_access_token_metadata({
    #     organization_id: "OrganizationId", # required
    #     personal_access_token_id: "PersonalAccessTokenId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.personal_access_token_id #=> String
    #   resp.user_id #=> String
    #   resp.name #=> String
    #   resp.date_created #=> Time
    #   resp.date_last_used #=> Time
    #   resp.expires_time #=> Time
    #   resp.scopes #=> Array
    #   resp.scopes[0] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/GetPersonalAccessTokenMetadata AWS API Documentation
    #
    # @overload get_personal_access_token_metadata(params = {})
    # @param [Hash] params ({})
    def get_personal_access_token_metadata(params = {}, options = {})
      req = build_request(:get_personal_access_token_metadata, params)
      req.send_request(options)
    end

    # Lists the access control rules for the specified organization.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization.
    #
    # @return [Types::ListAccessControlRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListAccessControlRulesResponse#rules #rules} => Array&lt;Types::AccessControlRule&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_access_control_rules({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.rules #=> Array
    #   resp.rules[0].name #=> String
    #   resp.rules[0].effect #=> String, one of "ALLOW", "DENY"
    #   resp.rules[0].description #=> String
    #   resp.rules[0].ip_ranges #=> Array
    #   resp.rules[0].ip_ranges[0] #=> String
    #   resp.rules[0].not_ip_ranges #=> Array
    #   resp.rules[0].not_ip_ranges[0] #=> String
    #   resp.rules[0].actions #=> Array
    #   resp.rules[0].actions[0] #=> String
    #   resp.rules[0].not_actions #=> Array
    #   resp.rules[0].not_actions[0] #=> String
    #   resp.rules[0].user_ids #=> Array
    #   resp.rules[0].user_ids[0] #=> String
    #   resp.rules[0].not_user_ids #=> Array
    #   resp.rules[0].not_user_ids[0] #=> String
    #   resp.rules[0].date_created #=> Time
    #   resp.rules[0].date_modified #=> Time
    #   resp.rules[0].impersonation_role_ids #=> Array
    #   resp.rules[0].impersonation_role_ids[0] #=> String
    #   resp.rules[0].not_impersonation_role_ids #=> Array
    #   resp.rules[0].not_impersonation_role_ids[0] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAccessControlRules AWS API Documentation
    #
    # @overload list_access_control_rules(params = {})
    # @param [Hash] params ({})
    def list_access_control_rules(params = {}, options = {})
      req = build_request(:list_access_control_rules, params)
      req.send_request(options)
    end

    # Creates a paginated call to list the aliases associated with a given
    # entity.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the entity exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier for the entity for which to list the aliases.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListAliasesResponse#aliases #aliases} => Array&lt;String&gt;
    #   * {Types::ListAliasesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_aliases({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "WorkMailIdentifier", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.aliases #=> Array
    #   resp.aliases[0] #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAliases AWS API Documentation
    #
    # @overload list_aliases(params = {})
    # @param [Hash] params ({})
    def list_aliases(params = {}, options = {})
      req = build_request(:list_aliases, params)
      req.send_request(options)
    end

    # List all the `AvailabilityConfiguration`'s for the given WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the `AvailabilityConfiguration`'s
    #   will be listed.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not require a token.
    #
    # @return [Types::ListAvailabilityConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListAvailabilityConfigurationsResponse#availability_configurations #availability_configurations} => Array&lt;Types::AvailabilityConfiguration&gt;
    #   * {Types::ListAvailabilityConfigurationsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_availability_configurations({
    #     organization_id: "OrganizationId", # required
    #     max_results: 1,
    #     next_token: "NextToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.availability_configurations #=> Array
    #   resp.availability_configurations[0].domain_name #=> String
    #   resp.availability_configurations[0].provider_type #=> String, one of "EWS", "LAMBDA"
    #   resp.availability_configurations[0].ews_provider.ews_endpoint #=> String
    #   resp.availability_configurations[0].ews_provider.ews_username #=> String
    #   resp.availability_configurations[0].lambda_provider.lambda_arn #=> String
    #   resp.availability_configurations[0].date_created #=> Time
    #   resp.availability_configurations[0].date_modified #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListAvailabilityConfigurations AWS API Documentation
    #
    # @overload list_availability_configurations(params = {})
    # @param [Hash] params ({})
    def list_availability_configurations(params = {}, options = {})
      req = build_request(:list_availability_configurations, params)
      req.send_request(options)
    end

    # Returns an overview of the members of a group. Users and groups can be
    # members of a group.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the group exists.
    #
    # @option params [required, String] :group_id
    #   The identifier for the group to which the members (users or groups)
    #   are associated.
    #
    #   The identifier can accept *GroupId*, *Groupname*, or *email*. The
    #   following identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: group@domain.tld
    #
    #   * Group name: group
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListGroupMembersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListGroupMembersResponse#members #members} => Array&lt;Types::Member&gt;
    #   * {Types::ListGroupMembersResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_group_members({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.members #=> Array
    #   resp.members[0].id #=> String
    #   resp.members[0].name #=> String
    #   resp.members[0].type #=> String, one of "GROUP", "USER"
    #   resp.members[0].state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.members[0].enabled_date #=> Time
    #   resp.members[0].disabled_date #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupMembers AWS API Documentation
    #
    # @overload list_group_members(params = {})
    # @param [Hash] params ({})
    def list_group_members(params = {}, options = {})
      req = build_request(:list_group_members, params)
      req.send_request(options)
    end

    # Returns summaries of the organization's groups.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the groups exist.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @option params [Types::ListGroupsFilters] :filters
    #   Limit the search results based on the filter criteria. Only one filter
    #   per request is supported.
    #
    # @return [Types::ListGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListGroupsResponse#groups #groups} => Array&lt;Types::Group&gt;
    #   * {Types::ListGroupsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_groups({
    #     organization_id: "OrganizationId", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #     filters: {
    #       name_prefix: "String",
    #       primary_email_prefix: "String",
    #       state: "ENABLED", # accepts ENABLED, DISABLED, DELETED
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.groups #=> Array
    #   resp.groups[0].id #=> String
    #   resp.groups[0].email #=> String
    #   resp.groups[0].name #=> String
    #   resp.groups[0].state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.groups[0].enabled_date #=> Time
    #   resp.groups[0].disabled_date #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroups AWS API Documentation
    #
    # @overload list_groups(params = {})
    # @param [Hash] params ({})
    def list_groups(params = {}, options = {})
      req = build_request(:list_groups, params)
      req.send_request(options)
    end

    # Returns all the groups to which an entity belongs.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the entity exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier for the entity.
    #
    #   The entity ID can accept *UserId or GroupID*, *Username or Groupname*,
    #   or *email*.
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [Types::ListGroupsForEntityFilters] :filters
    #   Limit the search results based on the filter criteria.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListGroupsForEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListGroupsForEntityResponse#groups #groups} => Array&lt;Types::GroupIdentifier&gt;
    #   * {Types::ListGroupsForEntityResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_groups_for_entity({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     filters: {
    #       group_name_prefix: "String",
    #     },
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.groups #=> Array
    #   resp.groups[0].group_id #=> String
    #   resp.groups[0].group_name #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListGroupsForEntity AWS API Documentation
    #
    # @overload list_groups_for_entity(params = {})
    # @param [Hash] params ({})
    def list_groups_for_entity(params = {}, options = {})
      req = build_request(:list_groups_for_entity, params)
      req.send_request(options)
    end

    # Lists all the impersonation roles for the given WorkMail organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization to which the listed impersonation roles
    #   belong.
    #
    # @option params [String] :next_token
    #   The token used to retrieve the next page of results. The first call
    #   doesn't require a token.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results returned in a single call.
    #
    # @return [Types::ListImpersonationRolesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListImpersonationRolesResponse#roles #roles} => Array&lt;Types::ImpersonationRole&gt;
    #   * {Types::ListImpersonationRolesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_impersonation_roles({
    #     organization_id: "OrganizationId", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.roles #=> Array
    #   resp.roles[0].impersonation_role_id #=> String
    #   resp.roles[0].name #=> String
    #   resp.roles[0].type #=> String, one of "FULL_ACCESS", "READ_ONLY"
    #   resp.roles[0].date_created #=> Time
    #   resp.roles[0].date_modified #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListImpersonationRoles AWS API Documentation
    #
    # @overload list_impersonation_roles(params = {})
    # @param [Hash] params ({})
    def list_impersonation_roles(params = {}, options = {})
      req = build_request(:list_impersonation_roles, params)
      req.send_request(options)
    end

    # Lists the mail domains in a given WorkMail organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which to list domains.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not require a token.
    #
    # @return [Types::ListMailDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListMailDomainsResponse#mail_domains #mail_domains} => Array&lt;Types::MailDomainSummary&gt;
    #   * {Types::ListMailDomainsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_mail_domains({
    #     organization_id: "OrganizationId", # required
    #     max_results: 1,
    #     next_token: "NextToken",
    #   })
    #
    # @example Response structure
    #
    #   resp.mail_domains #=> Array
    #   resp.mail_domains[0].domain_name #=> String
    #   resp.mail_domains[0].default_domain #=> Boolean
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailDomains AWS API Documentation
    #
    # @overload list_mail_domains(params = {})
    # @param [Hash] params ({})
    def list_mail_domains(params = {}, options = {})
      req = build_request(:list_mail_domains, params)
      req.send_request(options)
    end

    # Lists the mailbox export jobs started for the specified organization
    # within the last seven days.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListMailboxExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListMailboxExportJobsResponse#jobs #jobs} => Array&lt;Types::MailboxExportJob&gt;
    #   * {Types::ListMailboxExportJobsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_mailbox_export_jobs({
    #     organization_id: "OrganizationId", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.jobs #=> Array
    #   resp.jobs[0].job_id #=> String
    #   resp.jobs[0].entity_id #=> String
    #   resp.jobs[0].description #=> String
    #   resp.jobs[0].s3_bucket_name #=> String
    #   resp.jobs[0].s3_path #=> String
    #   resp.jobs[0].estimated_progress #=> Integer
    #   resp.jobs[0].state #=> String, one of "RUNNING", "COMPLETED", "FAILED", "CANCELLED"
    #   resp.jobs[0].start_time #=> Time
    #   resp.jobs[0].end_time #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxExportJobs AWS API Documentation
    #
    # @overload list_mailbox_export_jobs(params = {})
    # @param [Hash] params ({})
    def list_mailbox_export_jobs(params = {}, options = {})
      req = build_request(:list_mailbox_export_jobs, params)
      req.send_request(options)
    end

    # Lists the mailbox permissions associated with a user, group, or
    # resource mailbox.
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization under which the user, group, or
    #   resource exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier of the user, or resource for which to list mailbox
    #   permissions.
    #
    #   The entity ID can accept *UserId or ResourceId*, *Username or
    #   Resourcename*, or *email*.
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012, or
    #     r-0123456789a0123456789b0123456789
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListMailboxPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListMailboxPermissionsResponse#permissions #permissions} => Array&lt;Types::Permission&gt;
    #   * {Types::ListMailboxPermissionsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_mailbox_permissions({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.permissions #=> Array
    #   resp.permissions[0].grantee_id #=> String
    #   resp.permissions[0].grantee_type #=> String, one of "GROUP", "USER"
    #   resp.permissions[0].permission_values #=> Array
    #   resp.permissions[0].permission_values[0] #=> String, one of "FULL_ACCESS", "SEND_AS", "SEND_ON_BEHALF"
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMailboxPermissions AWS API Documentation
    #
    # @overload list_mailbox_permissions(params = {})
    # @param [Hash] params ({})
    def list_mailbox_permissions(params = {}, options = {})
      req = build_request(:list_mailbox_permissions, params)
      req.send_request(options)
    end

    # Lists all the mobile device access overrides for any given combination
    # of WorkMail organization, user, or device.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which to list mobile device access
    #   overrides.
    #
    # @option params [String] :user_id
    #   The WorkMail user under which you list the mobile device access
    #   overrides. Accepts the following types of user identities:
    #
    #   * User ID: `12345678-1234-1234-1234-123456789012` or
    #     `S-1-1-12-1234567890-123456789-123456789-1234`
    #
    #   * Email address: `user@domain.tld`
    #
    #   * User name: `user`
    #
    # @option params [String] :device_id
    #   The mobile device to which the access override applies.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not require a token.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListMobileDeviceAccessOverridesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListMobileDeviceAccessOverridesResponse#overrides #overrides} => Array&lt;Types::MobileDeviceAccessOverride&gt;
    #   * {Types::ListMobileDeviceAccessOverridesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_mobile_device_access_overrides({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier",
    #     device_id: "DeviceId",
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.overrides #=> Array
    #   resp.overrides[0].user_id #=> String
    #   resp.overrides[0].device_id #=> String
    #   resp.overrides[0].effect #=> String, one of "ALLOW", "DENY"
    #   resp.overrides[0].description #=> String
    #   resp.overrides[0].date_created #=> Time
    #   resp.overrides[0].date_modified #=> Time
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessOverrides AWS API Documentation
    #
    # @overload list_mobile_device_access_overrides(params = {})
    # @param [Hash] params ({})
    def list_mobile_device_access_overrides(params = {}, options = {})
      req = build_request(:list_mobile_device_access_overrides, params)
      req.send_request(options)
    end

    # Lists the mobile device access rules for the specified WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which to list the rules.
    #
    # @return [Types::ListMobileDeviceAccessRulesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListMobileDeviceAccessRulesResponse#rules #rules} => Array&lt;Types::MobileDeviceAccessRule&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_mobile_device_access_rules({
    #     organization_id: "OrganizationId", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.rules #=> Array
    #   resp.rules[0].mobile_device_access_rule_id #=> String
    #   resp.rules[0].name #=> String
    #   resp.rules[0].description #=> String
    #   resp.rules[0].effect #=> String, one of "ALLOW", "DENY"
    #   resp.rules[0].device_types #=> Array
    #   resp.rules[0].device_types[0] #=> String
    #   resp.rules[0].not_device_types #=> Array
    #   resp.rules[0].not_device_types[0] #=> String
    #   resp.rules[0].device_models #=> Array
    #   resp.rules[0].device_models[0] #=> String
    #   resp.rules[0].not_device_models #=> Array
    #   resp.rules[0].not_device_models[0] #=> String
    #   resp.rules[0].device_operating_systems #=> Array
    #   resp.rules[0].device_operating_systems[0] #=> String
    #   resp.rules[0].not_device_operating_systems #=> Array
    #   resp.rules[0].not_device_operating_systems[0] #=> String
    #   resp.rules[0].device_user_agents #=> Array
    #   resp.rules[0].device_user_agents[0] #=> String
    #   resp.rules[0].not_device_user_agents #=> Array
    #   resp.rules[0].not_device_user_agents[0] #=> String
    #   resp.rules[0].date_created #=> Time
    #   resp.rules[0].date_modified #=> Time
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListMobileDeviceAccessRules AWS API Documentation
    #
    # @overload list_mobile_device_access_rules(params = {})
    # @param [Hash] params ({})
    def list_mobile_device_access_rules(params = {}, options = {})
      req = build_request(:list_mobile_device_access_rules, params)
      req.send_request(options)
    end

    # Returns summaries of the customer's organizations.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @return [Types::ListOrganizationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListOrganizationsResponse#organization_summaries #organization_summaries} => Array&lt;Types::OrganizationSummary&gt;
    #   * {Types::ListOrganizationsResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_organizations({
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.organization_summaries #=> Array
    #   resp.organization_summaries[0].organization_id #=> String
    #   resp.organization_summaries[0].alias #=> String
    #   resp.organization_summaries[0].default_mail_domain #=> String
    #   resp.organization_summaries[0].error_message #=> String
    #   resp.organization_summaries[0].state #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListOrganizations AWS API Documentation
    #
    # @overload list_organizations(params = {})
    # @param [Hash] params ({})
    def list_organizations(params = {}, options = {})
      req = build_request(:list_organizations, params)
      req.send_request(options)
    end

    # Returns a summary of your Personal Access Tokens.
    #
    # @option params [required, String] :organization_id
    #   The Organization ID.
    #
    # @option params [String] :user_id
    #   The WorkMail User ID.
    #
    # @option params [String] :next_token
    #   The token from the previous response to query the next page.
    #
    # @option params [Integer] :max_results
    #   The maximum amount of items that should be returned in a response.
    #
    # @return [Types::ListPersonalAccessTokensResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListPersonalAccessTokensResponse#next_token #next_token} => String
    #   * {Types::ListPersonalAccessTokensResponse#personal_access_token_summaries #personal_access_token_summaries} => Array&lt;Types::PersonalAccessTokenSummary&gt;
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_personal_access_tokens({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier",
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.next_token #=> String
    #   resp.personal_access_token_summaries #=> Array
    #   resp.personal_access_token_summaries[0].personal_access_token_id #=> String
    #   resp.personal_access_token_summaries[0].user_id #=> String
    #   resp.personal_access_token_summaries[0].name #=> String
    #   resp.personal_access_token_summaries[0].date_created #=> Time
    #   resp.personal_access_token_summaries[0].date_last_used #=> Time
    #   resp.personal_access_token_summaries[0].expires_time #=> Time
    #   resp.personal_access_token_summaries[0].scopes #=> Array
    #   resp.personal_access_token_summaries[0].scopes[0] #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListPersonalAccessTokens AWS API Documentation
    #
    # @overload list_personal_access_tokens(params = {})
    # @param [Hash] params ({})
    def list_personal_access_tokens(params = {}, options = {})
      req = build_request(:list_personal_access_tokens, params)
      req.send_request(options)
    end

    # Lists the delegates associated with a resource. Users and groups can
    # be resource delegates and answer requests on behalf of the resource.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization that contains the resource for
    #   which delegates are listed.
    #
    # @option params [required, String] :resource_id
    #   The identifier for the resource whose delegates are listed.
    #
    #   The identifier can accept *ResourceId*, *Resourcename*, or *email*.
    #   The following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Email address: resource@domain.tld
    #
    #   * Resource name: resource
    #
    # @option params [String] :next_token
    #   The token used to paginate through the delegates associated with a
    #   resource.
    #
    # @option params [Integer] :max_results
    #   The number of maximum results in a page.
    #
    # @return [Types::ListResourceDelegatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListResourceDelegatesResponse#delegates #delegates} => Array&lt;Types::Delegate&gt;
    #   * {Types::ListResourceDelegatesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_resource_delegates({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #   })
    #
    # @example Response structure
    #
    #   resp.delegates #=> Array
    #   resp.delegates[0].id #=> String
    #   resp.delegates[0].type #=> String, one of "GROUP", "USER"
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResourceDelegates AWS API Documentation
    #
    # @overload list_resource_delegates(params = {})
    # @param [Hash] params ({})
    def list_resource_delegates(params = {}, options = {})
      req = build_request(:list_resource_delegates, params)
      req.send_request(options)
    end

    # Returns summaries of the organization's resources.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the resources exist.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @option params [Types::ListResourcesFilters] :filters
    #   Limit the resource search results based on the filter criteria. You
    #   can only use one filter per request.
    #
    # @return [Types::ListResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListResourcesResponse#resources #resources} => Array&lt;Types::Resource&gt;
    #   * {Types::ListResourcesResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_resources({
    #     organization_id: "OrganizationId", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #     filters: {
    #       name_prefix: "String",
    #       primary_email_prefix: "String",
    #       state: "ENABLED", # accepts ENABLED, DISABLED, DELETED
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.resources #=> Array
    #   resp.resources[0].id #=> String
    #   resp.resources[0].email #=> String
    #   resp.resources[0].name #=> String
    #   resp.resources[0].type #=> String, one of "ROOM", "EQUIPMENT"
    #   resp.resources[0].state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.resources[0].enabled_date #=> Time
    #   resp.resources[0].disabled_date #=> Time
    #   resp.resources[0].description #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListResources AWS API Documentation
    #
    # @overload list_resources(params = {})
    # @param [Hash] params ({})
    def list_resources(params = {}, options = {})
      req = build_request(:list_resources, params)
      req.send_request(options)
    end

    # Lists the tags applied to an WorkMail organization resource.
    #
    # @option params [required, String] :resource_arn
    #   The resource ARN.
    #
    # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_tags_for_resource({
    #     resource_arn: "AmazonResourceName", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.tags #=> Array
    #   resp.tags[0].key #=> String
    #   resp.tags[0].value #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListTagsForResource AWS API Documentation
    #
    # @overload list_tags_for_resource(params = {})
    # @param [Hash] params ({})
    def list_tags_for_resource(params = {}, options = {})
      req = build_request(:list_tags_for_resource, params)
      req.send_request(options)
    end

    # Returns summaries of the organization's users.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the users exist.
    #
    # @option params [String] :next_token
    #   The token to use to retrieve the next page of results. The first call
    #   does not contain any tokens.
    #
    # @option params [Integer] :max_results
    #   The maximum number of results to return in a single call.
    #
    # @option params [Types::ListUsersFilters] :filters
    #   Limit the user search results based on the filter criteria. You can
    #   only use one filter per request.
    #
    # @return [Types::ListUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::ListUsersResponse#users #users} => Array&lt;Types::User&gt;
    #   * {Types::ListUsersResponse#next_token #next_token} => String
    #
    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.list_users({
    #     organization_id: "OrganizationId", # required
    #     next_token: "NextToken",
    #     max_results: 1,
    #     filters: {
    #       username_prefix: "String",
    #       display_name_prefix: "UserAttribute",
    #       primary_email_prefix: "String",
    #       state: "ENABLED", # accepts ENABLED, DISABLED, DELETED
    #       identity_provider_user_id_prefix: "IdentityProviderUserIdPrefix",
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.users #=> Array
    #   resp.users[0].id #=> String
    #   resp.users[0].email #=> String
    #   resp.users[0].name #=> String
    #   resp.users[0].display_name #=> String
    #   resp.users[0].state #=> String, one of "ENABLED", "DISABLED", "DELETED"
    #   resp.users[0].user_role #=> String, one of "USER", "RESOURCE", "SYSTEM_USER", "REMOTE_USER"
    #   resp.users[0].enabled_date #=> Time
    #   resp.users[0].disabled_date #=> Time
    #   resp.users[0].identity_provider_user_id #=> String
    #   resp.users[0].identity_provider_identity_store_id #=> String
    #   resp.next_token #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ListUsers AWS API Documentation
    #
    # @overload list_users(params = {})
    # @param [Hash] params ({})
    def list_users(params = {}, options = {})
      req = build_request(:list_users, params)
      req.send_request(options)
    end

    # Adds a new access control rule for the specified organization. The
    # rule allows or denies access to the organization for the specified
    # IPv4 addresses, access protocol actions, user IDs and impersonation
    # IDs. Adding a new rule with the same name as an existing rule replaces
    # the older rule.
    #
    # @option params [required, String] :name
    #   The rule name.
    #
    # @option params [required, String] :effect
    #   The rule effect.
    #
    # @option params [required, String] :description
    #   The rule description.
    #
    # @option params [Array<String>] :ip_ranges
    #   IPv4 CIDR ranges to include in the rule.
    #
    # @option params [Array<String>] :not_ip_ranges
    #   IPv4 CIDR ranges to exclude from the rule.
    #
    # @option params [Array<String>] :actions
    #   Access protocol actions to include in the rule. Valid values include
    #   `ActiveSync`, `AutoDiscover`, `EWS`, `IMAP`, `SMTP`, `WindowsOutlook`,
    #   and `WebMail`.
    #
    # @option params [Array<String>] :not_actions
    #   Access protocol actions to exclude from the rule. Valid values include
    #   `ActiveSync`, `AutoDiscover`, `EWS`, `IMAP`, `SMTP`, `WindowsOutlook`,
    #   and `WebMail`.
    #
    # @option params [Array<String>] :user_ids
    #   User IDs to include in the rule.
    #
    # @option params [Array<String>] :not_user_ids
    #   User IDs to exclude from the rule.
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization.
    #
    # @option params [Array<String>] :impersonation_role_ids
    #   Impersonation role IDs to include in the rule.
    #
    # @option params [Array<String>] :not_impersonation_role_ids
    #   Impersonation role IDs to exclude from the rule.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_access_control_rule({
    #     name: "AccessControlRuleName", # required
    #     effect: "ALLOW", # required, accepts ALLOW, DENY
    #     description: "AccessControlRuleDescription", # required
    #     ip_ranges: ["IpRange"],
    #     not_ip_ranges: ["IpRange"],
    #     actions: ["AccessControlRuleAction"],
    #     not_actions: ["AccessControlRuleAction"],
    #     user_ids: ["WorkMailIdentifier"],
    #     not_user_ids: ["WorkMailIdentifier"],
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_ids: ["ImpersonationRoleId"],
    #     not_impersonation_role_ids: ["ImpersonationRoleId"],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutAccessControlRule AWS API Documentation
    #
    # @overload put_access_control_rule(params = {})
    # @param [Hash] params ({})
    def put_access_control_rule(params = {}, options = {})
      req = build_request(:put_access_control_rule, params)
      req.send_request(options)
    end

    # Creates or updates the email monitoring configuration for a specified
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The ID of the organization for which the email monitoring
    #   configuration is set.
    #
    # @option params [String] :role_arn
    #   The Amazon Resource Name (ARN) of the IAM Role associated with the
    #   email monitoring configuration. If absent, the IAM Role Arn of
    #   AWSServiceRoleForAmazonWorkMailEvents will be used.
    #
    # @option params [required, String] :log_group_arn
    #   The Amazon Resource Name (ARN) of the CloudWatch Log group associated
    #   with the email monitoring configuration.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_email_monitoring_configuration({
    #     organization_id: "OrganizationId", # required
    #     role_arn: "RoleArn",
    #     log_group_arn: "LogGroupArn", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutEmailMonitoringConfiguration AWS API Documentation
    #
    # @overload put_email_monitoring_configuration(params = {})
    # @param [Hash] params ({})
    def put_email_monitoring_configuration(params = {}, options = {})
      req = build_request(:put_email_monitoring_configuration, params)
      req.send_request(options)
    end

    # Enables integration between IAM Identity Center (IdC) and WorkMail to
    # proxy authentication requests for mailbox users. You can connect your
    # IdC directory or your external directory to WorkMail through IdC and
    # manage access to WorkMail mailboxes in a single place. For enhanced
    # protection, you could enable Multifactor Authentication (MFA) and
    # Personal Access Tokens.
    #
    # @option params [required, String] :organization_id
    #   The ID of the WorkMail Organization.
    #
    # @option params [required, String] :authentication_mode
    #   The authentication mode used in WorkMail.
    #
    # @option params [required, Types::IdentityCenterConfiguration] :identity_center_configuration
    #   The details of the IAM Identity Center configuration.
    #
    # @option params [required, Types::PersonalAccessTokenConfiguration] :personal_access_token_configuration
    #   The details of the Personal Access Token configuration.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_identity_provider_configuration({
    #     organization_id: "OrganizationId", # required
    #     authentication_mode: "IDENTITY_PROVIDER_ONLY", # required, accepts IDENTITY_PROVIDER_ONLY, IDENTITY_PROVIDER_AND_DIRECTORY
    #     identity_center_configuration: { # required
    #       instance_arn: "InstanceArn", # required
    #       application_arn: "ApplicationArn", # required
    #     },
    #     personal_access_token_configuration: { # required
    #       status: "ACTIVE", # required, accepts ACTIVE, INACTIVE
    #       lifetime_in_days: 1,
    #     },
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutIdentityProviderConfiguration AWS API Documentation
    #
    # @overload put_identity_provider_configuration(params = {})
    # @param [Hash] params ({})
    def put_identity_provider_configuration(params = {}, options = {})
      req = build_request(:put_identity_provider_configuration, params)
      req.send_request(options)
    end

    # Enables or disables a DMARC policy for a given organization.
    #
    # @option params [required, String] :organization_id
    #   The ID of the organization that you are applying the DMARC policy to.
    #
    # @option params [required, Boolean] :enforced
    #   Enforces or suspends a policy after it's applied.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_inbound_dmarc_settings({
    #     organization_id: "OrganizationId", # required
    #     enforced: false, # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutInboundDmarcSettings AWS API Documentation
    #
    # @overload put_inbound_dmarc_settings(params = {})
    # @param [Hash] params ({})
    def put_inbound_dmarc_settings(params = {}, options = {})
      req = build_request(:put_inbound_dmarc_settings, params)
      req.send_request(options)
    end

    # Sets permissions for a user, group, or resource. This replaces any
    # pre-existing permissions.
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization under which the user, group, or
    #   resource exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier of the user or resource for which to update mailbox
    #   permissions.
    #
    #   The identifier can be *UserId, ResourceID, or Group Id*, *Username,
    #   Resourcename, or Groupname*, or *email*.
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [required, String] :grantee_id
    #   The identifier of the user, group, or resource to which to grant the
    #   permissions.
    #
    #   The identifier can be *UserId, ResourceID, or Group Id*, *Username,
    #   Resourcename, or Groupname*, or *email*.
    #
    #   * Grantee ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: grantee@domain.tld
    #
    #   * Grantee name: grantee
    #
    # @option params [required, Array<String>] :permission_values
    #   The permissions granted to the grantee. SEND\_AS allows the grantee to
    #   send email as the owner of the mailbox (the grantee is not mentioned
    #   on these emails). SEND\_ON\_BEHALF allows the grantee to send email on
    #   behalf of the owner of the mailbox (the grantee is not mentioned as
    #   the physical sender of these emails). FULL\_ACCESS allows the grantee
    #   full access to the mailbox, irrespective of other folder-level
    #   permissions set on the mailbox.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_mailbox_permissions({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     grantee_id: "EntityIdentifier", # required
    #     permission_values: ["FULL_ACCESS"], # required, accepts FULL_ACCESS, SEND_AS, SEND_ON_BEHALF
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMailboxPermissions AWS API Documentation
    #
    # @overload put_mailbox_permissions(params = {})
    # @param [Hash] params ({})
    def put_mailbox_permissions(params = {}, options = {})
      req = build_request(:put_mailbox_permissions, params)
      req.send_request(options)
    end

    # Creates or updates a mobile device access override for the given
    # WorkMail organization, user, and device.
    #
    # @option params [required, String] :organization_id
    #   Identifies the WorkMail organization for which you create the
    #   override.
    #
    # @option params [required, String] :user_id
    #   The WorkMail user for which you create the override. Accepts the
    #   following types of user identities:
    #
    #   * User ID: `12345678-1234-1234-1234-123456789012` or
    #     `S-1-1-12-1234567890-123456789-123456789-1234`
    #
    #   * Email address: `user@domain.tld`
    #
    #   * User name: `user`
    #
    # @option params [required, String] :device_id
    #   The mobile device for which you create the override. `DeviceId` is
    #   case insensitive.
    #
    # @option params [required, String] :effect
    #   The effect of the override, `ALLOW` or `DENY`.
    #
    # @option params [String] :description
    #   A description of the override.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_mobile_device_access_override({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #     device_id: "DeviceId", # required
    #     effect: "ALLOW", # required, accepts ALLOW, DENY
    #     description: "MobileDeviceAccessRuleDescription",
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutMobileDeviceAccessOverride AWS API Documentation
    #
    # @overload put_mobile_device_access_override(params = {})
    # @param [Hash] params ({})
    def put_mobile_device_access_override(params = {}, options = {})
      req = build_request(:put_mobile_device_access_override, params)
      req.send_request(options)
    end

    # Puts a retention policy to the specified organization.
    #
    # @option params [required, String] :organization_id
    #   The organization ID.
    #
    # @option params [String] :id
    #   The retention policy ID.
    #
    # @option params [required, String] :name
    #   The retention policy name.
    #
    # @option params [String] :description
    #   The retention policy description.
    #
    # @option params [required, Array<Types::FolderConfiguration>] :folder_configurations
    #   The retention policy folder configurations.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.put_retention_policy({
    #     organization_id: "OrganizationId", # required
    #     id: "ShortString",
    #     name: "ShortString", # required
    #     description: "PolicyDescription",
    #     folder_configurations: [ # required
    #       {
    #         name: "INBOX", # required, accepts INBOX, DELETED_ITEMS, SENT_ITEMS, DRAFTS, JUNK_EMAIL
    #         action: "NONE", # required, accepts NONE, DELETE, PERMANENTLY_DELETE
    #         period: 1,
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/PutRetentionPolicy AWS API Documentation
    #
    # @overload put_retention_policy(params = {})
    # @param [Hash] params ({})
    def put_retention_policy(params = {}, options = {})
      req = build_request(:put_retention_policy, params)
      req.send_request(options)
    end

    # Registers a new domain in WorkMail and SES, and configures it for use
    # by WorkMail. Emails received by SES for this domain are routed to the
    # specified WorkMail organization, and WorkMail has permanent permission
    # to use the specified domain for sending your users' emails.
    #
    # @option params [String] :client_token
    #   Idempotency token used when retrying requests.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which you're creating the domain.
    #
    # @option params [required, String] :domain_name
    #   The name of the mail domain to create in WorkMail and SES.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.register_mail_domain({
    #     client_token: "IdempotencyClientToken",
    #     organization_id: "OrganizationId", # required
    #     domain_name: "WorkMailDomainName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterMailDomain AWS API Documentation
    #
    # @overload register_mail_domain(params = {})
    # @param [Hash] params ({})
    def register_mail_domain(params = {}, options = {})
      req = build_request(:register_mail_domain, params)
      req.send_request(options)
    end

    # Registers an existing and disabled user, group, or resource for
    # WorkMail use by associating a mailbox and calendaring capabilities. It
    # performs no change if the user, group, or resource is enabled and
    # fails if the user, group, or resource is deleted. This operation
    # results in the accumulation of costs. For more information, see
    # [Pricing][1]. The equivalent console functionality for this operation
    # is *Enable*.
    #
    # Users can either be created by calling the CreateUser API operation or
    # they can be synchronized from your directory. For more information,
    # see DeregisterFromWorkMail.
    #
    #
    #
    # [1]: https://aws.amazon.com/workmail/pricing
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the user, group, or
    #   resource exists.
    #
    # @option params [required, String] :entity_id
    #   The identifier for the user, group, or resource to be updated.
    #
    #   The identifier can accept *UserId, ResourceId, or GroupId*, or
    #   *Username, Resourcename, or Groupname*. The following identity formats
    #   are available:
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Entity name: entity
    #
    # @option params [required, String] :email
    #   The email for the user, group, or resource to be updated.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.register_to_work_mail({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     email: "EmailAddress", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/RegisterToWorkMail AWS API Documentation
    #
    # @overload register_to_work_mail(params = {})
    # @param [Hash] params ({})
    def register_to_work_mail(params = {}, options = {})
      req = build_request(:register_to_work_mail, params)
      req.send_request(options)
    end

    # Allows the administrator to reset the password for a user.
    #
    # @option params [required, String] :organization_id
    #   The identifier of the organization that contains the user for which
    #   the password is reset.
    #
    # @option params [required, String] :user_id
    #   The identifier of the user for whom the password is reset.
    #
    # @option params [required, String] :password
    #   The new password for the user.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.reset_password({
    #     organization_id: "OrganizationId", # required
    #     user_id: "WorkMailIdentifier", # required
    #     password: "Password", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/ResetPassword AWS API Documentation
    #
    # @overload reset_password(params = {})
    # @param [Hash] params ({})
    def reset_password(params = {}, options = {})
      req = build_request(:reset_password, params)
      req.send_request(options)
    end

    # Starts a mailbox export job to export MIME-format email messages and
    # calendar items from the specified mailbox to the specified Amazon
    # Simple Storage Service (Amazon S3) bucket. For more information, see
    # [Exporting mailbox content][1] in the *WorkMail Administrator Guide*.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html
    #
    # @option params [required, String] :client_token
    #   The idempotency token for the client request.
    #
    #   **A suitable default value is auto-generated.** You should normally
    #   not need to pass this option.**
    #
    # @option params [required, String] :organization_id
    #   The identifier associated with the organization.
    #
    # @option params [required, String] :entity_id
    #   The identifier of the user or resource associated with the mailbox.
    #
    #   The identifier can accept *UserId or ResourceId*, *Username or
    #   Resourcename*, or *email*. The following identity formats are
    #   available:
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789 , or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [String] :description
    #   The mailbox export job description.
    #
    # @option params [required, String] :role_arn
    #   The ARN of the AWS Identity and Access Management (IAM) role that
    #   grants write permission to the S3 bucket.
    #
    # @option params [required, String] :kms_key_arn
    #   The Amazon Resource Name (ARN) of the symmetric AWS Key Management
    #   Service (AWS KMS) key that encrypts the exported mailbox content.
    #
    # @option params [required, String] :s3_bucket_name
    #   The name of the S3 bucket.
    #
    # @option params [required, String] :s3_prefix
    #   The S3 bucket prefix.
    #
    # @return [Types::StartMailboxExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::StartMailboxExportJobResponse#job_id #job_id} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.start_mailbox_export_job({
    #     client_token: "IdempotencyClientToken", # required
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     description: "Description",
    #     role_arn: "RoleArn", # required
    #     kms_key_arn: "KmsKeyArn", # required
    #     s3_bucket_name: "S3BucketName", # required
    #     s3_prefix: "S3ObjectKey", # required
    #   })
    #
    # @example Response structure
    #
    #   resp.job_id #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/StartMailboxExportJob AWS API Documentation
    #
    # @overload start_mailbox_export_job(params = {})
    # @param [Hash] params ({})
    def start_mailbox_export_job(params = {}, options = {})
      req = build_request(:start_mailbox_export_job, params)
      req.send_request(options)
    end

    # Applies the specified tags to the specified WorkMailorganization
    # resource.
    #
    # @option params [required, String] :resource_arn
    #   The resource ARN.
    #
    # @option params [required, Array<Types::Tag>] :tags
    #   The tag key-value pairs.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.tag_resource({
    #     resource_arn: "AmazonResourceName", # required
    #     tags: [ # required
    #       {
    #         key: "TagKey", # required
    #         value: "TagValue", # required
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/TagResource AWS API Documentation
    #
    # @overload tag_resource(params = {})
    # @param [Hash] params ({})
    def tag_resource(params = {}, options = {})
      req = build_request(:tag_resource, params)
      req.send_request(options)
    end

    # Performs a test on an availability provider to ensure that access is
    # allowed. For EWS, it verifies the provided credentials can be used to
    # successfully log in. For Lambda, it verifies that the Lambda function
    # can be invoked and that the resource access policy was configured to
    # deny anonymous access. An anonymous invocation is one done without
    # providing either a `SourceArn` or `SourceAccount` header.
    #
    # <note markdown="1"> The request must contain either one provider definition (`EwsProvider`
    # or `LambdaProvider`) or the `DomainName` parameter. If the
    # `DomainName` parameter is provided, the configuration stored under the
    # `DomainName` will be tested.
    #
    #  </note>
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization where the availability provider will be
    #   tested.
    #
    # @option params [String] :domain_name
    #   The domain to which the provider applies. If this field is provided, a
    #   stored availability provider associated to this domain name will be
    #   tested.
    #
    # @option params [Types::EwsAvailabilityProvider] :ews_provider
    #   Describes an EWS based availability provider. This is only used as
    #   input to the service.
    #
    # @option params [Types::LambdaAvailabilityProvider] :lambda_provider
    #   Describes a Lambda based availability provider.
    #
    # @return [Types::TestAvailabilityConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
    #
    #   * {Types::TestAvailabilityConfigurationResponse#test_passed #test_passed} => Boolean
    #   * {Types::TestAvailabilityConfigurationResponse#failure_reason #failure_reason} => String
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.test_availability_configuration({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "DomainName",
    #     ews_provider: {
    #       ews_endpoint: "Url", # required
    #       ews_username: "ExternalUserName", # required
    #       ews_password: "Password", # required
    #     },
    #     lambda_provider: {
    #       lambda_arn: "LambdaArn", # required
    #     },
    #   })
    #
    # @example Response structure
    #
    #   resp.test_passed #=> Boolean
    #   resp.failure_reason #=> String
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/TestAvailabilityConfiguration AWS API Documentation
    #
    # @overload test_availability_configuration(params = {})
    # @param [Hash] params ({})
    def test_availability_configuration(params = {}, options = {})
      req = build_request(:test_availability_configuration, params)
      req.send_request(options)
    end

    # Untags the specified tags from the specified WorkMail organization
    # resource.
    #
    # @option params [required, String] :resource_arn
    #   The resource ARN.
    #
    # @option params [required, Array<String>] :tag_keys
    #   The tag keys.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.untag_resource({
    #     resource_arn: "AmazonResourceName", # required
    #     tag_keys: ["TagKey"], # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UntagResource AWS API Documentation
    #
    # @overload untag_resource(params = {})
    # @param [Hash] params ({})
    def untag_resource(params = {}, options = {})
      req = build_request(:untag_resource, params)
      req.send_request(options)
    end

    # Updates an existing `AvailabilityConfiguration` for the given WorkMail
    # organization and domain.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which the `AvailabilityConfiguration`
    #   will be updated.
    #
    # @option params [required, String] :domain_name
    #   The domain to which the provider applies the availability
    #   configuration.
    #
    # @option params [Types::EwsAvailabilityProvider] :ews_provider
    #   The EWS availability provider definition. The request must contain
    #   exactly one provider definition, either `EwsProvider` or
    #   `LambdaProvider`. The previously stored provider will be overridden by
    #   the one provided.
    #
    # @option params [Types::LambdaAvailabilityProvider] :lambda_provider
    #   The Lambda availability provider definition. The request must contain
    #   exactly one provider definition, either `EwsProvider` or
    #   `LambdaProvider`. The previously stored provider will be overridden by
    #   the one provided.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_availability_configuration({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "DomainName", # required
    #     ews_provider: {
    #       ews_endpoint: "Url", # required
    #       ews_username: "ExternalUserName", # required
    #       ews_password: "Password", # required
    #     },
    #     lambda_provider: {
    #       lambda_arn: "LambdaArn", # required
    #     },
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateAvailabilityConfiguration AWS API Documentation
    #
    # @overload update_availability_configuration(params = {})
    # @param [Hash] params ({})
    def update_availability_configuration(params = {}, options = {})
      req = build_request(:update_availability_configuration, params)
      req.send_request(options)
    end

    # Updates the default mail domain for an organization. The default mail
    # domain is used by the WorkMail AWS Console to suggest an email address
    # when enabling a mail user. You can only have one default domain.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization for which to list domains.
    #
    # @option params [required, String] :domain_name
    #   The domain name that will become the default domain.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_default_mail_domain({
    #     organization_id: "OrganizationId", # required
    #     domain_name: "WorkMailDomainName", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateDefaultMailDomain AWS API Documentation
    #
    # @overload update_default_mail_domain(params = {})
    # @param [Hash] params ({})
    def update_default_mail_domain(params = {}, options = {})
      req = build_request(:update_default_mail_domain, params)
      req.send_request(options)
    end

    # Updates attributes in a group.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the group exists.
    #
    # @option params [required, String] :group_id
    #   The identifier for the group to be updated.
    #
    #   The identifier can accept *GroupId*, *Groupname*, or *email*. The
    #   following identity formats are available:
    #
    #   * Group ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: group@domain.tld
    #
    #   * Group name: group
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If enabled, the group is hidden from the global address list.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_group({
    #     organization_id: "OrganizationId", # required
    #     group_id: "EntityIdentifier", # required
    #     hidden_from_global_address_list: false,
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateGroup AWS API Documentation
    #
    # @overload update_group(params = {})
    # @param [Hash] params ({})
    def update_group(params = {}, options = {})
      req = build_request(:update_group, params)
      req.send_request(options)
    end

    # Updates an impersonation role for the given WorkMail organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization that contains the impersonation role to
    #   update.
    #
    # @option params [required, String] :impersonation_role_id
    #   The ID of the impersonation role to update.
    #
    # @option params [required, String] :name
    #   The updated impersonation role name.
    #
    # @option params [required, String] :type
    #   The updated impersonation role type.
    #
    # @option params [String] :description
    #   The updated impersonation role description.
    #
    # @option params [required, Array<Types::ImpersonationRule>] :rules
    #   The updated list of rules.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_impersonation_role({
    #     organization_id: "OrganizationId", # required
    #     impersonation_role_id: "ImpersonationRoleId", # required
    #     name: "ImpersonationRoleName", # required
    #     type: "FULL_ACCESS", # required, accepts FULL_ACCESS, READ_ONLY
    #     description: "ImpersonationRoleDescription",
    #     rules: [ # required
    #       {
    #         impersonation_rule_id: "ImpersonationRuleId", # required
    #         name: "ImpersonationRuleName",
    #         description: "ImpersonationRuleDescription",
    #         effect: "ALLOW", # required, accepts ALLOW, DENY
    #         target_users: ["EntityIdentifier"],
    #         not_target_users: ["EntityIdentifier"],
    #       },
    #     ],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateImpersonationRole AWS API Documentation
    #
    # @overload update_impersonation_role(params = {})
    # @param [Hash] params ({})
    def update_impersonation_role(params = {}, options = {})
      req = build_request(:update_impersonation_role, params)
      req.send_request(options)
    end

    # Updates a user's current mailbox quota for a specified organization
    # and user.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization that contains the user for whom to
    #   update the mailbox quota.
    #
    # @option params [required, String] :user_id
    #   The identifer for the user for whom to update the mailbox quota.
    #
    #   The identifier can be the *UserId*, *Username*, or *email*. The
    #   following identity formats are available:
    #
    #   * User ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: user@domain.tld
    #
    #   * User name: user
    #
    # @option params [required, Integer] :mailbox_quota
    #   The updated mailbox quota, in MB, for the specified user.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_mailbox_quota({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #     mailbox_quota: 1, # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMailboxQuota AWS API Documentation
    #
    # @overload update_mailbox_quota(params = {})
    # @param [Hash] params ({})
    def update_mailbox_quota(params = {}, options = {})
      req = build_request(:update_mailbox_quota, params)
      req.send_request(options)
    end

    # Updates a mobile device access rule for the specified WorkMail
    # organization.
    #
    # @option params [required, String] :organization_id
    #   The WorkMail organization under which the rule will be updated.
    #
    # @option params [required, String] :mobile_device_access_rule_id
    #   The identifier of the rule to be updated.
    #
    # @option params [required, String] :name
    #   The updated rule name.
    #
    # @option params [String] :description
    #   The updated rule description.
    #
    # @option params [required, String] :effect
    #   The effect of the rule when it matches. Allowed values are `ALLOW` or
    #   `DENY`.
    #
    # @option params [Array<String>] :device_types
    #   Device types that the updated rule will match.
    #
    # @option params [Array<String>] :not_device_types
    #   Device types that the updated rule **will not** match. All other
    #   device types will match.
    #
    # @option params [Array<String>] :device_models
    #   Device models that the updated rule will match.
    #
    # @option params [Array<String>] :not_device_models
    #   Device models that the updated rule **will not** match. All other
    #   device models will match.
    #
    # @option params [Array<String>] :device_operating_systems
    #   Device operating systems that the updated rule will match.
    #
    # @option params [Array<String>] :not_device_operating_systems
    #   Device operating systems that the updated rule **will not** match. All
    #   other device operating systems will match.
    #
    # @option params [Array<String>] :device_user_agents
    #   User agents that the updated rule will match.
    #
    # @option params [Array<String>] :not_device_user_agents
    #   User agents that the updated rule **will not** match. All other user
    #   agents will match.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_mobile_device_access_rule({
    #     organization_id: "OrganizationId", # required
    #     mobile_device_access_rule_id: "MobileDeviceAccessRuleId", # required
    #     name: "MobileDeviceAccessRuleName", # required
    #     description: "MobileDeviceAccessRuleDescription",
    #     effect: "ALLOW", # required, accepts ALLOW, DENY
    #     device_types: ["DeviceType"],
    #     not_device_types: ["DeviceType"],
    #     device_models: ["DeviceModel"],
    #     not_device_models: ["DeviceModel"],
    #     device_operating_systems: ["DeviceOperatingSystem"],
    #     not_device_operating_systems: ["DeviceOperatingSystem"],
    #     device_user_agents: ["DeviceUserAgent"],
    #     not_device_user_agents: ["DeviceUserAgent"],
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateMobileDeviceAccessRule AWS API Documentation
    #
    # @overload update_mobile_device_access_rule(params = {})
    # @param [Hash] params ({})
    def update_mobile_device_access_rule(params = {}, options = {})
      req = build_request(:update_mobile_device_access_rule, params)
      req.send_request(options)
    end

    # Updates the primary email for a user, group, or resource. The current
    # email is moved into the list of aliases (or swapped between an
    # existing alias and the current primary email), and the email provided
    # in the input is promoted as the primary.
    #
    # @option params [required, String] :organization_id
    #   The organization that contains the user, group, or resource to update.
    #
    # @option params [required, String] :entity_id
    #   The user, group, or resource to update.
    #
    #   The identifier can accept *UseriD, ResourceId, or GroupId*, *Username,
    #   Resourcename, or Groupname*, or *email*. The following identity
    #   formats are available:
    #
    #   * Entity ID: 12345678-1234-1234-1234-123456789012,
    #     r-0123456789a0123456789b0123456789, or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: entity@domain.tld
    #
    #   * Entity name: entity
    #
    # @option params [required, String] :email
    #   The value of the email to be updated as primary.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_primary_email_address({
    #     organization_id: "OrganizationId", # required
    #     entity_id: "EntityIdentifier", # required
    #     email: "EmailAddress", # required
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdatePrimaryEmailAddress AWS API Documentation
    #
    # @overload update_primary_email_address(params = {})
    # @param [Hash] params ({})
    def update_primary_email_address(params = {}, options = {})
      req = build_request(:update_primary_email_address, params)
      req.send_request(options)
    end

    # Updates data for the resource. To have the latest information, it must
    # be preceded by a DescribeResource call. The dataset in the request
    # should be the one expected when performing another `DescribeResource`
    # call.
    #
    # @option params [required, String] :organization_id
    #   The identifier associated with the organization for which the resource
    #   is updated.
    #
    # @option params [required, String] :resource_id
    #   The identifier of the resource to be updated.
    #
    #   The identifier can accept *ResourceId*, *Resourcename*, or *email*.
    #   The following identity formats are available:
    #
    #   * Resource ID: r-0123456789a0123456789b0123456789
    #
    #   * Email address: resource@domain.tld
    #
    #   * Resource name: resource
    #
    # @option params [String] :name
    #   The name of the resource to be updated.
    #
    # @option params [Types::BookingOptions] :booking_options
    #   The resource's booking options to be updated.
    #
    # @option params [String] :description
    #   Updates the resource description.
    #
    # @option params [String] :type
    #   Updates the resource type.
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If enabled, the resource is hidden from the global address list.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_resource({
    #     organization_id: "OrganizationId", # required
    #     resource_id: "EntityIdentifier", # required
    #     name: "ResourceName",
    #     booking_options: {
    #       auto_accept_requests: false,
    #       auto_decline_recurring_requests: false,
    #       auto_decline_conflicting_requests: false,
    #     },
    #     description: "NewResourceDescription",
    #     type: "ROOM", # accepts ROOM, EQUIPMENT
    #     hidden_from_global_address_list: false,
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateResource AWS API Documentation
    #
    # @overload update_resource(params = {})
    # @param [Hash] params ({})
    def update_resource(params = {}, options = {})
      req = build_request(:update_resource, params)
      req.send_request(options)
    end

    # Updates data for the user. To have the latest information, it must be
    # preceded by a DescribeUser call. The dataset in the request should be
    # the one expected when performing another `DescribeUser` call.
    #
    # @option params [required, String] :organization_id
    #   The identifier for the organization under which the user exists.
    #
    # @option params [required, String] :user_id
    #   The identifier for the user to be updated.
    #
    #   The identifier can be the *UserId*, *Username*, or *email*. The
    #   following identity formats are available:
    #
    #   * User ID: 12345678-1234-1234-1234-123456789012 or
    #     S-1-1-12-1234567890-123456789-123456789-1234
    #
    #   * Email address: user@domain.tld
    #
    #   * User name: user
    #
    # @option params [String] :role
    #   Updates the user role.
    #
    #   You cannot pass *SYSTEM\_USER* or *RESOURCE*.
    #
    # @option params [String] :display_name
    #   Updates the display name of the user.
    #
    # @option params [String] :first_name
    #   Updates the user's first name.
    #
    # @option params [String] :last_name
    #   Updates the user's last name.
    #
    # @option params [Boolean] :hidden_from_global_address_list
    #   If enabled, the user is hidden from the global address list.
    #
    # @option params [String] :initials
    #   Updates the user's initials.
    #
    # @option params [String] :telephone
    #   Updates the user's contact details.
    #
    # @option params [String] :street
    #   Updates the user's street address.
    #
    # @option params [String] :job_title
    #   Updates the user's job title.
    #
    # @option params [String] :city
    #   Updates the user's city.
    #
    # @option params [String] :company
    #   Updates the user's company.
    #
    # @option params [String] :zip_code
    #   Updates the user's zip code.
    #
    # @option params [String] :department
    #   Updates the user's department.
    #
    # @option params [String] :country
    #   Updates the user's country.
    #
    # @option params [String] :office
    #   Updates the user's office.
    #
    # @option params [String] :identity_provider_user_id
    #   User ID from the IAM Identity Center. If this parameter is empty it
    #   will be updated automatically when the user logs in for the first time
    #   to the mailbox associated with WorkMail.
    #
    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
    #
    # @example Request syntax with placeholder values
    #
    #   resp = client.update_user({
    #     organization_id: "OrganizationId", # required
    #     user_id: "EntityIdentifier", # required
    #     role: "USER", # accepts USER, RESOURCE, SYSTEM_USER, REMOTE_USER
    #     display_name: "UserAttribute",
    #     first_name: "UserAttribute",
    #     last_name: "UserAttribute",
    #     hidden_from_global_address_list: false,
    #     initials: "UserAttribute",
    #     telephone: "UserAttribute",
    #     street: "UserAttribute",
    #     job_title: "UserAttribute",
    #     city: "UserAttribute",
    #     company: "UserAttribute",
    #     zip_code: "UserAttribute",
    #     department: "UserAttribute",
    #     country: "UserAttribute",
    #     office: "UserAttribute",
    #     identity_provider_user_id: "IdentityProviderUserIdForUpdate",
    #   })
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateUser AWS API Documentation
    #
    # @overload update_user(params = {})
    # @param [Hash] params ({})
    def update_user(params = {}, options = {})
      req = build_request(:update_user, params)
      req.send_request(options)
    end

    # @!endgroup

    # @param params ({})
    # @api private
    def build_request(operation_name, params = {})
      handlers = @handlers.for(operation_name)
      tracer = config.telemetry_provider.tracer_provider.tracer(
        Aws::Telemetry.module_to_tracer_name('Aws::WorkMail')
      )
      context = Seahorse::Client::RequestContext.new(
        operation_name: operation_name,
        operation: config.api.operation(operation_name),
        client: self,
        params: params,
        config: config,
        tracer: tracer
      )
      context[:gem_name] = 'aws-sdk-workmail'
      context[:gem_version] = '1.90.0'
      Seahorse::Client::Request.new(handlers, context)
    end

    # @api private
    # @deprecated
    def waiter_names
      []
    end

    class << self

      # @api private
      attr_reader :identifier

      # @api private
      def errors_module
        Errors
      end

    end
  end
end
