Lists coverage details for your environment¶

Description¶

Lists coverage details for your environment.

Usage¶

inspector2_list_coverage(maxResults, nextToken, filterCriteria)

Arguments¶

maxResults

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

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

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

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  coveredResources = list(
    list(
      resourceType = "AWS_EC2_INSTANCE"|"AWS_ECR_CONTAINER_IMAGE"|"AWS_ECR_REPOSITORY"|"AWS_LAMBDA_FUNCTION"|"CODE_REPOSITORY"|"Microsoft.Compute/virtualMachines"|"Microsoft.ContainerRegistry/registry/containerImage"|"Microsoft.ContainerRegistry/registry/containerRepository"|"Microsoft.Web/sites"|"Microsoft.ContainerRegistry/registries",
      resourceId = "string",
      accountId = "string",
      scanType = "NETWORK"|"PACKAGE"|"CODE",
      scanStatus = list(
        statusCode = "ACTIVE"|"INACTIVE",
        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"|"PENDING_REVIVAL_SCAN"|"INTEGRATION_CONNECTION_LOST"|"ACCESS_DENIED_TO_ENCRYPTION_KEY"|"UNSUPPORTED_LANGUAGE"|"NO_SCAN_CONFIGURATION_ASSOCIATED"|"SCAN_IN_PROGRESS"|"IMAGE_ARCHIVED"|"UNSUPPORTED_CODE_ARTIFACTS"|"RESOURCE_UNMANAGED"|"RESOURCE_STOPPED"
      ),
      resourceMetadata = list(
        ecrRepository = list(
          name = "string",
          scanFrequency = "MANUAL"|"SCAN_ON_PUSH"|"CONTINUOUS_SCAN"
        ),
        ecrImage = list(
          tags = list(
            "string"
          ),
          imagePulledAt = as.POSIXct(
            "2015-01-01"
          ),
          lastInUseAt = as.POSIXct(
            "2015-01-01"
          ),
          inUseCount = 123
        ),
        ec2 = list(
          tags = list(
            "string"
          ),
          amiId = "string",
          platform = "WINDOWS"|"LINUX"|"UNKNOWN"|"MACOS"
        ),
        lambdaFunction = list(
          functionTags = list(
            "string"
          ),
          layers = list(
            "string"
          ),
          functionName = "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"|"DOTNET_10"|"NODEJS_24_X"|"NODEJS_22_X"|"JAVA_21"|"JAVA_25"|"PYTHON_3_12"|"PYTHON_3_13"|"PYTHON_3_14"|"RUBY_3_3"|"DOTNET_8"|"NODEJS_20_X"
        ),
        codeRepository = list(
          projectName = "string",
          integrationArn = "string",
          providerType = "string",
          providerTypeVisibility = "string",
          lastScannedCommitId = "string",
          scanConfiguration = list(
            periodicScanConfigurations = list(
              list(
                frequencyExpression = "string",
                ruleSetCategories = list(
                  "SAST"|"IAC"|"SCA"
                )
              )
            ),
            continuousIntegrationScanConfigurations = list(
              list(
                supportedEvent = "PULL_REQUEST"|"PUSH",
                ruleSetCategories = list(
                  "SAST"|"IAC"|"SCA"
                )
              )
            )
          ),
          onDemandScan = list(
            lastScannedCommitId = "string",
            lastScanAt = as.POSIXct(
              "2015-01-01"
            ),
            scanStatus = list(
              statusCode = "ACTIVE"|"INACTIVE",
              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"|"PENDING_REVIVAL_SCAN"|"INTEGRATION_CONNECTION_LOST"|"ACCESS_DENIED_TO_ENCRYPTION_KEY"|"UNSUPPORTED_LANGUAGE"|"NO_SCAN_CONFIGURATION_ASSOCIATED"|"SCAN_IN_PROGRESS"|"IMAGE_ARCHIVED"|"UNSUPPORTED_CODE_ARTIFACTS"|"RESOURCE_UNMANAGED"|"RESOURCE_STOPPED"
            )
          )
        ),
        vmInstance = list(
          tags = list(
            "string"
          ),
          platform = "WINDOWS"|"LINUX"|"UNKNOWN",
          inventoryHash = "string",
          vmImageReference = "string"
        ),
        containerImage = list(
          imageTags = list(
            "string"
          ),
          imagePulledAt = as.POSIXct(
            "2015-01-01"
          ),
          lastInUseAt = as.POSIXct(
            "2015-01-01"
          ),
          inUseCount = 123
        ),
        containerRepository = list(
          name = "string",
          scanFrequency = "string"
        ),
        containerRegistry = list(
          name = "string"
        ),
        serverlessFunction = list(
          serverlessFunctionName = "string",
          runtime = "string",
          functionTags = list(
            "string"
          )
        )
      ),
      lastScannedAt = as.POSIXct(
        "2015-01-01"
      ),
      scanMode = "EC2_SSM_AGENT_BASED"|"EC2_AGENTLESS"|"EC2_INSPECTOR_AGENT_BASED"|"VM_INSPECTOR_AGENT_BASED",
      provider = "AWS"|"AZURE",
      providerAccountId = "string",
      providerOrgId = "string",
      providerRegion = "string",
      providerPartition = "string"
    )
  )
)

Request syntax¶

svc$list_coverage(
  maxResults = 123,
  nextToken = "string",
  filterCriteria = list(
    scanStatusCode = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    scanStatusReason = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    accountId = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    resourceId = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    resourceType = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    scanType = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    ecrRepositoryName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    ecrImageTags = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    ec2InstanceTags = list(
      list(
        comparison = "EQUALS",
        key = "string",
        value = "string"
      )
    ),
    lambdaFunctionName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    lambdaFunctionTags = list(
      list(
        comparison = "EQUALS",
        key = "string",
        value = "string"
      )
    ),
    lambdaFunctionRuntime = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    lastScannedAt = list(
      list(
        startInclusive = as.POSIXct(
          "2015-01-01"
        ),
        endInclusive = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    scanMode = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    imagePulledAt = list(
      list(
        startInclusive = as.POSIXct(
          "2015-01-01"
        ),
        endInclusive = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    ecrImageLastInUseAt = list(
      list(
        startInclusive = as.POSIXct(
          "2015-01-01"
        ),
        endInclusive = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    ecrImageInUseCount = list(
      list(
        upperInclusive = 123,
        lowerInclusive = 123
      )
    ),
    codeRepositoryProjectName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    codeRepositoryProviderType = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    codeRepositoryProviderTypeVisibility = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    lastScannedCommitId = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudProvider = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudProviderAccountId = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudProviderRegion = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudVmInstanceTags = list(
      list(
        comparison = "EQUALS",
        key = "string",
        value = "string"
      )
    ),
    cloudContainerImageTags = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudContainerRepositoryName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudContainerRegistryName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudServerlessFunctionName = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudServerlessFunctionRuntime = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    ),
    cloudServerlessFunctionTags = list(
      list(
        comparison = "EQUALS",
        key = "string",
        value = "string"
      )
    ),
    cloudProviderOrgId = list(
      list(
        comparison = "EQUALS"|"NOT_EQUALS",
        value = "string"
      )
    )
  )
)