Class: Aws::ComprehendMedical::Client

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

Overview

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

client = Aws::ComprehendMedical::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    Your AWS credentials used for authentication. This can be an instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]

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

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

    • ~/.aws/credentials

    • ~/.aws/config

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

  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

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

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

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

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is 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.

  • :sdk_ua_app_id (String) —

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

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

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: 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.

  • :stub_responses (Boolean) — default: false —

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

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

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

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

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

    Your Bearer token used for authentication. This can be an instance of any one of the following classes:

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



483
484
485
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 483

def initialize(*args)
  super
end

Instance Method Details

#describe_entities_detection_v2_job(params = {}) ⇒ Types::DescribeEntitiesDetectionV2JobResponse

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_entities_detection_v2_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

Returns:

See Also:



530
531
532
533
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 530

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

#describe_icd10cm_inference_job(params = {}) ⇒ Types::DescribeICD10CMInferenceJobResponse

Gets the properties associated with an InferICD10CM job. Use this operation to get the status of an inference job.

Examples:

Request syntax with placeholder values


resp = client.describe_icd10cm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier that Amazon Comprehend Medical generated for the job. The StartICD10CMInferenceJob operation returns this identifier in its response.

Returns:

See Also:



576
577
578
579
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 576

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

#describe_phi_detection_job(params = {}) ⇒ Types::DescribePHIDetectionJobResponse

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

Examples:

Request syntax with placeholder values


resp = client.describe_phi_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

Returns:

See Also:



623
624
625
626
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 623

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

#describe_rx_norm_inference_job(params = {}) ⇒ Types::DescribeRxNormInferenceJobResponse

Gets the properties associated with an InferRxNorm job. Use this operation to get the status of an inference job.

Examples:

Request syntax with placeholder values


resp = client.describe_rx_norm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier that Amazon Comprehend Medical generated for the job. The StartRxNormInferenceJob operation returns this identifier in its response.

Returns:

See Also:



669
670
671
672
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 669

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

#describe_snomedct_inference_job(params = {}) ⇒ Types::DescribeSNOMEDCTInferenceJobResponse

Gets the properties associated with an InferSNOMEDCT job. Use this operation to get the status of an inference job.

Examples:

Request syntax with placeholder values


resp = client.describe_snomedct_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.comprehend_medical_async_job_properties.job_id #=> String
resp.comprehend_medical_async_job_properties.job_name #=> String
resp.comprehend_medical_async_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties.message #=> String
resp.comprehend_medical_async_job_properties.submit_time #=> Time
resp.comprehend_medical_async_job_properties.end_time #=> Time
resp.comprehend_medical_async_job_properties.expiration_time #=> Time
resp.comprehend_medical_async_job_properties.input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties.output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties.language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties.data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties.manifest_file_path #=> String
resp.comprehend_medical_async_job_properties.kms_key #=> String
resp.comprehend_medical_async_job_properties.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier that Amazon Comprehend Medical generated for the job. The StartSNOMEDCTInferenceJob operation returns this identifier in its response.

Returns:

See Also:



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

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

#detect_entities(params = {}) ⇒ Types::DetectEntitiesResponse

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

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.

Examples:

Request syntax with placeholder values


resp = client.detect_entities({
  text: "BoundedLengthString", # required
})

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", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE", "AMOUNT", "USAGE", "QUALITY"
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].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
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", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.unmapped_attributes[0].attribute.score #=> Float
resp.unmapped_attributes[0].attribute.relationship_score #=> Float
resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE", "AMOUNT", "USAGE", "QUALITY"
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.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.unmapped_attributes[0].attribute.traits #=> Array
resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    A UTF-8 text string containing the clinical content being examined for entities.

Returns:

See Also:



791
792
793
794
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 791

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

#detect_entities_v2(params = {}) ⇒ Types::DetectEntitiesV2Response

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. Amazon Comprehend Medical only detects medical entities in English language texts.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types.

Examples:

Request syntax with placeholder values


