Inspector2 / Client / list_coverage

list_coverage

Inspector2.Client.list_coverage(**kwargs)

Lists coverage details for your environment.

See also: AWS API Documentation

Request Syntax

response = client.list_coverage(
    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'
            },
        ],
        'imagePulledAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'lambdaFunctionName': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionRuntime': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'lambdaFunctionTags': [
            {
                'comparison': 'EQUALS',
                'key': 'string',
                'value': 'string'
            },
        ],
        'lastScannedAt': [
            {
                'endInclusive': datetime(2015, 1, 1),
                'startInclusive': datetime(2015, 1, 1)
            },
        ],
        'resourceId': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'resourceType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanMode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusCode': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanStatusReason': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'scanType': [
            {
                'comparison': 'EQUALS'|'NOT_EQUALS',
                'value': 'string'
            },
        ]
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

• filterCriteria (dict) –

  An object that contains details on the filters to apply to the coverage data for your environment.

  • accountId (list) –

    An array of Amazon Web Services account IDs to return coverage statistics for.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • ec2InstanceTags (list) –

    The Amazon EC2 instance tags to filter on.

    • (dict) –

      Contains details of a coverage map filter.

      • comparison (string) – [REQUIRED]

        The operator to compare coverage on.

      • key (string) – [REQUIRED]

        The tag key associated with the coverage map filter.

      • value (string) –

        The tag value associated with the coverage map filter.

  • ecrImageTags (list) –

    The Amazon ECR image tags to filter on.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • ecrRepositoryName (list) –

    The Amazon ECR repository name to filter on.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • imagePulledAt (list) –

    The date an image was last pulled at.

    • (dict) –

      Contains details of a coverage date filter.

      • endInclusive (datetime) –

        A timestamp representing the end of the time period to filter results by.

      • startInclusive (datetime) –

        A timestamp representing the start of the time period to filter results by.

  • lambdaFunctionName (list) –

    Returns coverage statistics for Amazon Web Services Lambda functions filtered by function names.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • lambdaFunctionRuntime (list) –

    Returns coverage statistics for Amazon Web Services Lambda functions filtered by runtime.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • lambdaFunctionTags (list) –

    Returns coverage statistics for Amazon Web Services Lambda functions filtered by tag.

    • (dict) –

      Contains details of a coverage map filter.

      • comparison (string) – [REQUIRED]

        The operator to compare coverage on.

      • key (string) – [REQUIRED]

        The tag key associated with the coverage map filter.

      • value (string) –

        The tag value associated with the coverage map filter.

  • lastScannedAt (list) –

    Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.

    • (dict) –

      Contains details of a coverage date filter.

      • endInclusive (datetime) –

        A timestamp representing the end of the time period to filter results by.

      • startInclusive (datetime) –

        A timestamp representing the start of the time period to filter results by.

  • resourceId (list) –

    An array of Amazon Web Services resource IDs to return coverage statistics for.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • resourceType (list) –

    An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION, AWS_ECR_CONTAINER_IMAGE, AWS_ECR_REPOSITORY or AWS_ACCOUNT.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • scanMode (list) –

    The filter to search for Amazon EC2 instance coverage by scan mode. Valid values are EC2_SSM_AGENT_BASED and EC2_AGENTLESS.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • scanStatusCode (list) –

    The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • scanStatusReason (list) –

    The scan status reason to filter on.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

  • scanType (list) –

    An array of Amazon Inspector scan types to return coverage statistics for.

    • (dict) –

      Contains details of a coverage string filter.

      • comparison (string) – [REQUIRED]

        The operator to compare strings on.

      • value (string) – [REQUIRED]

        The value to compare strings on.

• maxResults (integer) – The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

• nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

Return type:

dict

Returns:

Response Syntax

