IoT / Client / list_sbom_validation_results

list_sbom_validation_results#

IoT.Client.list_sbom_validation_results(**kwargs)#

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

Requires permission to access the ListSbomValidationResults action.

See also: AWS API Documentation

Request Syntax

response = client.list_sbom_validation_results(
    packageName='string',
    versionName='string',
    validationResult='FAILED'|'SUCCEEDED',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • packageName (string) –

    [REQUIRED]

    The name of the new software package.

  • versionName (string) –

    [REQUIRED]

    The name of the new package version.

  • validationResult (string) – The end result of the

  • maxResults (integer) – The maximum number of results to return at one time.

  • nextToken (string) – A token that can be used to retrieve the next set of results, or null if there are no additional results.

Return type:

dict

Returns:

Response Syntax

{
    'validationResultSummaries': [
        {
            'fileName': 'string',
            'validationResult': 'FAILED'|'SUCCEEDED',
            'errorCode': 'INCOMPATIBLE_FORMAT'|'FILE_SIZE_LIMIT_EXCEEDED',
            'errorMessage': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • validationResultSummaries (list) –

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

      • (dict) –

        A summary of the validation results for a specific software bill of materials (SBOM) attached to a software package version.

        • fileName (string) –

          The name of the SBOM file.

        • validationResult (string) –

          The end result of the SBOM validation.

        • errorCode (string) –

          The errorCode representing the validation failure error if the SBOM validation failed.

        • errorMessage (string) –

          The errorMessage representing the validation failure error if the SBOM validation failed.

    • nextToken (string) –

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

Exceptions

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalServerException

  • IoT.Client.exceptions.ValidationException

  • IoT.Client.exceptions.ResourceNotFoundException