resp = client.detect_entities_v2({
  text: "BoundedLengthString", # required
})

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", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE", "AMOUNT", "USAGE", "QUALITY"
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].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
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", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.unmapped_attributes[0].attribute.type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.unmapped_attributes[0].attribute.score #=> Float
resp.unmapped_attributes[0].attribute.relationship_score #=> Float
resp.unmapped_attributes[0].attribute.relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE", "AMOUNT", "USAGE", "QUALITY"
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.category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.unmapped_attributes[0].attribute.traits #=> Array
resp.unmapped_attributes[0].attribute.traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.unmapped_attributes[0].attribute.traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    A UTF-8 string containing the clinical content being examined for entities.

Returns:

See Also:



874
875
876
877
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 874

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

#detect_phi(params = {}) ⇒ Types::DetectPHIResponse

Inspects the clinical text for protected health information (PHI) entities and returns the entity category, location, and confidence score for each entity. Amazon Comprehend Medical only detects entities in English language texts.

Examples:

Request syntax with placeholder values


resp = client.detect_phi({
  text: "BoundedLengthString", # required
})

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", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "NAME", "DX_NAME", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "GENERIC_NAME", "BRAND_NAME", "STRENGTH", "RATE", "ACUITY", "TEST_NAME", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "PROCEDURE_NAME", "TREATMENT_NAME", "DATE", "AGE", "CONTACT_POINT", "PHONE_OR_FAX", "EMAIL", "IDENTIFIER", "ID", "URL", "ADDRESS", "PROFESSION", "SYSTEM_ORGAN_SITE", "DIRECTION", "QUALITY", "QUANTITY", "TIME_EXPRESSION", "TIME_TO_MEDICATION_NAME", "TIME_TO_DX_NAME", "TIME_TO_TEST_NAME", "TIME_TO_PROCEDURE_NAME", "TIME_TO_TREATMENT_NAME", "AMOUNT", "GENDER", "RACE_ETHNICITY", "ALLERGIES", "TOBACCO_USE", "ALCOHOL_CONSUMPTION", "REC_DRUG_USE"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "EVERY", "WITH_DOSAGE", "ADMINISTERED_VIA", "FOR", "NEGATIVE", "OVERLAP", "DOSAGE", "ROUTE_OR_MODE", "FORM", "FREQUENCY", "DURATION", "STRENGTH", "RATE", "ACUITY", "TEST_VALUE", "TEST_UNITS", "TEST_UNIT", "DIRECTION", "SYSTEM_ORGAN_SITE", "AMOUNT", "USAGE", "QUALITY"
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].category #=> String, one of "MEDICATION", "MEDICAL_CONDITION", "PROTECTED_HEALTH_INFORMATION", "TEST_TREATMENT_PROCEDURE", "ANATOMY", "TIME_EXPRESSION", "BEHAVIORAL_ENVIRONMENTAL_SOCIAL"
resp.entities[0].attributes[0].traits #=> Array
resp.entities[0].attributes[0].traits[0].name #=> String, one of "SIGN", "SYMPTOM", "DIAGNOSIS", "NEGATION", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    A UTF-8 text string containing the clinical content being examined for PHI entities.

Returns:

See Also:



933
934
935
936
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 933

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

#infer_icd10cm(params = {}) ⇒ Types::InferICD10CMResponse

InferICD10CM detects medical conditions as entities listed in a patient record and links those entities to normalized concept identifiers in the ICD-10-CM knowledge base from the Centers for Disease Control. Amazon Comprehend Medical only detects medical entities in English language texts.

Examples:

Request syntax with placeholder values


