Get Segment
pinpoint.get_segment
ActionAmazon Web Servicesconnection required
Calls the AWS pinpoint API (SigV4).
Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon Pinpoint
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 | — | — | — |
segment_id The unique identifier for the segment. | string | Yes | — | — | — |
application_id The unique identifier for the application. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
SegmentResponse | object | — |
{
"SegmentResponse": {}
}Related Amazon Pinpoint nodes
See Get Segment run in a workflow.
In a technical demo we add the Amazon Pinpoint connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.