IoT / Paginator / ListSbomValidationResults

ListSbomValidationResults

class IoT.Paginator.ListSbomValidationResults

paginator = client.get_paginator('list_sbom_validation_results')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoT.Client.list_sbom_validation_results().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    packageName='string',
    versionName='string',
    validationResult='FAILED'|'SUCCEEDED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 to resume pagination.