resp = client.infer_icd10cm({
  text: "OntologyLinkingBoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICAL_CONDITION"
resp.entities[0].type #=> String, one of "DX_NAME", "TIME_EXPRESSION"
resp.entities[0].score #=> Float
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "QUALITY", "QUANTITY", "TIME_TO_DX_NAME", "TIME_EXPRESSION"
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 "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.entities[0].attributes[0].category #=> String, one of "DX_NAME", "TIME_EXPRESSION"
resp.entities[0].attributes[0].relationship_type #=> String, one of "OVERLAP", "SYSTEM_ORGAN_SITE", "QUALITY"
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].icd10cm_concepts #=> Array
resp.entities[0].icd10cm_concepts[0].description #=> String
resp.entities[0].icd10cm_concepts[0].code #=> String
resp.entities[0].icd10cm_concepts[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    The input text used for analysis.

Returns:

See Also:



996
997
998
999
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 996

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

#infer_rx_norm(params = {}) ⇒ Types::InferRxNormResponse

InferRxNorm detects medications as entities listed in a patient record and links to the normalized concept identifiers in the RxNorm database from the National Library of Medicine. Amazon Comprehend Medical only detects medical entities in English language texts.

Examples:

Request syntax with placeholder values


resp = client.infer_rx_norm({
  text: "OntologyLinkingBoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICATION"
resp.entities[0].type #=> String, one of "BRAND_NAME", "GENERIC_NAME"
resp.entities[0].score #=> Float
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].type #=> String, one of "DOSAGE", "DURATION", "FORM", "FREQUENCY", "RATE", "ROUTE_OR_MODE", "STRENGTH"
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 "NEGATION", "PAST_HISTORY"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "NEGATION", "PAST_HISTORY"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].rx_norm_concepts #=> Array
resp.entities[0].rx_norm_concepts[0].description #=> String
resp.entities[0].rx_norm_concepts[0].code #=> String
resp.entities[0].rx_norm_concepts[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    The input text used for analysis.

Returns:

See Also:



1056
1057
1058
1059
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1056

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

#infer_snomedct(params = {}) ⇒ Types::InferSNOMEDCTResponse

InferSNOMEDCT detects possible medical concepts as entities and links them to codes from the Systematized Nomenclature of Medicine, Clinical Terms (SNOMED-CT) ontology

Examples:

Request syntax with placeholder values


resp = client.infer_snomedct({
  text: "OntologyLinkingBoundedLengthString", # required
})

Response structure


resp.entities #=> Array
resp.entities[0].id #=> Integer
resp.entities[0].text #=> String
resp.entities[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
resp.entities[0].type #=> String, one of "DX_NAME", "TEST_NAME", "PROCEDURE_NAME", "TREATMENT_NAME"
resp.entities[0].score #=> Float
resp.entities[0].begin_offset #=> Integer
resp.entities[0].end_offset #=> Integer
resp.entities[0].attributes #=> Array
resp.entities[0].attributes[0].category #=> String, one of "MEDICAL_CONDITION", "ANATOMY", "TEST_TREATMENT_PROCEDURE"
resp.entities[0].attributes[0].type #=> String, one of "ACUITY", "QUALITY", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_VALUE", "TEST_UNIT"
resp.entities[0].attributes[0].score #=> Float
resp.entities[0].attributes[0].relationship_score #=> Float
resp.entities[0].attributes[0].relationship_type #=> String, one of "ACUITY", "QUALITY", "TEST_VALUE", "TEST_UNITS", "DIRECTION", "SYSTEM_ORGAN_SITE", "TEST_UNIT"
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 "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].attributes[0].traits[0].score #=> Float
resp.entities[0].attributes[0].snomedct_concepts #=> Array
resp.entities[0].attributes[0].snomedct_concepts[0].description #=> String
resp.entities[0].attributes[0].snomedct_concepts[0].code #=> String
resp.entities[0].attributes[0].snomedct_concepts[0].score #=> Float
resp.entities[0].traits #=> Array
resp.entities[0].traits[0].name #=> String, one of "NEGATION", "DIAGNOSIS", "SIGN", "SYMPTOM", "PERTAINS_TO_FAMILY", "HYPOTHETICAL", "LOW_CONFIDENCE", "PAST_HISTORY", "FUTURE"
resp.entities[0].traits[0].score #=> Float
resp.entities[0].snomedct_concepts #=> Array
resp.entities[0].snomedct_concepts[0].description #=> String
resp.entities[0].snomedct_concepts[0].code #=> String
resp.entities[0].snomedct_concepts[0].score #=> Float
resp.pagination_token #=> String
resp.model_version #=> String
resp.snomedct_details.edition #=> String
resp.snomedct_details.language #=> String
resp.snomedct_details.version_date #=> String
resp.characters.original_text_characters #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :text (required, String) —

    The input text to be analyzed using InferSNOMEDCT.

Returns:

See Also:



1127
1128
1129
1130
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1127

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

#list_entities_detection_v2_jobs(params = {}) ⇒ Types::ListEntitiesDetectionV2JobsResponse

Gets a list of medical entity detection jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_entities_detection_v2_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::ComprehendMedicalAsyncJobFilter) —

    Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

  • :next_token (String) —

    Identifies the next page of results to return.

  • :max_results (Integer) —

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



1189
1190
1191
1192
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1189

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

#list_icd10cm_inference_jobs(params = {}) ⇒ Types::ListICD10CMInferenceJobsResponse

Gets a list of InferICD10CM jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_icd10cm_inference_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::ComprehendMedicalAsyncJobFilter) —

    Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

  • :next_token (String) —

    Identifies the next page of results to return.

  • :max_results (Integer) —

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



1251
1252
1253
1254
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1251

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

#list_phi_detection_jobs(params = {}) ⇒ Types::ListPHIDetectionJobsResponse

Gets a list of protected health information (PHI) detection jobs you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_phi_detection_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::ComprehendMedicalAsyncJobFilter) —

    Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

  • :next_token (String) —

    Identifies the next page of results to return.

  • :max_results (Integer) —

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



1314
1315
1316
1317
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1314

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

#list_rx_norm_inference_jobs(params = {}) ⇒ Types::ListRxNormInferenceJobsResponse

Gets a list of InferRxNorm jobs that you have submitted.

Examples:

Request syntax with placeholder values


resp = client.list_rx_norm_inference_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::ComprehendMedicalAsyncJobFilter) —

    Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

  • :next_token (String) —

    Identifies the next page of results to return.

  • :max_results (Integer) —

    Identifies the next page of results to return.

