Class: Aws::ConnectHealth::Client

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

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    • ‘Aws.config`

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

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

  • :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` 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.

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :ignore_configured_endpoint_urls (Boolean) —

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

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

  • :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.

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :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 www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :sdk_ua_app_id (String) —

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

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

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

  • :stub_responses (Boolean) — default: false —

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

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

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::ConnectHealth::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 ‘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.



482
483
484
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 482

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1205
1206
1207
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1205

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1208
1209
1210
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1208

def errors_module
  Errors
end

Instance Method Details

#activate_subscription(params = {}) ⇒ Types::ActivateSubscriptionOutput

Activates a Subscription to enable billing for a user.

Examples:

Request syntax with placeholder values


resp = client.activate_subscription({
  domain_id: "DomainId", # required
  subscription_id: "SubscriptionId", # required
})

Response structure


resp.subscription.domain_id #=> String
resp.subscription.subscription_id #=> String
resp.subscription.arn #=> String
resp.subscription.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.subscription.created_at #=> Time
resp.subscription.last_updated_at #=> Time
resp.subscription.activated_at #=> Time
resp.subscription.deactivated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The unique identifier of the parent Domain.

  • :subscription_id (required, String) —

    The unique identifier of the Subscription.

Returns:

See Also:



522
523
524
525
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 522

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1178

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

#create_domain(params = {}) ⇒ Types::CreateDomainOutput

