inspectorscan.d.ts 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class InspectorScan extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: InspectorScan.Types.ClientConfiguration)
  13. config: Config & InspectorScan.Types.ClientConfiguration;
  14. /**
  15. * Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the Amazon Inspector SBOM generator.
  16. */
  17. scanSbom(params: InspectorScan.Types.ScanSbomRequest, callback?: (err: AWSError, data: InspectorScan.Types.ScanSbomResponse) => void): Request<InspectorScan.Types.ScanSbomResponse, AWSError>;
  18. /**
  19. * Scans a provided CycloneDX 1.5 SBOM and reports on any vulnerabilities discovered in that SBOM. You can generate compatible SBOMs for your resources using the Amazon Inspector SBOM generator.
  20. */
  21. scanSbom(callback?: (err: AWSError, data: InspectorScan.Types.ScanSbomResponse) => void): Request<InspectorScan.Types.ScanSbomResponse, AWSError>;
  22. }
  23. declare namespace InspectorScan {
  24. export type OutputFormat = "CYCLONE_DX_1_5"|"INSPECTOR"|string;
  25. export interface Sbom {
  26. }
  27. export interface ScanSbomRequest {
  28. /**
  29. * The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format.
  30. */
  31. sbom: Sbom;
  32. /**
  33. * The output format for the vulnerability report.
  34. */
  35. outputFormat?: OutputFormat;
  36. }
  37. export interface ScanSbomResponse {
  38. /**
  39. * The vulnerability report for the scanned SBOM.
  40. */
  41. sbom?: Sbom;
  42. }
  43. /**
  44. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  45. */
  46. export type apiVersion = "2023-08-08"|"latest"|string;
  47. export interface ClientApiVersions {
  48. /**
  49. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  50. */
  51. apiVersion?: apiVersion;
  52. }
  53. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  54. /**
  55. * Contains interfaces for use with the InspectorScan client.
  56. */
  57. export import Types = InspectorScan;
  58. }
  59. export = InspectorScan;