Returns:

See Also:



1375
1376
1377
1378
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1375

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

#list_snomedct_inference_jobs(params = {}) ⇒ Types::ListSNOMEDCTInferenceJobsResponse

Gets a list of InferSNOMEDCT jobs a user has submitted.

Examples:

Request syntax with placeholder values


resp = client.list_snomedct_inference_jobs({
  filter: {
    job_name: "JobName",
    job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, PARTIAL_SUCCESS, FAILED, STOP_REQUESTED, STOPPED
    submit_time_before: Time.now,
    submit_time_after: Time.now,
  },
  next_token: "String",
  max_results: 1,
})

Response structure


resp.comprehend_medical_async_job_properties_list #=> Array
resp.comprehend_medical_async_job_properties_list[0].job_id #=> String
resp.comprehend_medical_async_job_properties_list[0].job_name #=> String
resp.comprehend_medical_async_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "PARTIAL_SUCCESS", "FAILED", "STOP_REQUESTED", "STOPPED"
resp.comprehend_medical_async_job_properties_list[0].message #=> String
resp.comprehend_medical_async_job_properties_list[0].submit_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].end_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].expiration_time #=> Time
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].input_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_bucket #=> String
resp.comprehend_medical_async_job_properties_list[0].output_data_config.s3_key #=> String
resp.comprehend_medical_async_job_properties_list[0].language_code #=> String, one of "en"
resp.comprehend_medical_async_job_properties_list[0].data_access_role_arn #=> String
resp.comprehend_medical_async_job_properties_list[0].manifest_file_path #=> String
resp.comprehend_medical_async_job_properties_list[0].kms_key #=> String
resp.comprehend_medical_async_job_properties_list[0].model_version #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filter (Types::ComprehendMedicalAsyncJobFilter) —

    Provides information for filtering a list of detection jobs.

  • :next_token (String) —

    Identifies the next page of InferSNOMEDCT results to return.

  • :max_results (Integer) —

    The maximum number of results to return in each page. The default is 100.

Returns:

See Also:



1435
1436
1437
1438
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1435

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

#start_entities_detection_v2_job(params = {}) ⇒ Types::StartEntitiesDetectionV2JobResponse

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_entities_detection_v2_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig) —

    The input configuration that specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig) —

    The output configuration that specifies where to send the output files.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

  • :job_name (String) —

    The identifier of the job.

  • :client_request_token (String) —

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.

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

  • :kms_key (String) —

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • :language_code (required, String) —

    The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).

Returns:

See Also:



1511
1512
1513
1514
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1511

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

#start_icd10cm_inference_job(params = {}) ⇒ Types::StartICD10CMInferenceJobResponse

Starts an asynchronous job to detect medical conditions and link them to the ICD-10-CM ontology. Use the DescribeICD10CMInferenceJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_icd10cm_inference_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig) —

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig) —

    Specifies where to send the output files.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

  • :job_name (String) —

    The identifier of the job.

  • :client_request_token (String) —

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

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

  • :kms_key (String) —

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • :language_code (required, String) —

    The language of the input documents. All documents must be in the same language.