Creates a new Domain for managing HealthAgent resources.

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  name: "DomainName", # required
  kms_key_arn: "KmsKeyArn",
  web_app_setup_configuration: {
    ehr_role: "CreateWebAppConfigurationEhrRoleString", # required
    idc_instance_id: "CreateWebAppConfigurationIdcInstanceIdString", # required
    idc_region: "CreateWebAppConfigurationIdcRegionString", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.domain_id #=> String
resp.arn #=> String
resp.name #=> String
resp.kms_key_arn #=> String
resp.encryption_context.encryption_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.encryption_context.kms_key_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING", "DELETED"
resp.web_app_url #=> String
resp.web_app_configuration.ehr_role #=> String
resp.web_app_configuration.idc_application_id #=> String
resp.web_app_configuration.idc_region #=> String
resp.created_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name for the new Domain.

  • :kms_key_arn (String) —

    The ARN of the KMS key to use for encrypting data in this Domain.

  • :web_app_setup_configuration (Types::CreateWebAppConfiguration) —

    Configuration for the Domain web application. Optional, but if provided all fields are required.

  • :tags (Hash<String,String>) —

    Tags to associate with the Domain.

Returns:

See Also:



588
589
590
591
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 588

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

#create_subscription(params = {}) ⇒ Types::CreateSubscriptionOutput

Creates a new Subscription within a Domain for billing and user management.

Examples:

Request syntax with placeholder values


resp = client.create_subscription({
  domain_id: "DomainId", # required
})

Response structure


resp.domain_id #=> String
resp.subscription_id #=> String
resp.arn #=> String
resp.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.activated_at #=> Time
resp.deactivated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The unique identifier of the parent Domain.

Returns:

See Also:



631
632
633
634
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 631

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

#deactivate_subscription(params = {}) ⇒ Types::DeactivateSubscriptionOutput

Deactivates a Subscription to stop billing for a user.

Examples:

Request syntax with placeholder values


resp = client.deactivate_subscription({
  domain_id: "DomainId", # required
  subscription_id: "SubscriptionId", # required
})

Response structure


resp.subscription.domain_id #=> String
resp.subscription.subscription_id #=> String
resp.subscription.arn #=> String
resp.subscription.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.subscription.created_at #=> Time
resp.subscription.last_updated_at #=> Time
resp.subscription.activated_at #=> Time
resp.subscription.deactivated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The unique identifier of the parent Domain.

  • :subscription_id (required, String) —

    The unique identifier of the Subscription.

Returns:

See Also:



670
671
672
673
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 670

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

#delete_domain(params = {}) ⇒ Types::DeleteDomainOutput

Deletes a Domain and all associated resources.

Examples:

Request syntax with placeholder values


resp = client.delete_domain({
  domain_id: "DomainId", # required
})

Response structure


resp.domain_id #=> String
resp.arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING", "DELETED"

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The id of the Domain to delete

Returns:

See Also:



702
703
704
705
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 702

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

#get_domain(params = {}) ⇒ Types::GetDomainOutput

Retrieves information about a Domain.

Examples:

Request syntax with placeholder values


resp = client.get_domain({
  domain_id: "DomainId", # required
})

Response structure


resp.domain_id #=> String
resp.arn #=> String
resp.name #=> String
resp.kms_key_arn #=> String
resp.encryption_context.encryption_type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KEY"
resp.encryption_context.kms_key_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING", "DELETED"
resp.web_app_url #=> String
resp.web_app_configuration.ehr_role #=> String
resp.web_app_configuration.idc_application_id #=> String
resp.web_app_configuration.idc_region #=> String
resp.created_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The id of the Domain to get

Returns:

See Also:



752
753
754
755
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 752

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

#get_medical_scribe_listening_session(params = {}) ⇒ Types::GetMedicalScribeListeningSessionOutput

Retrieves details about an existing Medical Scribe listening session

Examples:

Request syntax with placeholder values


resp = client.get_medical_scribe_listening_session({
  session_id: "SessionId", # required
  domain_id: "DomainId", # required
  subscription_id: "SubscriptionId", # required
})

Response structure


resp.medical_scribe_listening_session_details.session_id #=> String
resp.medical_scribe_listening_session_details.domain_id #=> String
resp.medical_scribe_listening_session_details.subscription_id #=> String
resp.medical_scribe_listening_session_details.language_code #=> String, one of "en-US"
resp.medical_scribe_listening_session_details.media_sample_rate_hertz #=> Integer
resp.medical_scribe_listening_session_details.media_encoding #=> String, one of "pcm", "flac"
resp.medical_scribe_listening_session_details.channel_definitions #=> Array
resp.medical_scribe_listening_session_details.channel_definitions[0].channel_id #=> Integer
resp.medical_scribe_listening_session_details.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
resp.medical_scribe_listening_session_details.post_stream_action_settings.output_s3_uri #=> String
resp.medical_scribe_listening_session_details.post_stream_action_settings.clinical_note_generation_settings.note_template_settings.managed_template.template_type #=> String, one of "HISTORY_AND_PHYSICAL", "GIRPP", "DAP", "SIRP", "BIRP", "BEHAVIORAL_SOAP", "PHYSICAL_SOAP"
resp.medical_scribe_listening_session_details.post_stream_action_settings.clinical_note_generation_settings.note_template_settings.custom_template.template_type #=> String, one of "HISTORY_AND_PHYSICAL", "GIRPP", "DAP", "SIRP", "BIRP", "BEHAVIORAL_SOAP"
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.note_result.output_location #=> String
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.note_result.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.note_result.failure_reason #=> String
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.transcript_result.output_location #=> String
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.transcript_result.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.transcript_result.failure_reason #=> String
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.after_visit_summary_result.output_location #=> String
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.after_visit_summary_result.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
resp.medical_scribe_listening_session_details.post_stream_action_result.clinical_note_generation_result.after_visit_summary_result.failure_reason #=> String
resp.medical_scribe_listening_session_details.encounter_context_provided #=> Boolean
resp.medical_scribe_listening_session_details.stream_status #=> String, one of "IN_PROGRESS", "PAUSED", "FAILED", "COMPLETED"
resp.medical_scribe_listening_session_details.stream_creation_time #=> Time
resp.medical_scribe_listening_session_details.stream_end_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String) —

    The Session identifier

  • :domain_id (required, String) —

    The Domain identifier

  • :subscription_id (required, String) —

    The Subscription identifier

Returns:

See Also:



812
813
814
815
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 812

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

#get_patient_insights_job(params = {}) ⇒ Types::GetPatientInsightsJobResponse

Get details of a started patient insights job.

Examples:

Request syntax with placeholder values


resp = client.get_patient_insights_job({
  domain_id: "DomainId", # required
  job_id: "JobId", # required
})

Response structure


resp.job_id #=> String
resp.job_arn #=> String
resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "FAILED", "SUCCEEDED"
resp.creation_time #=> Time
resp.updated_time #=> Time
resp.insights_output.uri #=> String
resp.status_details #=> String
resp.patient_context.patient_id #=> String
resp.patient_context.date_of_birth #=> String
resp.patient_context.pronouns #=> String, one of "HE_HIM", "SHE_HER", "THEY_THEM"
resp.insights_context.insights_type #=> String, one of "PRE_VISIT"
resp.encounter_context.encounter_reason #=> String
resp.user_context.role #=> String, one of "CLINICIAN"
resp.user_context.user_id #=> String
resp.user_context.specialty #=> String, one of "PRIMARY_CARE"
resp.input_data_config.fhir_server.fhir_endpoint #=> String
resp.input_data_config.fhir_server.oauth_token #=> String
resp.input_data_config.s3_sources #=> Array
resp.input_data_config.s3_sources[0].uri #=> String
resp.output_data_config.s3_output_path #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String)
  • :job_id (required, String)

