Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mediapackagev2 ListChannelGroupsCommand description is wrong about what it retrieves #6897

Open
torrottum opened this issue Feb 19, 2025 · 1 comment
Assignees
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue service-api This issue is due to a problem in a service API, not the SDK implementation.

Comments

@torrottum
Copy link

torrottum commented Feb 19, 2025

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

@torrottum torrottum added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 19, 2025
@aBurmeseDev
Copy link
Member

Hi @torrottum - thanks for reaching out.

These wordings on our SDK docs get generated upstream by service team and we don't get to change it. I've reached out to Media Package team to verify the behavior and if wording needs to be corrected. (ref V1685685146).

I'll update it here once I hear back.
Best,
John

@aBurmeseDev aBurmeseDev self-assigned this Feb 24, 2025
@aBurmeseDev aBurmeseDev added service-api This issue is due to a problem in a service API, not the SDK implementation. p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p3 This is a minor priority issue service-api This issue is due to a problem in a service API, not the SDK implementation.
Projects
None yet
Development

No branches or pull requests

2 participants