Skip to content

mediapackagev2 ListChannelGroupsCommand description is wrong about what it retrieves #6897

@torrottum

Description

@torrottum

Describe the issue

The summary for ListChannelGroupsCommand is:

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

However, it does not return channels and origin endpoints. The example responses in the documentation does not show channels and origin endpoints, the types don't include them, and this sample code does not return channels or origin endpoints:

const client = new MediaPackageV2Client();
const cmd = new ListChannelGroupsCommand();
const res = await client.send(cmd);
console.log('ListChannelGroupsV2 response:\n' + JSON.stringify(res, null, 2))
$ node index.mjs   
ListChannelGroupsV2 response:
{
  "$metadata": {
    "httpStatusCode": 200,
    "requestId": "1c13ce5e-b4cf-4604-a4c5-d3bf91cc10ee",
    "attempts": 1,
    "totalRetryDelay": 0
  },
  "Items": [
    {
      "Arn": "arn:aws:mediapackagev2:<region>:<account>:channelGroup/torrot-test",
      "ChannelGroupName": "torrot-test",
      "CreatedAt": "2025-02-17T11:12:26.000Z",
      "ModifiedAt": "2025-02-17T11:12:26.000Z"
    }
  ]
}

I don't expect it to return this given the types and example responses, but just wanted to give a heads up that the summary for the command is wrong.

By the way, the same issue is also present in the API documentation for mediapackage v2

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/mediapackagev2/command/ListChannelGroupsCommand/
https://docs.aws.amazon.com/mediapackage/latest/APIReference/API_ListChannelGroups.html

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.p3This is a minor priority issueservice-apiThis issue is due to a problem in a service API, not the SDK implementation.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions