Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSbomValidationResults

The validation results for all software bill of materials (SBOM) attached to a specific software package version.

Requires permission to access the ListSbomValidationResults action.

Request Syntax


GET /packages/packageName/versions/versionName/sbom-validation-results?maxResults=maxResults&nextToken=nextToken&validationResult=validationResult HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return at one time.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

packageName

The name of the new software package.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-_.]+

Required: Yes

validationResult

The end result of the

Valid Values: FAILED | SUCCEEDED

versionName

The name of the new package version.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_.]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "validationResultSummaries": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "fileName": "string",
         "validationResult": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Type: String

validationResultSummaries

A summary of the validation results for each software bill of materials attached to a software package version.

Type: Array of SbomValidationResultSummary objects

Errors

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

ValidationException

The request is not valid.

HTTP Status Code: 400