aws-sdk-comprehendmedical 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89c3a50e8efdcee880e09f09dc7129657b7ebdad
+  data.tar.gz: e6fef0c38d6b589cb3e0def5c6ed8cb7c608c273
+SHA512:
+  metadata.gz: cafde98c1ba7320b3438fddf659c6c9bb1614b0aca766738b1641eb8984e0fbfa002ddd1c85c90a45033e0b9ad06bbc8392a84aad6d46110b3ab0a17c059efb0
+  data.tar.gz: 5ad499591f5c13ed803990b5123ab78489ad911691cd7279b757c459db0d9b6fd92a1add7624f56edf0c90d1c36f100827af72340807dd4ec9f8fc23f289f8fb

data/lib/aws-sdk-comprehendmedical.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-comprehendmedical/types'
+require_relative 'aws-sdk-comprehendmedical/client_api'
+require_relative 'aws-sdk-comprehendmedical/client'
+require_relative 'aws-sdk-comprehendmedical/errors'
+require_relative 'aws-sdk-comprehendmedical/resource'
+require_relative 'aws-sdk-comprehendmedical/customizations'
+
+# This module provides support for AWS Comprehend Medical. This module is available in the
+# `aws-sdk-comprehendmedical` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS Comprehend Medical all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::ComprehendMedical::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::ComprehendMedical
+
+  GEM_VERSION = '1.0.0'
+
+end

data/lib/aws-sdk-comprehendmedical/client.rb

