AgentHealthCode enum missing "HEALTHY" value

[cladelpino]

Checkboxes for prior research

• I've gone through Developer Guide and API reference
• I've checked AWS Forums and StackOverflow.
• I've searched for previous similar issues and didn't find any solution.

Describe the bug

In the context of AWS Inspector "Classic".

When fetching agents linked to an assessment using a ListAssessmentRunAgentsRequest, an AgentFilter can be used to only fetch agents with certain values of AgentHealth and AgentHealthCode.

The AgentHealthCode enum is defined in

aws-sdk-js-v3/clients/client-inspector/src/models/models_0.ts

Line 380 in ec6810a

export const AgentHealthCode = {

, but it is missing the "HEALTHY" value, which the SDK can return when an instance belongs to an ASG in my latest tests.

Regression Issue

• Select this option if this issue appears to be a regression.

SDK version number

@aws-sdk/client-inspector@3.777.0 (but also latest)

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

node v22.14.0

Reproduction Steps

const assesmentRunArn = ....

const agentsWithoutFilters = [];
const listAssessmentRunAgentsWithoutFilterPaginator = paginateListAssessmentRunAgents({
    client: inspector,
    pageSize: 50,
  }, 
  { assessmentRunArn }
);

for await (const page of listAssessmentRunAgentsWithoutFilterPaginator) {
    if (page.assessmentRunAgents != null) {
       agentsWithoutFilters.push(...page.assessmentRunAgents.map(a => a.agentId));
    }
}

assert( agentsWithoutFilters.filter(agent=>agent.agentHealthCode === "HEALTHY").length > 0 )

Observed Behavior

If a filter is used that contains all possible values of AgentHealthCode, the response will not have the "HEALTHY" agents.

Expected Behavior

The AgentHealthCode enum should contain the "HEALTHY" value since it is a possible return type of the call.

Possible Solution

Add "HEALTHY" to the AgentHealthCode enum

Additional Information/Context

No response

[zshzbh]

Hey @cladelpino ,

Thanks for the feedback. However, it seems that the service API doesn't provide the 'HEALTHY' option for agentHealthCodes - https://docs.aws.amazon.com/inspector/v1/APIReference/API_AgentFilter.html#Inspector-Type-AgentFilter-agentHealthCodes

Let me check with the service team on this and I will get back to you ASAP. Thanks!

[zshzbh]

Hey @cladelpino ,

Just got feedback from service team -

You can use agentHealth ? It filters just healthy/unhealthy state. This shows the current state of the agents. - https://docs.aws.amazon.com/inspector/v1/APIReference/API_AgentFilter.html#Inspector-Type-AgentFilter-agentHealthCodes

---

agentHealths
The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Valid Values: HEALTHY | UNHEALTHY | UNKNOWN

[cladelpino]

Hi @zshzbh!

I'm just pointing to a documentation + types bug, where an enum is missing a value that is in reality being used by the service. I don't have any issues with my code, other than having to introduce a cast, and having to do extra research because of documentation errors.

Functionally, the service returns agents with agentHealthCodes of "HEALTHY", even though that value is not supposed to be allowed. This could break, for example, custom validation downstream of the response, if the dev chooses to base it on the documentation or the SDK types.

Also, the filter on agentHealthCodes can even made to work, in TS context requiring a cast.

But anyway, you may not care about types or documentation. Just wanted to make the team aware of this gap.

Best!

[zshzbh]

Hey @cladelpino ,

Thank you for bringing this to our attention. We greatly appreciate your detailed feedback regarding the discrepancy between the documentation, types, and the actual service behavior. Your observation about the "HEALTHY" value being returned despite not being listed in the enum is particularly valuable.

You're absolutely right that this inconsistency could potentially cause issues for developers relying on our documentation or SDK types, especially when implementing custom validation. I'm sorry that I only brought the workaround in the last comment. We definitely do care about accurate types and documentation, as they are crucial for providing a smooth developer experience.

I've logged this issue with our development team to address the following points:

• If there's a documentation gap, update the enum in our documentation and SDK to include the "HEALTHY" value.
• Ensure that the service behavior aligns with the documented values.
• Review and update any related documentation to reflect the correct possible values.

We take documentation and type accuracy seriously, as they are integral parts of our service offering. Thank you again for taking the time to report this. Your attention to detail helps us improve our product for all users.

If you notice any other discrepancies or have any further questions, please don't hesitate to reach out. We appreciate your contribution to making our service better!

Best regards,
Maggie