Inspector2

2026/08/04 - Inspector2 - 2 updated api methods

Changes  Adding Azure SBOM export capability.

CreateSbomExport (updated) Link ¶
Changes (request)
{'resourceFilterCriteria': {'cloudContainerImageTags': [{'comparison': 'EQUALS '
                                                                       '| '
                                                                       'NOT_EQUALS',
                                                         'value': 'string'}],
                            'cloudContainerRegistryName': [{'comparison': 'EQUALS '
                                                                          '| '
                                                                          'NOT_EQUALS',
                                                            'value': 'string'}],
                            'cloudContainerRepositoryName': [{'comparison': 'EQUALS '
                                                                            '| '
                                                                            'NOT_EQUALS',
                                                              'value': 'string'}],
                            'cloudProvider': [{'comparison': 'EQUALS | '
                                                             'NOT_EQUALS',
                                               'value': 'string'}],
                            'cloudProviderAccountId': [{'comparison': 'EQUALS '
                                                                      '| '
                                                                      'NOT_EQUALS',
                                                        'value': 'string'}],
                            'cloudProviderOrgId': [{'comparison': 'EQUALS | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}],
                            'cloudProviderRegion': [{'comparison': 'EQUALS | '
                                                                   'NOT_EQUALS',
                                                     'value': 'string'}],
                            'cloudServerlessFunctionName': [{'comparison': 'EQUALS '
                                                                           '| '
                                                                           'NOT_EQUALS',
                                                             'value': 'string'}],
                            'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
                                                                              '| '
                                                                              'NOT_EQUALS',
                                                                'value': 'string'}],
                            'cloudServerlessFunctionTags': [{'comparison': 'EQUALS',
                                                             'key': 'string',
                                                             'value': 'string'}],
                            'cloudVmInstanceTags': [{'comparison': 'EQUALS',
                                                     'key': 'string',
                                                     'value': 'string'}]}}

Creates a software bill of materials (SBOM) report.

See also: AWS API Documentation

Request Syntax