@@ -0,0 +1,376 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
+require 'aws-sdk-core/plugins/endpoint_pattern.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
+require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:comprehendmedical)
+
+module Aws::ComprehendMedical
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :comprehendmedical
+
+    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::JsonvalueConverter)
+    add_plugin(Aws::Plugins::ClientMetricsPlugin)
+    add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
+    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Protocols::JsonRpc)
+
+    # @overload initialize(options)
+    #   @param [Hash] options
+    #   @option options [required, Aws::CredentialProvider] :credentials
+    #     Your AWS credentials. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #       credentials.
+    #
+    #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #       from an EC2 IMDS on an EC2 instance.
+    #
+    #     * `Aws::SharedCredentials` - Used for loading credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     When `:credentials` are not configured directly, the following
+    #     locations will be searched for credentials:
+    #
+    #     * `Aws.config[:credentials]`
+    #     * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #     * `~/.aws/credentials`
+    #     * `~/.aws/config`
+    #     * EC2 IMDS instance profile - When used by default, the timeouts are
+    #       very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` to enable retries and extended
+    #       timeouts.
+    #
+    #   @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 search 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 [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] :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 [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] :disable_host_prefix_injection (false)
+    #     Set to true to disable SDK automatically adding host prefix
+    #     to default service endpoint when available.
+    #
+    #   @option options [String] :endpoint
+    #     The client endpoint is normally constructed from the `:region`
+    #     option. You should only configure an `:endpoint` when connecting
+    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #
+    #   @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. Defaults to `false`.
+    #
+    #   @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 [String] :profile ("default")
+    #     Used when loading credentials from the shared credentials file
+    #     at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #
+    #   @option options [Float] :retry_base_delay (0.3)
+    #     The base delay in seconds used by the default backoff function.
+    #
+    #   @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.
+    #
+    #     @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 and auth
+    #     errors from expired credentials.
+    #
+    #   @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.
+    #
+    #   @option options [String] :secret_access_key
+    #
+    #   @option options [String] :session_token
+    #
+    #   @option options [Boolean] :simple_json (false)
+    #     Disables request parameter conversion, validation, and formatting.
+    #     Also disable response data type conversions. 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.
+    #
+    #     When `:simple_json` is enabled, the request parameters hash must
+    #     be formatted exactly as the DynamoDB API expects.
+    #
+    #   @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 [Boolean] :validate_params (true)
+    #     When `true`, request parameters are validated before
+    #     sending the request.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Inspects the clinical text for a variety of medical entities and
+    # returns specific information about them such as entity category,
+    # location, and confidence score on that information .
+    #
+    # @option params [required, String] :text
+    #   A UTF-8 text string containing the clinical content being examined for
+    #   entities. Each string must contain fewer than 20,000 bytes of
+    #   characters.
+    #
+    # @return [Types::DetectEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DetectEntitiesResponse#entities #entities} => Array&lt;Types::Entity&gt;
+    #   * {Types::DetectEntitiesResponse#unmapped_attributes #unmapped_attributes} => Array&lt;Types::UnmappedAttribute&gt;
+    #   * {Types::DetectEntitiesResponse#pagination_token #pagination_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.detect_entities({
+    #     text: "BoundedLengthString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.entities #=> Array
+    #   resp.entities[0].id #=> Integer
+    #   resp.entities[0].begin_offset #=> Integer
+    #   resp.entities[0].end_offset #=> Integer
+    #   resp.entities[0].score #=> Float
+    #   resp.entities[0].text #=> String
+    #   resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
+    #   resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
+    #   resp.entities[0].traits #=> Array
+    #   resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
+    #   resp.entities[0].traits[0].score #=> Float
+    #   resp.entities[0].attributes #=> Array
+    #   resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
+    #   resp.entities[0].attributes[0].score #=> Float
+    #   resp.entities[0].attributes[0].relationship_score #=> Float
+    #   resp.entities[0].attributes[0].id #=> Integer
+    #   resp.entities[0].attributes[0].begin_offset #=> Integer
+    #   resp.entities[0].attributes[0].end_offset #=> Integer
+    #   resp.entities[0].attributes[0].text #=> String
+    #   resp.entities[0].attributes[0].traits #=> Array
+    #   resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
+    #   resp.entities[0].attributes[0].traits[0].score #=> Float
+    #   resp.unmapped_attributes #=> Array
+    #   resp.unmapped_attributes[0].type #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
+    #   resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
+    #   resp.unmapped_attributes[0].attribute.score #=> Float
+    #   resp.unmapped_attributes[0].attribute.relationship_score #=> Float
+    #   resp.unmapped_attributes[0].attribute.id #=> Integer
+    #   resp.unmapped_attributes[0].attribute.begin_offset #=> Integer
+    #   resp.unmapped_attributes[0].attribute.end_offset #=> Integer
+    #   resp.unmapped_attributes[0].attribute.text #=> String
+    #   resp.unmapped_attributes[0].attribute.traits #=> Array
+    #   resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
+    #   resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
+    #   resp.pagination_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntities AWS API Documentation
+    #
+    # @overload detect_entities(params = {})
+    # @param [Hash] params ({})
+    def detect_entities(params = {}, options = {})
+      req = build_request(:detect_entities, params)
+      req.send_request(options)
+    end
+
+    # Inspects the clinical text for personal health information (PHI)
+    # entities and entity category, location, and confidence score on that
+    # information.
+    #
+    # @option params [required, String] :text
+    #   A UTF-8 text string containing the clinical content being examined for
+    #   PHI entities. Each string must contain fewer than 20,000 bytes of
+    #   characters.
+    #
+    # @return [Types::DetectPHIResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DetectPHIResponse#entities #entities} => Array&lt;Types::Entity&gt;
+    #   * {Types::DetectPHIResponse#pagination_token #pagination_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.detect_phi({
+    #     text: "BoundedLengthString", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.entities #=> Array
+    #   resp.entities[0].id #=> Integer
+    #   resp.entities[0].begin_offset #=> Integer
+    #   resp.entities[0].end_offset #=> Integer
+    #   resp.entities[0].score #=> Float
+    #   resp.entities[0].text #=> String
+    #   resp.entities[0].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY"
+    #   resp.entities[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
+    #   resp.entities[0].traits #=> Array
+    #   resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
+    #   resp.entities[0].traits[0].score #=> Float
+    #   resp.entities[0].attributes #=> Array
+    #   resp.entities[0].attributes[0].type #=> String, one of "NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "EMAIL", "IDENTIFIER", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY"
+    #   resp.entities[0].attributes[0].score #=> Float
+    #   resp.entities[0].attributes[0].relationship_score #=> Float
+    #   resp.entities[0].attributes[0].id #=> Integer
+    #   resp.entities[0].attributes[0].begin_offset #=> Integer
+    #   resp.entities[0].attributes[0].end_offset #=> Integer
+    #   resp.entities[0].attributes[0].text #=> String
+    #   resp.entities[0].attributes[0].traits #=> Array
+    #   resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION"
+    #   resp.entities[0].attributes[0].traits[0].score #=> Float
+    #   resp.pagination_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHI AWS API Documentation
+    #
+    # @overload detect_phi(params = {})
+    # @param [Hash] params ({})
+    def detect_phi(params = {}, options = {})
+      req = build_request(:detect_phi, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-comprehendmedical'
+      context[:gem_version] = '1.0.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

data/lib/aws-sdk-comprehendmedical/client_api.rb

@@ -0,0 +1,142 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::ComprehendMedical
+  # @api private
+  module ClientApi
+
+    include Seahorse::Model
+
+    Attribute = Shapes::StructureShape.new(name: 'Attribute')
+    AttributeList = Shapes::ListShape.new(name: 'AttributeList')
+    AttributeName = Shapes::StringShape.new(name: 'AttributeName')
+    BoundedLengthString = Shapes::StringShape.new(name: 'BoundedLengthString')
+    DetectEntitiesRequest = Shapes::StructureShape.new(name: 'DetectEntitiesRequest')
+    DetectEntitiesResponse = Shapes::StructureShape.new(name: 'DetectEntitiesResponse')
+    DetectPHIRequest = Shapes::StructureShape.new(name: 'DetectPHIRequest')
+    DetectPHIResponse = Shapes::StructureShape.new(name: 'DetectPHIResponse')
+    Entity = Shapes::StructureShape.new(name: 'Entity')
+    EntityList = Shapes::ListShape.new(name: 'EntityList')
+    EntitySubType = Shapes::StringShape.new(name: 'EntitySubType')
+    EntityType = Shapes::StringShape.new(name: 'EntityType')
+    Float = Shapes::FloatShape.new(name: 'Float')
+    Integer = Shapes::IntegerShape.new(name: 'Integer')
+    InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
+    InvalidEncodingException = Shapes::StructureShape.new(name: 'InvalidEncodingException')
+    InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
+    ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
+    String = Shapes::StringShape.new(name: 'String')
+    TextSizeLimitExceededException = Shapes::StructureShape.new(name: 'TextSizeLimitExceededException')
+    TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
+    Trait = Shapes::StructureShape.new(name: 'Trait')
+    TraitList = Shapes::ListShape.new(name: 'TraitList')
+    UnmappedAttribute = Shapes::StructureShape.new(name: 'UnmappedAttribute')
+    UnmappedAttributeList = Shapes::ListShape.new(name: 'UnmappedAttributeList')
+
+    Attribute.add_member(:type, Shapes::ShapeRef.new(shape: EntitySubType, location_name: "Type"))
+    Attribute.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    Attribute.add_member(:relationship_score, Shapes::ShapeRef.new(shape: Float, location_name: "RelationshipScore"))
+    Attribute.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
+    Attribute.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
+    Attribute.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
+    Attribute.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
+    Attribute.add_member(:traits, Shapes::ShapeRef.new(shape: TraitList, location_name: "Traits"))
+    Attribute.struct_class = Types::Attribute
+
+    AttributeList.member = Shapes::ShapeRef.new(shape: Attribute)
+
+    DetectEntitiesRequest.add_member(:text, Shapes::ShapeRef.new(shape: BoundedLengthString, required: true, location_name: "Text"))
+    DetectEntitiesRequest.struct_class = Types::DetectEntitiesRequest
+
+    DetectEntitiesResponse.add_member(:entities, Shapes::ShapeRef.new(shape: EntityList, required: true, location_name: "Entities"))
+    DetectEntitiesResponse.add_member(:unmapped_attributes, Shapes::ShapeRef.new(shape: UnmappedAttributeList, location_name: "UnmappedAttributes"))
+    DetectEntitiesResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
+    DetectEntitiesResponse.struct_class = Types::DetectEntitiesResponse
+
+    DetectPHIRequest.add_member(:text, Shapes::ShapeRef.new(shape: BoundedLengthString, required: true, location_name: "Text"))
+    DetectPHIRequest.struct_class = Types::DetectPHIRequest
+
+    DetectPHIResponse.add_member(:entities, Shapes::ShapeRef.new(shape: EntityList, required: true, location_name: "Entities"))
+    DetectPHIResponse.add_member(:pagination_token, Shapes::ShapeRef.new(shape: String, location_name: "PaginationToken"))
+    DetectPHIResponse.struct_class = Types::DetectPHIResponse
+
+    Entity.add_member(:id, Shapes::ShapeRef.new(shape: Integer, location_name: "Id"))
+    Entity.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
+    Entity.add_member(:end_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "EndOffset"))
+    Entity.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    Entity.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "Text"))
+    Entity.add_member(:category, Shapes::ShapeRef.new(shape: EntityType, location_name: "Category"))
+    Entity.add_member(:type, Shapes::ShapeRef.new(shape: EntitySubType, location_name: "Type"))
+    Entity.add_member(:traits, Shapes::ShapeRef.new(shape: TraitList, location_name: "Traits"))
+    Entity.add_member(:attributes, Shapes::ShapeRef.new(shape: AttributeList, location_name: "Attributes"))
+    Entity.struct_class = Types::Entity
+
+    EntityList.member = Shapes::ShapeRef.new(shape: Entity)
+
+    Trait.add_member(:name, Shapes::ShapeRef.new(shape: AttributeName, location_name: "Name"))
+    Trait.add_member(:score, Shapes::ShapeRef.new(shape: Float, location_name: "Score"))
+    Trait.struct_class = Types::Trait
+
+    TraitList.member = Shapes::ShapeRef.new(shape: Trait)
+
+    UnmappedAttribute.add_member(:type, Shapes::ShapeRef.new(shape: EntityType, location_name: "Type"))
+    UnmappedAttribute.add_member(:attribute, Shapes::ShapeRef.new(shape: Attribute, location_name: "Attribute"))
+    UnmappedAttribute.struct_class = Types::UnmappedAttribute
+
+    UnmappedAttributeList.member = Shapes::ShapeRef.new(shape: UnmappedAttribute)
+
+
+    # @api private
+    API = Seahorse::Model::Api.new.tap do |api|
+
+      api.version = "2018-10-30"
+
+      api.metadata = {
+        "apiVersion" => "2018-10-30",
+        "endpointPrefix" => "comprehendmedical",
+        "jsonVersion" => "1.1",
+        "protocol" => "json",
+        "serviceAbbreviation" => "ComprehendMedical",
+        "serviceFullName" => "AWS Comprehend Medical",
+        "serviceId" => "ComprehendMedical",
+        "signatureVersion" => "v4",
+        "signingName" => "comprehendmedical",
+        "targetPrefix" => "ComprehendMedical_20181030",
+        "uid" => "comprehendmedical-2018-10-30",
+      }
+
+      api.add_operation(:detect_entities, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DetectEntities"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DetectEntitiesRequest)
+        o.output = Shapes::ShapeRef.new(shape: DetectEntitiesResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
+        o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
+      end)
+
+      api.add_operation(:detect_phi, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DetectPHI"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: DetectPHIRequest)
+        o.output = Shapes::ShapeRef.new(shape: DetectPHIResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidEncodingException)
+        o.errors << Shapes::ShapeRef.new(shape: TextSizeLimitExceededException)
+      end)
+    end
+
+  end
+end

data/lib/aws-sdk-comprehendmedical/errors.rb

@@ -0,0 +1,14 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::ComprehendMedical
+  module Errors
+
+    extend Aws::Errors::DynamicErrors
+
+  end
+end

data/lib/aws-sdk-comprehendmedical/resource.rb

@@ -0,0 +1,23 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::ComprehendMedical
+  class Resource
+
+    # @param options ({})
+    # @option options [Client] :client
+    def initialize(options = {})
+      @client = options[:client] || Client.new(options)
+    end
+
+    # @return [Client]
+    def client
+      @client
+    end
+
+  end
+end

data/lib/aws-sdk-comprehendmedical/types.rb

@@ -0,0 +1,263 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::ComprehendMedical
+  module Types
+
+    # An extracted segment of the text that is an attribute of an entity, or
+    # otherwise related to an entity, such as the dosage of a medication
+    # taken. It contains information about the attribute such as id, begin
+    # and end offset within the input text, and the segment of the input
+    # text.
+    #
+    # @!attribute [rw] type
+    #   The type of attribute.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   The level of confidence that Comprehend Medical has that the segment
+    #   of text is correctly recognized as an attribute.
+    #   @return [Float]
+    #
+    # @!attribute [rw] relationship_score
+    #   The level of confidence that Comprehend Medical has that this
+    #   attribute is correctly related to this entity.
+    #   @return [Float]
+    #
+    # @!attribute [rw] id
+    #   The numeric identifier for this attribute. This is a monotonically
+    #   increasing id unique within this response rather than a global
+    #   unique identifier.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] begin_offset
+    #   The 0-based character offset in the input text that shows where the
+    #   attribute begins. The offset returns the UTF-8 code point in the
+    #   string.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_offset
+    #   The 0-based character offset in the input text that shows where the
+    #   attribute ends. The offset returns the UTF-8 code point in the
+    #   string.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] text
+    #   The segment of input text extracted as this attribute.
+    #   @return [String]
+    #
+    # @!attribute [rw] traits
+    #   Contextual information for this attribute.
+    #   @return [Array<Types::Trait>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Attribute AWS API Documentation
+    #
+    class Attribute < Struct.new(
+      :type,
+      :score,
+      :relationship_score,
+      :id,
+      :begin_offset,
+      :end_offset,
+      :text,
+      :traits)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DetectEntitiesRequest
+    #   data as a hash:
+    #
+    #       {
+    #         text: "BoundedLengthString", # required
+    #       }
+    #
+    # @!attribute [rw] text
+    #   A UTF-8 text string containing the clinical content being examined
+    #   for entities. Each string must contain fewer than 20,000 bytes of
+    #   characters.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesRequest AWS API Documentation
+    #
+    class DetectEntitiesRequest < Struct.new(
+      :text)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] entities
+    #   The collection of medical entities extracted from the input text and
+    #   their associated information. For each entity, the response provides
+    #   the entity text, the entity category, where the entity text begins
+    #   and ends, and the level of confidence that Comprehend Medical has in
+    #   the detection and analysis. Attributes and traits of the entity are
+    #   also returned.
+    #   @return [Array<Types::Entity>]
+    #
+    # @!attribute [rw] unmapped_attributes
+    #   Attributes extracted from the input text that we were unable to
+    #   relate to an entity.
+    #   @return [Array<Types::UnmappedAttribute>]
+    #
+    # @!attribute [rw] pagination_token
+    #   If the result of the previous request to DetectEntities was
+    #   truncated, include the Paginationtoken to fetch the next page of
+    #   entities.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesResponse AWS API Documentation
+    #
+    class DetectEntitiesResponse < Struct.new(
+      :entities,
+      :unmapped_attributes,
+      :pagination_token)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DetectPHIRequest
+    #   data as a hash:
+    #
+    #       {
+    #         text: "BoundedLengthString", # required
+    #       }
+    #
+    # @!attribute [rw] text
+    #   A UTF-8 text string containing the clinical content being examined
+    #   for PHI entities. Each string must contain fewer than 20,000 bytes
+    #   of characters.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIRequest AWS API Documentation
+    #
+    class DetectPHIRequest < Struct.new(
+      :text)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] entities
+    #   The collection of PHI entities extracted from the input text and
+    #   their associated information. For each entity, the response provides
+    #   the entity text, the entity category, where the entity text begins
+    #   and ends, and the level of confidence that Comprehend Medical has in
+    #   its detection.
+    #   @return [Array<Types::Entity>]
+    #
+    # @!attribute [rw] pagination_token
+    #   If the result of the previous request to DetectPHI was truncated,
+    #   include the Paginationtoken to fetch the next page of PHI entities.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIResponse AWS API Documentation
+    #
+    class DetectPHIResponse < Struct.new(
+      :entities,
+      :pagination_token)
+      include Aws::Structure
+    end
+
+    # Provides information about an extracted medical entity.
+    #
+    # @!attribute [rw] id
+    #   The numeric identifier for the entity. This is a monotonically
+    #   increasing id unique within this response rather than a global
+    #   unique identifier.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] begin_offset
+    #   The 0-based character offset in the input text that shows where the
+    #   entity begins. The offset returns the UTF-8 code point in the
+    #   string.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end_offset
+    #   The 0-based character offset in the input text that shows where the
+    #   entity ends. The offset returns the UTF-8 code point in the string.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] score
+    #   The level of confidence that Comprehend Medical has in the accuracy
+    #   of the detection.
+    #   @return [Float]
+    #
+    # @!attribute [rw] text
+    #   The segment of input text extracted as this entity.
+    #   @return [String]
+    #
+    # @!attribute [rw] category
+    #   The category of the entity.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   Describes the specific type of entity with category of entities.
+    #   @return [String]
+    #
+    # @!attribute [rw] traits
+    #   Contextual information for the entity
+    #   @return [Array<Types::Trait>]
+    #
+    # @!attribute [rw] attributes
+    #   The extracted attributes that relate to this entity.
+    #   @return [Array<Types::Attribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Entity AWS API Documentation
+    #
+    class Entity < Struct.new(
+      :id,
+      :begin_offset,
+      :end_offset,
+      :score,
+      :text,
+      :category,
+      :type,
+      :traits,
+      :attributes)
+      include Aws::Structure
+    end
+
+    # Provides contextual information about the extracted entity.
+    #
+    # @!attribute [rw] name
+    #   Provides a name or contextual description about the trait.
+    #   @return [String]
+    #
+    # @!attribute [rw] score
+    #   The level of confidence that Comprehend Medical has in the accuracy
+    #   of this trait.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation
+    #
+    class Trait < Struct.new(
+      :name,
+      :score)
+      include Aws::Structure
+    end
+
+    # An attribute that we extracted, but were unable to relate to an
+    # entity.
+    #
+    # @!attribute [rw] type
+    #   The type of the attribute, could be one of the following values:
+    #   "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY",
+    #   "TEST\_AND\_TREATMENT\_PROCEDURE" or
+    #   "PERSONAL\_HEALTH\_INFORMATION".
+    #   @return [String]
+    #
+    # @!attribute [rw] attribute
+    #   The specific attribute that has been extracted but not mapped to an
+    #   entity.
+    #   @return [Types::Attribute]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/UnmappedAttribute AWS API Documentation
+    #
+    class UnmappedAttribute < Struct.new(
+      :type,
+      :attribute)
+      include Aws::Structure
+    end
+
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: aws-sdk-comprehendmedical
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.39.0
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Official AWS Ruby gem for AWS Comprehend Medical (ComprehendMedical).
+  This gem is part of the AWS SDK for Ruby.
+email:
+- trevrowe@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aws-sdk-comprehendmedical.rb
+- lib/aws-sdk-comprehendmedical/client.rb
+- lib/aws-sdk-comprehendmedical/client_api.rb
+- lib/aws-sdk-comprehendmedical/customizations.rb
+- lib/aws-sdk-comprehendmedical/errors.rb
+- lib/aws-sdk-comprehendmedical/resource.rb
+- lib/aws-sdk-comprehendmedical/types.rb
+homepage: http://github.com/aws/aws-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehendmedical
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-comprehendmedical/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: AWS SDK for Ruby - ComprehendMedical
+test_files: []