Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS HealthLake Tags API

Resource tagging operations for cost allocation and resource management

AWS HealthLake Tags API is one of 8 APIs that AWS HealthLake publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Tags. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2017-07-01.

Requests are made against a single base URL, https://healthlake.{region}.amazonaws.com.

3 operations 3 paths 6 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2017-07-01
Base URL
https://healthlake.us-east-1.amazonaws.com
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

AWS HealthLake Tags API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (aws_v4). By default, every request must be authenticated.

  • aws_v4 — AWS Signature Version 4. Sign requests with your AWS access key and secret key. See: https://docs.aws.amazon.com/general/latest/gr/signingawsapirequests.html

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Tags 3

Resource tagging operations for cost allocation and resource management

POST
/#X-Amz-Target=HealthLake.ListTagsForResource
ListTagsForResource
listTagsForResource 1 param body → 200400500
POST
/#X-Amz-Target=HealthLake.TagResource
TagResource
tagResource 1 param body → 200400500
POST
/#X-Amz-Target=HealthLake.UntagResource
UntagResource
untagResource 1 param body → 200400500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TagResourceRequest (2 properties), UntagResourceRequest (2 properties), ListTagsForResourceResponse (1 property), ListTagsForResourceRequest (1 property). Each schema is shown below with its type and property counts.

UntagResourceRequest
object
2 properties 2 required
ListTagsForResourceRequest
object
1 property 1 required
TagResourceRequest
object
2 properties 2 required
UntagResourceResponse
object
ListTagsForResourceResponse
object
1 property
TagResourceResponse
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-healthlake-tags-api-openapi.yml Raw ↑

Other APIs AWS HealthLake publishes across the network.

AWS HealthLake FHIR Import API
AWS HealthLake FHIR Export API
AWS HealthLake FHIR R4 Server API
AWS HealthLake Resource Tagging API
AWS HealthLake Datastore API
AWS HealthLake Export API
AWS HealthLake Import API