client.create_sbom_export(
    resourceFilterCriteria={
        'accountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'cloudProvider': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderAccountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderOrgId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderRegion': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudVmInstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'cloudContainerImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudContainerRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudContainerRegistryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    reportFormat='CYCLONEDX_1_4'|'SPDX_2_3',
    s3Destination={
        'bucketName': 'string',
        'keyPrefix': 'string',
        'kmsKeyArn': 'string'
    }
)
type resourceFilterCriteria:

dict

param resourceFilterCriteria:

The resource filter criteria for the software bill of materials (SBOM) report.

  • accountId (list) --

    The account IDs used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • resourceId (list) --

    The resource IDs used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • resourceType (list) --

    The resource types used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • ecrRepositoryName (list) --

    The ECR repository names used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • lambdaFunctionName (list) --

    The Amazon Web Services Lambda function name used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • ecrImageTags (list) --

    The ECR image tags used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • ec2InstanceTags (list) --

    The EC2 instance tags used as resource filter criteria.

    • (dict) --

      A resource map filter for a software bill of material report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • key (string) -- [REQUIRED]

        The filter's key.

      • value (string) --

        The filter's value.

  • lambdaFunctionTags (list) --

    The Amazon Web Services Lambda function tags used as resource filter criteria.

    • (dict) --

      A resource map filter for a software bill of material report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • key (string) -- [REQUIRED]

        The filter's key.

      • value (string) --

        The filter's value.

  • cloudProvider (list) --

    The cloud providers used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudProviderAccountId (list) --

    The cloud provider account IDs used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudProviderOrgId (list) --

    The cloud provider organization IDs used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudProviderRegion (list) --

    The cloud provider regions used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudVmInstanceTags (list) --

    The cloud VM instance tags used as resource filter criteria.

    • (dict) --

      A resource map filter for a software bill of material report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • key (string) -- [REQUIRED]

        The filter's key.

      • value (string) --

        The filter's value.

  • cloudContainerImageTags (list) --

    The cloud container image tags used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudContainerRepositoryName (list) --

    The cloud container repository names used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudContainerRegistryName (list) --

    The cloud container registry names used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudServerlessFunctionName (list) --

    The cloud serverless function names used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudServerlessFunctionRuntime (list) --

    The cloud serverless function runtimes used as resource filter criteria.

    • (dict) --

      A resource string filter for a software bill of materials report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • value (string) -- [REQUIRED]

        The filter's value.

  • cloudServerlessFunctionTags (list) --

    The cloud serverless function tags used as resource filter criteria.

    • (dict) --

      A resource map filter for a software bill of material report.

      • comparison (string) -- [REQUIRED]

        The filter's comparison.

      • key (string) -- [REQUIRED]

        The filter's key.

      • value (string) --

        The filter's value.

type reportFormat:

string

param reportFormat:

[REQUIRED]

The output format for the software bill of materials (SBOM) report.

type s3Destination:

dict

param s3Destination:

[REQUIRED]

Contains details of the Amazon S3 bucket and KMS key used to export findings.

  • bucketName (string) -- [REQUIRED]

    The name of the Amazon S3 bucket to export findings to.

  • keyPrefix (string) --

    The prefix that the findings will be written under.

  • kmsKeyArn (string) -- [REQUIRED]

    The ARN of the KMS key used to encrypt data when exporting findings.

rtype:

dict

returns:

Response Syntax

{
    'reportId': 'string'
}

Response Structure

  • (dict) --

    • reportId (string) --

      The report ID for the software bill of materials (SBOM) report.

GetSbomExport (updated) Link ¶
Changes (response)
{'filterCriteria': {'cloudContainerImageTags': [{'comparison': 'EQUALS | '
                                                               'NOT_EQUALS',
                                                 'value': 'string'}],
                    'cloudContainerRegistryName': [{'comparison': 'EQUALS | '
                                                                  'NOT_EQUALS',
                                                    'value': 'string'}],
                    'cloudContainerRepositoryName': [{'comparison': 'EQUALS | '
                                                                    'NOT_EQUALS',
                                                      'value': 'string'}],
                    'cloudProvider': [{'comparison': 'EQUALS | NOT_EQUALS',
                                       'value': 'string'}],
                    'cloudProviderAccountId': [{'comparison': 'EQUALS | '
                                                              'NOT_EQUALS',
                                                'value': 'string'}],
                    'cloudProviderOrgId': [{'comparison': 'EQUALS | NOT_EQUALS',
                                            'value': 'string'}],
                    'cloudProviderRegion': [{'comparison': 'EQUALS | '
                                                           'NOT_EQUALS',
                                             'value': 'string'}],
                    'cloudServerlessFunctionName': [{'comparison': 'EQUALS | '
                                                                   'NOT_EQUALS',
                                                     'value': 'string'}],
                    'cloudServerlessFunctionRuntime': [{'comparison': 'EQUALS '
                                                                      '| '
                                                                      'NOT_EQUALS',
                                                        'value': 'string'}],
                    'cloudServerlessFunctionTags': [{'comparison': 'EQUALS',
                                                     'key': 'string',
                                                     'value': 'string'}],
                    'cloudVmInstanceTags': [{'comparison': 'EQUALS',
                                             'key': 'string',
                                             'value': 'string'}]}}

Gets details of a software bill of materials (SBOM) report.

See also: AWS API Documentation

Request Syntax

client.get_sbom_export(
    reportId='string'
)
type reportId:

string

param reportId:

[REQUIRED]

The report ID of the SBOM export to get details for.

rtype:

dict

returns:

Response Syntax

{
    'reportId': 'string',
    'format': 'CYCLONEDX_1_4'|'SPDX_2_3',
    'status': 'SUCCEEDED'|'IN_PROGRESS'|'CANCELLED'|'FAILED',
    'errorCode': 'INTERNAL_ERROR'|'INVALID_PERMISSIONS'|'NO_FINDINGS_FOUND'|'BUCKET_NOT_FOUND'|'INCOMPATIBLE_BUCKET_REGION'|'MALFORMED_KMS_KEY',
    'errorMessage': 'string',
    's3Destination': {
        'bucketName': 'string',
        'keyPrefix': 'string',
        'kmsKeyArn': 'string'
    },
    'filterCriteria': {
        'accountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ecrImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'ec2InstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'cloudProvider': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderAccountId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderOrgId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudProviderRegion': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudVmInstanceTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'cloudContainerImageTags': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudContainerRepositoryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudContainerRegistryName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'cloudServerlessFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • reportId (string) --

      The report ID of the software bill of materials (SBOM) report.

    • format (string) --

      The format of the software bill of materials (SBOM) report.

    • status (string) --

      The status of the software bill of materials (SBOM) report.

    • errorCode (string) --

      An error code.

    • errorMessage (string) --

      An error message.

    • s3Destination (dict) --

      Contains details of the Amazon S3 bucket and KMS key used to export findings

      • bucketName (string) --

        The name of the Amazon S3 bucket to export findings to.

      • keyPrefix (string) --

        The prefix that the findings will be written under.

      • kmsKeyArn (string) --

        The ARN of the KMS key used to encrypt data when exporting findings.

    • filterCriteria (dict) --

      Contains details about the resource filter criteria used for the software bill of materials (SBOM) report.

      • accountId (list) --

        The account IDs used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • resourceId (list) --

        The resource IDs used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • resourceType (list) --

        The resource types used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • ecrRepositoryName (list) --

        The ECR repository names used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • lambdaFunctionName (list) --

        The Amazon Web Services Lambda function name used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • ecrImageTags (list) --

        The ECR image tags used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • ec2InstanceTags (list) --

        The EC2 instance tags used as resource filter criteria.

        • (dict) --

          A resource map filter for a software bill of material report.

          • comparison (string) --

            The filter's comparison.

          • key (string) --

            The filter's key.

          • value (string) --

            The filter's value.

      • lambdaFunctionTags (list) --

        The Amazon Web Services Lambda function tags used as resource filter criteria.

        • (dict) --

          A resource map filter for a software bill of material report.

          • comparison (string) --

            The filter's comparison.

          • key (string) --

            The filter's key.

          • value (string) --

            The filter's value.

      • cloudProvider (list) --

        The cloud providers used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudProviderAccountId (list) --

        The cloud provider account IDs used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudProviderOrgId (list) --

        The cloud provider organization IDs used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudProviderRegion (list) --

        The cloud provider regions used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudVmInstanceTags (list) --

        The cloud VM instance tags used as resource filter criteria.

        • (dict) --

          A resource map filter for a software bill of material report.

          • comparison (string) --

            The filter's comparison.

          • key (string) --

            The filter's key.

          • value (string) --

            The filter's value.

      • cloudContainerImageTags (list) --

        The cloud container image tags used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudContainerRepositoryName (list) --

        The cloud container repository names used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudContainerRegistryName (list) --

        The cloud container registry names used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudServerlessFunctionName (list) --

        The cloud serverless function names used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudServerlessFunctionRuntime (list) --

        The cloud serverless function runtimes used as resource filter criteria.

        • (dict) --

          A resource string filter for a software bill of materials report.

          • comparison (string) --

            The filter's comparison.

          • value (string) --

            The filter's value.

      • cloudServerlessFunctionTags (list) --

        The cloud serverless function tags used as resource filter criteria.

        • (dict) --

          A resource map filter for a software bill of material report.

          • comparison (string) --

            The filter's comparison.

          • key (string) --

            The filter's key.

          • value (string) --

            The filter's value.