Actions, resources, and condition keys for Amazon Connect Health

Amazon Connect Health (service prefix: health-agent) provides the following service-specific resources, actions, and condition context 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.

Topics

Actions defined by Amazon Connect Health
Resource types defined by Amazon Connect Health
Condition keys for Amazon Connect Health

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.

The Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

The Dependent actions column of the Actions table shows additional permissions that may be required to successfully call an action. These permissions may be needed in addition to the permission for the action itself. When an action specifies dependent actions, those dependencies may apply to additional resources defined for that action, not only the first resource listed in the table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions	Description	Access level	Resource types (*required)	Condition keys	Dependent actions
ActivateSubscription	Grants permission to activate a subscription to enable billing for a user	Write	Domain*
ActivateSubscription		Write	Subscription*
CancelAppointment [permission only]	Grants permission to cancel an appointment	Write	Domain*
CancelAppointment [permission only]	Grants permission to cancel an appointment	Write	Integration*
CreateAgent [permission only]	Grants permission to create a new agent with an initial version in DRAFT state	Write	Agent*
CreateAgent [permission only]		Write	Domain*
CreateDomain	Grants permission to create a new domain for managing HealthAgent resources	Write		aws:RequestTag/${TagKey} aws:TagKeys	health-agent:TagResource iam:PassRole
CreateIntegration [permission only]	Grants permission to create a new integration for a domain	Write	Domain*
CreateIntegration [permission only]	Grants permission to create a new integration for a domain	Write	Integration*
CreateSession [permission only]	Grants permission to create a new session with specified agent configurations	Write	Agent*
			Domain*
			Session*
