Inspector2 / Client / get_sbom_export

get_sbom_export

Inspector2.Client.get_sbom_export(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_sbom_export(
    reportId='string'
)

Parameters:

reportId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • errorCode (string) –

    An error code.

  • errorMessage (string) –

    An error message.

  • 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.

    • 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.

    • 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.

    • 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 AWS 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.

    • lambdaFunctionTags (list) –

      The AWS 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.

    • 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.

  • format (string) –

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

  • reportId (string) –

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

  • 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.

  • status (string) –

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

Exceptions

• Inspector2.Client.exceptions.ValidationException

• Inspector2.Client.exceptions.AccessDeniedException

• Inspector2.Client.exceptions.ResourceNotFoundException

• Inspector2.Client.exceptions.ThrottlingException

• Inspector2.Client.exceptions.InternalServerException