Returns:

See Also:



873
874
875
876
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 873

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

#get_subscription(params = {}) ⇒ Types::GetSubscriptionOutput

Retrieves information about a Subscription.

Examples:

Request syntax with placeholder values


resp = client.get_subscription({
  domain_id: "DomainId", # required
  subscription_id: "SubscriptionId", # required
})

Response structure


resp.subscription.domain_id #=> String
resp.subscription.subscription_id #=> String
resp.subscription.arn #=> String
resp.subscription.status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.subscription.created_at #=> Time
resp.subscription.last_updated_at #=> Time
resp.subscription.activated_at #=> Time
resp.subscription.deactivated_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The unique identifier of the parent Domain.

  • :subscription_id (required, String) —

    The unique identifier of the Subscription.

Returns:

See Also:



912
913
914
915
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 912

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

#list_domains(params = {}) ⇒ Types::ListDomainsOutput

Lists Domains for a given account.

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

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  status: "ACTIVE", # accepts ACTIVE, DELETING, DELETED
  max_results: 1,
  next_token: "String",
})

Response structure


resp.domains #=> Array
resp.domains[0].domain_id #=> String
resp.domains[0].arn #=> String
resp.domains[0].name #=> String
resp.domains[0].status #=> String, one of "ACTIVE", "DELETING", "DELETED"
resp.domains[0].created_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status (String) —

    Filter by Domain status.

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    Token for pagination.

Returns:

See Also:



957
958
959
960
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 957

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

#list_subscriptions(params = {}) ⇒ Types::ListSubscriptionsOutput

Lists all Subscriptions within a Domain.

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

Examples:

Request syntax with placeholder values


resp = client.list_subscriptions({
  domain_id: "DomainId", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.subscriptions #=> Array
resp.subscriptions[0].domain_id #=> String
resp.subscriptions[0].subscription_id #=> String
resp.subscriptions[0].arn #=> String
resp.subscriptions[0].status #=> String, one of "ACTIVE", "INACTIVE", "DELETED"
resp.subscriptions[0].created_at #=> Time
resp.subscriptions[0].last_updated_at #=> Time
resp.subscriptions[0].activated_at #=> Time
resp.subscriptions[0].deactivated_at #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_id (required, String) —

    The unique identifier of the parent Domain.

  • :max_results (Integer) —

    Maximum number of results to return.

  • :next_token (String) —

    Token for pagination.

Returns:

See Also:



1005
1006
1007
1008
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1005

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags associated with the specified resource

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to list tags for

Returns:

See Also:



1034
1035
1036
1037
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1034

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

#start_patient_insights_job(params = {}) ⇒ Types::StartPatientInsightsJobResponse

Starts a new patient insights job.

Examples:

Request syntax with placeholder values


resp = client.start_patient_insights_job({
  domain_id: "DomainId", # required
  patient_context: { # required
    patient_id: "SensitiveNonEmptyString", # required
    date_of_birth: "SensitiveIsoDateString",
    pronouns: "HE_HIM", # accepts HE_HIM, SHE_HER, THEY_THEM
  },
  insights_context: { # required
    insights_type: "PRE_VISIT", # required, accepts PRE_VISIT
  },
  encounter_context: { # required
    encounter_reason: "PatientInsightsEncounterContextEncounterReasonString", # required
  },
  user_context: { # required
    role: "CLINICIAN", # required, accepts CLINICIAN
    user_id: "SensitiveNonEmptyString", # required
    specialty: "PRIMARY_CARE", # accepts PRIMARY_CARE
  },
  input_data_config: { # required
    fhir_server: {
      fhir_endpoint: "FHIRServerFhirEndpointString", # required
      oauth_token: "SensitiveNonEmptyString",
    },
    s3_sources: [
      {
        uri: "S3Uri", # required
      },
    ],
  },
  output_data_config: { # required
    s3_output_path: "S3Uri", # required
  },
  client_token: "NonEmptyString",
})

Response structure


resp.job_arn #=> String
resp.job_id #=> String
resp.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1115
1116
1117
1118
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1115

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

#tag_resource(params = {}) ⇒ Struct

Associates the specified tags with the specified resource

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to tag

  • :tags (required, Hash<String,String>) —

    The tags to add to the resource

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1143
1144
1145
1146
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1143

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

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to untag

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

    The tag keys to remove from the resource

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1169
1170
1171
1172
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1169

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1198
1199
1200
 
# File 'lib/aws-sdk-connecthealth/client.rb', line 1198

def waiter_names
  []
end