CreateSubscription	Grants permission to create a new subscription within a domain for billing and user management	Write	Domain*
CreateSubscription		Write	Subscription*
DeactivateSubscription	Grants permission to deactivate a subscription to stop billing for a user	Write	Domain*
DeactivateSubscription		Write	Subscription*
DeleteAgent [permission only]	Grants permission to delete an agent configuration and all its versions	Write	Agent*
DeleteAgent [permission only]		Write	Domain*
DeleteDomain	Grants permission to delete a domain and all associated resources	Write	Domain*
DeleteIntegration [permission only]	Grants permission to delete an integration	Write	Domain*
DeleteIntegration [permission only]	Grants permission to delete an integration	Write	Integration*
GetAgent [permission only]	Grants permission to retrieve an agent configuration, defaulting to the most recent version if not specified	Read	Agent*
GetAgent [permission only]		Read	Domain*
GetCareTeamProvider [permission only]	Grants permission to retrieve the care team provider of a patient	Read	Domain*
GetCareTeamProvider [permission only]		Read	Integration*
GetDomain	Grants permission to retrieve information about a domain	Read	Domain*
GetIntegration [permission only]	Grants permission to get an existing integration	Read	Domain*
GetIntegration [permission only]	Grants permission to get an existing integration	Read	Integration*
GetMedicalScribeListeningSession	Grants permission to retrieve details about an existing Medical Scribe listening session	Read	Domain*
GetMedicalScribeListeningSession		Read	Subscription*
GetPatient [permission only]	Grants permission to retrieve patient information	Read	Domain*
GetPatient [permission only]	Grants permission to retrieve patient information	Read	Integration*
GetPatientInsightsJob	Grants permission to get details of a started patient insights job	Read	Domain*
GetPatientInsightsJob		Read	PatientInsightsJob*
GetPractitioner [permission only]	Grants permission to retrieve practitioner information	Read	Domain*
GetPractitioner [permission only]	Grants permission to retrieve practitioner information	Read	Integration*
GetSessionContext [permission only]	Grants permission to retrieve structured session context including attributes and collected data	Read	Domain*
GetSessionContext [permission only]		Read	Session*
GetSubscription	Grants permission to retrieve information about a subscription	Read	Domain*
GetSubscription		Read	Subscription*
InvokeAgent [permission only]	Grants permission to invoke an agent within a session with streaming response support	Write	Domain*
InvokeAgent [permission only]		Write	Session*
ListAgents [permission only]	Grants permission to list all agents in a domain	List	Domain*
ListAppointmentSlots [permission only]	Grants permission to list available appointment slots	Read	Domain*
ListAppointmentSlots [permission only]	Grants permission to list available appointment slots	Read	Integration*
ListDomains	Grants permission to list domains for a given account	List
ListIntegrations [permission only]	Grants permission to list integrations for a domain	List	Domain*
ListPatientAppointments [permission only]	Grants permission to list patient appointments	Read	Domain*
ListPatientAppointments [permission only]	Grants permission to list patient appointments	Read	Integration*
ListPatientInsuranceCoverages [permission only]	Grants permission to list patient insurance coverages	Read	Domain*
ListPatientInsuranceCoverages [permission only]	Grants permission to list patient insurance coverages	Read	Integration*
ListProviders [permission only]	Grants permission to retrieve active providers available for scheduling appointments with a patient	Read	Domain*
ListProviders [permission only]		Read	Integration*
ListSubscriptions	Grants permission to list all subscriptions within a domain	List	Domain*
ListTagsForResource	Grants permission to list the tags for the specified resource	List	Domain
MatchPatient [permission only]	Grants permission to match a patient	Read	Domain*
MatchPatient [permission only]	Grants permission to match a patient	Read	Integration*
PublishAgent [permission only]	Grants permission to publish an agent configuration version	Write	Agent*
PublishAgent [permission only]	Grants permission to publish an agent configuration version	Write	Domain*
RescheduleAppointment [permission only]	Grants permission to reschedule an appointment	Write	Domain*
RescheduleAppointment [permission only]	Grants permission to reschedule an appointment	Write	Integration*
ScheduleAppointment [permission only]	Grants permission to schedule an appointment for a patient	Write	Domain*
ScheduleAppointment [permission only]	Grants permission to schedule an appointment for a patient	Write	Integration*
StartMedicalScribeListeningSession	Grants permission to start a new Medical Scribe listening session for real-time audio transcription	Write	Domain*
StartMedicalScribeListeningSession		Write	Subscription*
StartPatientInsightsJob	Grants permission to start a new patient insights job	Write	Domain*
StartPatientInsightsJob	Grants permission to start a new patient insights job	Write	PatientInsightsJob*
TagResource	Grants permission to add the specified tags to the specified resource	Tagging	Domain	aws:ResourceTag/${TagKey}
TagResource		Tagging		aws:TagKeys aws:RequestTag/${TagKey}
UntagResource	Grants permission to remove the tags identified by the TagKeys list from a resource	Tagging	Domain
UntagResource		Tagging		aws:TagKeys
UpdateAgent [permission only]	Grants permission to update a draft agent configuration, creating a new draft version if none exists	Write	Agent*
UpdateAgent [permission only]		Write	Domain*
UpdateIntegration [permission only]	Grants permission to update an existing integration	Write	Domain*
UpdateIntegration [permission only]	Grants permission to update an existing integration	Write	Integration*
UpdateSession [permission only]	Grants permission to update session attributes such as departmentId and appointmentType	Write	Domain*
UpdateSession [permission only]		Write	Session*

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. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types	ARN	Condition keys
Domain	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}`	aws:ResourceTag/${TagKey}
PatientInsightsJob	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/patient-insights-job/${JobId}`	aws:ResourceTag/${TagKey}
Subscription	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/subscription/${SubscriptionId}`	aws:ResourceTag/${TagKey}
Integration	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/integration/${IntegrationId}`	aws:ResourceTag/${TagKey}
Agent	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/agent/${AgentId}`	aws:ResourceTag/${TagKey}
Session	`arn:${Partition}:health-agent:${Region}:${Account}:domain/${DomainId}/session/${SessionId}`	aws:ResourceTag/${TagKey}

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. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see AWS global condition context keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by the tags that are passed in the request	String
aws:ResourceTag/${TagKey}	Filters access by the tags associated with the resource	String
aws:TagKeys	Filters access by the tag keys that are passed in the request	ArrayOfString

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Amazon Connect Customer Profiles

Amazon Connect Outbound Campaigns