Describe Comments
workdocs.describe_comments
ActionAmazon Web Servicesconnection required
Calls the AWS workdocs API (SigV4).
List all the comments for the specified document version.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon WorkDocs
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
document_id The ID of the document. | string | Yes | — | — | — |
version_id The ID of the document version. | string | Yes | — | — | — |
max_results Maximum items to return. | number | No | 50 | ≥ 1 | — |
next_token Continues a previous run of this node: pass that run's paging token here. Leave blank to start at the first page. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
Comments | array | — |
Marker | string | — |
{
"Comments": [],
"Marker": ""
}Related Amazon WorkDocs nodes
See Describe Comments run in a workflow.
In a technical demo we add the Amazon WorkDocs connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.