---
title: "Flow Collection"
method: GET
path: "/flows/{flowId}/flow_collection"
tags: ["Flows"]
---

# Flow Collection

`GET /flows/{flowId}/flow_collection`

Returns the Flow collection property. An ordered list of Flows that are collected together by this Flow.

## Response `200`

- object[] — Describes how Flows are collected into another Flow. Note that this is an ordered list.
  - `id` string, required — A Universally Unique Identifier (UUID) as defined in [RFC9562](https://www.rfc-editor.org/rfc/rfc9562)
  - `role` string — The purpose of this element in the collection, primarily intended to be human-readable.
  - `container_mapping` Containermapping — Defines the location of Flow essence data in a container track
    - `track_index` integer — A zero-based and sequential track index in the container. This assumes a reliable ordering of tracks
    - `format_track_index` integer — A zero-based and sequential track index in the container for a particular Flow format. A container with a video and 2 audio tracks would have a format_track_index 0 for the video Flow and format_track_index 0 and 1 for the audio Flows. This assumes a reliable ordering of tracks for each Flow format
    - `audio_track` object — Mapping for channels in audio tracks to the Flow channels
      - `channel_numbers` integer[] — Array of (zero-based) container channel numbers in Flow order
      - `channel_range` string — Inclusive range of (zero-based) container channel numbers
    - `mp2ts_container` object — Mapping to MPEG-2 Transport Stream containers, ISO/IEC 13818-1 or ITU-T Recommendation H.222.0
      - `pid` integer — The packet ID for the elementary stream packets
    - `mxf_container` object — Mapping to Material Exchange Format containers, SMPTE ST 377-1
      - `package_uid` string — The package UID. Either a SMPTE UMID URN or UUID URN
      - `track_id` integer — The track ID in the package
    - `isobmff_container` object — Mapping to ISO Base Media File Format (e.g. MP4 and MOV) containers, ISO/IEC 14496-12
      - `track_id` integer — The track ID

## Other responses

- `404` — The requested Flow does not exist.

## Changes

- **2026-08-25** `eb3977b33601` — 1 breaking
  - the response property `items/allOf[subschema #1: Collection Item]/role` became optional for the status `200`
- **2025-07-02** `fff531b4534a` — 2 breaking, 1 warning, 1 info
  - removed the required property `items/id` from the response with the `200` status
  - removed the required property `items/role` from the response with the `200` status
  - removed the optional property `items/container_mapping` from the response with the `200` status
  - added `#/components/schemas/collectionitem, subschema #2` to the `items/` response property `allOf` list for the response status `200`
- **2025-04-24** `b01aaf8cffe2` — 4 info
  - added the optional property `items/container_mapping` to the response with the `200` status
  - removed `#/components/schemas/collectionitem, subschema #2` from the `items/` response property `allOf` list for the response status `200`
  - added the required property `items/id` to the response with the `200` status
  - added the required property `items/role` to the response with the `200` status

[Change history](https://skmtc.dev/aws-samples/apis/time-addressable-media-store/changes/flows/:flowId/flow_collection/get.md)

---

[API](https://skmtc.dev/aws-samples/apis/time-addressable-media-store.md) · [All operations](https://skmtc.dev/aws-samples/apis/time-addressable-media-store/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws-samples/time-addressable-media-store/revisions/eb3977b33601/schema)