{
    'coveredResources': [
        {
            'accountId': 'string',
            'lastScannedAt': datetime(2015, 1, 1),
            'resourceId': 'string',
            'resourceMetadata': {
                'ec2': {
                    'amiId': 'string',
                    'platform': 'WINDOWS'|'LINUX'|'UNKNOWN'|'MACOS',
                    'tags': {
                        'string': 'string'
                    }
                },
                'ecrImage': {
                    'imagePulledAt': datetime(2015, 1, 1),
                    'tags': [
                        'string',
                    ]
                },
                'ecrRepository': {
                    'name': 'string',
                    'scanFrequency': 'MANUAL'|'SCAN_ON_PUSH'|'CONTINUOUS_SCAN'
                },
                'lambdaFunction': {
                    'functionName': 'string',
                    'functionTags': {
                        'string': 'string'
                    },
                    'layers': [
                        'string',
                    ],
                    'runtime': 'NODEJS'|'NODEJS_12_X'|'NODEJS_14_X'|'NODEJS_16_X'|'JAVA_8'|'JAVA_8_AL2'|'JAVA_11'|'PYTHON_3_7'|'PYTHON_3_8'|'PYTHON_3_9'|'UNSUPPORTED'|'NODEJS_18_X'|'GO_1_X'|'JAVA_17'|'PYTHON_3_10'|'PYTHON_3_11'|'DOTNETCORE_3_1'|'DOTNET_6'|'DOTNET_7'|'RUBY_2_7'|'RUBY_3_2'
                }
            },
            'resourceType': 'AWS_EC2_INSTANCE'|'AWS_ECR_CONTAINER_IMAGE'|'AWS_ECR_REPOSITORY'|'AWS_LAMBDA_FUNCTION',
            'scanMode': 'EC2_SSM_AGENT_BASED'|'EC2_AGENTLESS',
            'scanStatus': {
                'reason': 'PENDING_INITIAL_SCAN'|'ACCESS_DENIED'|'INTERNAL_ERROR'|'UNMANAGED_EC2_INSTANCE'|'UNSUPPORTED_OS'|'SCAN_ELIGIBILITY_EXPIRED'|'RESOURCE_TERMINATED'|'SUCCESSFUL'|'NO_RESOURCES_FOUND'|'IMAGE_SIZE_EXCEEDED'|'SCAN_FREQUENCY_MANUAL'|'SCAN_FREQUENCY_SCAN_ON_PUSH'|'EC2_INSTANCE_STOPPED'|'PENDING_DISABLE'|'NO_INVENTORY'|'STALE_INVENTORY'|'EXCLUDED_BY_TAG'|'UNSUPPORTED_RUNTIME'|'UNSUPPORTED_MEDIA_TYPE'|'UNSUPPORTED_CONFIG_FILE'|'DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED'|'DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED'|'DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED'|'DEEP_INSPECTION_NO_INVENTORY'|'AGENTLESS_INSTANCE_STORAGE_LIMIT_EXCEEDED'|'AGENTLESS_INSTANCE_COLLECTION_TIME_LIMIT_EXCEEDED',
                'statusCode': 'ACTIVE'|'INACTIVE'
            },
            'scanType': 'NETWORK'|'PACKAGE'|'CODE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • coveredResources (list) –

    An object that contains details on the covered resources in your environment.

    • (dict) –

      An object that contains details about a resource covered by Amazon Inspector.

      • accountId (string) –

        The Amazon Web Services account ID of the covered resource.

      • lastScannedAt (datetime) –

        The date and time the resource was last checked for vulnerabilities.

      • resourceId (string) –

        The ID of the covered resource.

      • resourceMetadata (dict) –

        An object that contains details about the metadata.

        • ec2 (dict) –

          An object that contains metadata details for an Amazon EC2 instance.

          • amiId (string) –

            The ID of the Amazon Machine Image (AMI) used to launch the instance.

          • platform (string) –

            The platform of the instance.

          • tags (dict) –

            The tags attached to the instance.

            • (string) –

              • (string) –

        • ecrImage (dict) –

          An object that contains details about the container metadata for an Amazon ECR image.

          • imagePulledAt (datetime) –

            The date an image was last pulled at.

          • tags (list) –

            Tags associated with the Amazon ECR image metadata.

            • (string) –

        • ecrRepository (dict) –

          An object that contains details about the repository an Amazon ECR image resides in.

          • name (string) –

            The name of the Amazon ECR repository.

          • scanFrequency (string) –

            The frequency of scans.

        • lambdaFunction (dict) –

          An object that contains metadata details for an Amazon Web Services Lambda function.

          • functionName (string) –

            The name of a function.

          • functionTags (dict) –

            The resource tags on an Amazon Web Services Lambda function.

            • (string) –

              • (string) –

          • layers (list) –

            The layers for an Amazon Web Services Lambda function. A Lambda function can have up to five layers.

            • (string) –

          • runtime (string) –

            An Amazon Web Services Lambda function’s runtime.

      • resourceType (string) –

        The type of the covered resource.

      • scanMode (string) –

        The scan method that is applied to the instance.

      • scanStatus (dict) –

        The status of the scan covering the resource.

        • reason (string) –

          The scan status. Possible return values and descriptions are:

          PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.

          ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.

          INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.

          UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.

          UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

          SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.

          RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.

          SUCCESSFUL - The scan was successful.

          NO_RESOURCES_FOUND - Reserved for future use.

          IMAGE_SIZE_EXCEEDED - Reserved for future use.

          SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.

          ``SCAN_FREQUENCY_SCAN_ON_PUSH ``- This image will be scanned one time and will not new findings because of the scan frequency configuration.

          EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it’s in a stopped state.

          PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.

          NO INVENTORY - Amazon Inspector couldn’t find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance’s inventory in the SSM Fleet Manager console.

          STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.

          EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.

          UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

          ``UNSUPPORTED_MEDIA_TYPE ``- The ECR image has an unsupported media type.

          UNSUPPORTED_CONFIG_FILE - Reserved for future use.

          DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.

          DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn’t send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.

          DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.

          DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn’t yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.

        • statusCode (string) –

          The status code of the scan.

      • scanType (string) –

        The Amazon Inspector scan type covering the resource.

  • nextToken (string) –

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Exceptions

• Inspector2.Client.exceptions.ValidationException

• Inspector2.Client.exceptions.ThrottlingException

• Inspector2.Client.exceptions.InternalServerException