domains

Creates, updates, deletes, gets or lists a domains resource.

Overview

Name	domains
Type	Resource
Id	aws.connecthealth.domains

Fields

The following fields are returned by SELECT queries:

get_domain

Name	Datatype	Description
name	string
arn	string	(pattern: <code>arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+</code>)
created_at	string (date-time)
domain_id	string	(pattern: <code>(hai-|dom-)[a-z0-9]+</code>)
encryption_context	object	Encryption context for a Domain.
kms_key_arn	string	(pattern: <code>arn:aws:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9-]+</code>)
status	string	(ACTIVE, DELETING, DELETED)
tags	object	Tags associated with the Domain
web_app_configuration	object	Configuration for the Domain web application, including Identity Center settings. If provided, all fields are required.
web_app_url	string

list_domains

Name	Datatype	Description
name	string
arn	string	(pattern: <code>arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+</code>)
created_at	string (date-time)	The timestamp when the Domain was created.
domain_id	string	The unique identifier of the Domain. (pattern: <code>(hai-|dom-)[a-z0-9]+</code>)
status	string	(ACTIVE, DELETING, DELETED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain	select	domain_id, region		Retrieves information about a Domain.
list_domains	select	region	status, maxResults, nextToken	Lists Domains for a given account.
create_domain	insert	region, name		Creates a new Domain for managing HealthAgent resources.
delete_domain	delete	domain_id, region		Deletes a Domain and all associated resources.
start_patient_insights_job	exec	domain_id, region, patientContext, insightsContext, encounterContext, userContext, inputDataConfig, outputDataConfig		Starts a new patient insights job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_id	string
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of results to return.
nextToken	string	Token for pagination.
status	string	Filter by Domain status.

SELECT examples

get_domain

Retrieves information about a Domain.

SELECT
name,
arn,
created_at,
domain_id,
encryption_context,
kms_key_arn,
status,
tags,
web_app_configuration,
web_app_url
FROM aws.connecthealth.domains
WHERE domain_id = '{{ domain_id }}' -- required
AND region = '{{ region }}' -- required
;

list_domains

Lists Domains for a given account.

SELECT
name,
arn,
created_at,
domain_id,
status
FROM aws.connecthealth.domains
WHERE region = '{{ region }}' -- required
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_domain

Creates a new Domain for managing HealthAgent resources.

INSERT INTO aws.connecthealth.domains (
name,
kmsKeyArn,
webAppSetupConfiguration,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ kmsKeyArn }}',
'{{ webAppSetupConfiguration }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
arn,
created_at,
domain_id,
encryption_context,
kms_key_arn,
status,
web_app_configuration,
web_app_url
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.
  - name: name
    value: "{{ name }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"
  - name: webAppSetupConfiguration
    description: |
      Input configuration for creating a web application. Used only in CreateDomain operation input.
    value:
      ehrRole: "{{ ehrRole }}"
      idcInstanceId: "{{ idcInstanceId }}"
      idcRegion: "{{ idcRegion }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_domain

Deletes a Domain and all associated resources.

DELETE FROM aws.connecthealth.domains
WHERE domain_id = '{{ domain_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

start_patient_insights_job

Starts a new patient insights job.

EXEC aws.connecthealth.domains.start_patient_insights_job 
@domain_id='{{ domain_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"patientContext": "{{ patientContext }}", 
"insightsContext": "{{ insightsContext }}", 
"encounterContext": "{{ encounterContext }}", 
"userContext": "{{ userContext }}", 
"inputDataConfig": "{{ inputDataConfig }}", 
"outputDataConfig": "{{ outputDataConfig }}", 
"clientToken": "{{ clientToken }}"
}'
;