Returns:

See Also:



1584
1585
1586
1587
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1584

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

#start_phi_detection_job(params = {}) ⇒ Types::StartPHIDetectionJobResponse

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_phi_detection_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig) —

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig) —

    Specifies where to send the output files.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

  • :job_name (String) —

    The identifier of the job.

  • :client_request_token (String) —

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

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

  • :kms_key (String) —

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • :language_code (required, String) —

    The language of the input documents. All documents must be in the same language.

Returns:

See Also:



1657
1658
1659
1660
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1657

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

#start_rx_norm_inference_job(params = {}) ⇒ Types::StartRxNormInferenceJobResponse

Starts an asynchronous job to detect medication entities and link them to the RxNorm ontology. Use the DescribeRxNormInferenceJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_rx_norm_inference_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig) —

    Specifies the format and location of the input data for the job.

  • :output_data_config (required, Types::OutputDataConfig) —

    Specifies where to send the output files.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

  • :job_name (String) —

    The identifier of the job.

  • :client_request_token (String) —

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

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

  • :kms_key (String) —

    An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • :language_code (required, String) —

    The language of the input documents. All documents must be in the same language.

Returns:

See Also:



1730
1731
1732
1733
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1730

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

#start_snomedct_inference_job(params = {}) ⇒ Types::StartSNOMEDCTInferenceJobResponse

Starts an asynchronous job to detect medical concepts and link them to the SNOMED-CT ontology. Use the DescribeSNOMEDCTInferenceJob operation to track the status of a job.

Examples:

Request syntax with placeholder values


resp = client.start_snomedct_inference_job({
  input_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  output_data_config: { # required
    s3_bucket: "S3Bucket", # required
    s3_key: "S3Key",
  },
  data_access_role_arn: "IamRoleArn", # required
  job_name: "JobName",
  client_request_token: "ClientRequestTokenString",
  kms_key: "KMSKey",
  language_code: "en", # required, accepts en
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :input_data_config (required, Types::InputDataConfig) —

    The input properties for an entities detection job. This includes the name of the S3 bucket and the path to the files to be analyzed.

  • :output_data_config (required, Types::OutputDataConfig) —

    The output properties for a detection job.

  • :data_access_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.

  • :job_name (String) —

    The user generated name the asynchronous InferSNOMEDCT job.

  • :client_request_token (String) —

    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

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

  • :kms_key (String) —

    An AWS Key Management Service key used to encrypt your output files. If you do not specify a key, the files are written in plain text.

  • :language_code (required, String) —

    The language of the input documents. All documents must be in the same language.

Returns:

See Also:



1799
1800
1801
1802
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1799

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

#stop_entities_detection_v2_job(params = {}) ⇒ Types::StopEntitiesDetectionV2JobResponse

Stops a medical entities detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_entities_detection_v2_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the medical entities job to stop.

Returns:

See Also:



1827
1828
1829
1830
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1827

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

#stop_icd10cm_inference_job(params = {}) ⇒ Types::StopICD10CMInferenceJobResponse

Stops an InferICD10CM inference job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_icd10cm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the job.

Returns:

See Also:



1855
1856
1857
1858
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1855

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

#stop_phi_detection_job(params = {}) ⇒ Types::StopPHIDetectionJobResponse

Stops a protected health information (PHI) detection job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_phi_detection_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the PHI detection job to stop.

Returns:

See Also:



1883
1884
1885
1886
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1883

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

#stop_rx_norm_inference_job(params = {}) ⇒ Types::StopRxNormInferenceJobResponse

Stops an InferRxNorm inference job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_rx_norm_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The identifier of the job.

Returns:

See Also:



1911
1912
1913
1914
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1911

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

#stop_snomedct_inference_job(params = {}) ⇒ Types::StopSNOMEDCTInferenceJobResponse

Stops an InferSNOMEDCT inference job in progress.

Examples:

Request syntax with placeholder values


resp = client.stop_snomedct_inference_job({
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The job id of the asynchronous InferSNOMEDCT job to be stopped.

Returns:

See Also:



1939
1940
1941
1942
 
# File 'gems/aws-sdk-comprehendmedical/lib/aws-sdk-comprehendmedical/client.rb', line 1939

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