Actions, resources, and condition keys for Amazon Connect Health
Amazon Connect Health (service prefix: health-agent) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Connect Health
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
ActivateSubscription |
Write |
|||
|
CreateDomain |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
health-agent.amazonaws.com |
Write |
||
|
CreateSubscription |
Write |
|||
|
DeactivateSubscription |
Write |
|||
|
DeleteDomain |
Write |
|||
|
GetDomain |
Read |
|||
|
GetMedicalScribeListeningSession |
Read |
|||
|
GetPatientInsightsJob |
Read |
|||
|
GetSubscription |
Read |
|||
|
ListDomains |
List |
|||
|
ListSubscriptions |
List |
|||
|
ListTagsForResource |
List |
|||
|
StartMedicalScribeListeningSession |
Write |
|||
|
StartPatientInsightsJob |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
Actions defined by Amazon Connect Health
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in AWS. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to activate a subscription to enable billing for a user |
Write |
|||
Grants permission to create a new domain for managing HealthAgent resources |
Write |
|||
Grants permission to create a new subscription within a domain for billing and user management |
Write |
|||
Grants permission to deactivate a subscription to stop billing for a user |
Write |
|||
Grants permission to delete a domain and all associated resources |
Write |
|||
Grants permission to retrieve information about a domain |
Read |
|||
Grants permission to retrieve aggregated analytics for a domain |
Read |
|||
Grants permission to retrieve details about an existing Medical Scribe listening session |
Read |
|||
Grants permission to get details of a started patient insights job |
Read |
|||
Grants permission to retrieve information about a subscription |
Read |
|||
Grants permission to list domains for a given account |
List |
|||
Grants permission to list session records for a domain |
List |
|||
Grants permission to list all subscriptions within a domain |
List |
|||
Grants permission to list the tags for the specified resource |
List |
|||
Grants permission to start a new Medical Scribe listening session for real-time audio transcription |
Write |
|||
Grants permission to start a new patient insights job |
Write |
|||
Grants permission to add the specified tags to the specified resource |
Tagging, Write |
|||
Grants permission to remove the tags identified by the TagKeys list from a resource |
Tagging, Write |
Permission-only actions for Amazon Connect Health
The following actions are defined by Amazon Connect Health but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to cancel an appointment |
Write |
|||
Grants permission to create a new agent with an initial version in DRAFT state |
Write |
|||
Grants permission to create a new integration for a domain |
Write |
|||
Grants permission to create a new session with specified agent configurations |
Write |
|||
Grants permission to delete an agent configuration and all its versions |
Write |
|||
Grants permission to delete an integration |
Write |
|||
Grants permission to retrieve an agent configuration, defaulting to the most recent version if not specified |
Read |
|||
Grants permission to retrieve the care team provider of a patient |
Read |
|||
Grants permission to get an existing integration |
Read |
|||
Grants permission to retrieve patient information |
Read |
|||
Grants permission to retrieve practitioner information |
Read |
|||
Grants permission to retrieve structured session context including attributes and collected data |
Read |
|||
Grants permission to invoke an agent within a session with streaming response support |
Write |
|||
Grants permission to list all agents in a domain |
List |
|||
Grants permission to list available appointment slots |
Read |
|||
Grants permission to list integrations for a domain |
List |
|||
Grants permission to list patient appointments |
Read |
|||
Grants permission to list patient insurance coverages |
Read |
|||
Grants permission to retrieve active providers available for scheduling appointments with a patient |
Read |
|||
Grants permission to match a patient |
Read |
|||
Grants permission to publish an agent configuration version |
Write |
|||
Grants permission to reschedule an appointment |
Write |
|||
Grants permission to schedule an appointment for a patient |
Write |
|||
Grants permission to update a draft agent configuration, creating a new draft version if none exists |
Write |
|||
Grants permission to update an existing integration |
Write |
|||
Grants permission to update session attributes such as departmentId and appointmentType |
Write |
|||
Resource types defined by Amazon Connect Health
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/agent/${AgentId} |
||
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId} |
||
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/integration/${IntegrationId} |
||
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/patient-insights-job/${JobId} |
||
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/session/${SessionId} |
||
arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/subscription/${SubscriptionId} |
Condition keys for Amazon Connect Health
Amazon Connect Health defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |
