SWAMPy

✎ CARVE FLESH

EDITING: service-2.json

{
 "version":"2.0",
 "metadata":{
 "apiVersion":"2023-08-08",
 "endpointPrefix":"inspector-scan",
 "jsonVersion":"1.1",
 "protocol":"rest-json",
 "serviceAbbreviation":"inspector-scan",
 "serviceFullName":"Inspector Scan",
 "serviceId":"Inspector Scan",
 "signatureVersion":"v4",
 "signingName":"inspector-scan",
 "uid":"inspector-scan-2023-08-08"
 },
 "operations":{
 "ScanSbom":{
 "name":"ScanSbom",
 "http":{
 "method":"POST",
 "requestUri":"/scan/sbom",
 "responseCode":200
 },
 "input":{"shape":"ScanSbomRequest"},
 "output":{"shape":"ScanSbomResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"},
 {"shape":"AccessDeniedException"}
 ],
 "documentation":"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 <a href=\"\">Amazon Inspector SBOM generator</a>.",
 "idempotent":true
 }
 },
 "shapes":{
 "AccessDeniedException":{
 "type":"structure",
 "required":["message"],
 "members":{
 "message":{"shape":"String"}
 },
 "documentation":"You do not have sufficient access to perform this action. ",
 "error":{
 "httpStatusCode":403,
 "senderFault":true
 },
 "exception":true
 },
 "Integer":{
 "type":"integer",
 "box":true
 },
 "InternalServerException":{
 "type":"structure",
 "required":[
 "message",
 "reason"
 ],
 "members":{
 "message":{"shape":"String"},
 "reason":{
 "shape":"InternalServerExceptionReason",
 "documentation":"The reason for the validation failure."
 },
 "retryAfterSeconds":{
 "shape":"Integer",
 "documentation":"The number of seconds to wait before retrying the request.",
 "location":"header",
 "locationName":"Retry-After"
 }
 },
 "documentation":"The request processing has failed because of an unknown error, exception or failure. ",
 "error":{"httpStatusCode":500},
 "exception":true,
 "fault":true,
 "retryable":{"throttling":false}
 },
 "InternalServerExceptionReason":{
 "type":"string",
 "enum":[
 "FAILED_TO_GENERATE_SBOM",
 "OTHER"
 ]
 },
 "OutputFormat":{
 "type":"string",
 "enum":[
 "CYCLONE_DX_1_5",
 "INSPECTOR"
 ]
 },
 "Sbom":{
 "type":"structure",
 "members":{
 },
 "document":true
 },
 "ScanSbomRequest":{
 "type":"structure",
 "required":["sbom"],
 "members":{
 "sbom":{
 "shape":"Sbom",
 "documentation":"The JSON file for the SBOM you want to scan. The SBOM must be in CycloneDX 1.5 format."
 },
 "outputFormat":{
 "shape":"OutputFormat",
 "documentation":"The output format for the vulnerability report."
 }
 }
 },
 "ScanSbomResponse":{
 "type":"structure",
 "members":{
 "sbom":{
 "shape":"Sbom",
 "documentation":"The vulnerability report for the scanned SBOM."
 }
 }
 },
 "String":{"type":"string"},
 "ThrottlingException":{
 "type":"structure",
 "required":["message"],
 "members":{
 "message":{"shape":"String"},
 "retryAfterSeconds":{
 "shape":"Integer",
 "documentation":"The number of seconds to wait before retrying the request.",
 "location":"header",
 "locationName":"Retry-After"
 }
 },
 "documentation":"The request was denied due to request throttling. ",
 "error":{
 "httpStatusCode":429,
 "senderFault":true
 },
 "exception":true,
 "retryable":{"throttling":true}
 },
 "ValidationException":{
 "type":"structure",
 "required":[
 "message",
 "reason"
 ],
 "members":{
 "message":{"shape":"String"},
 "reason":{
 "shape":"ValidationExceptionReason",
 "documentation":"The reason for the validation failure."
 },
 "fields":{
 "shape":"ValidationExceptionFields",
 "documentation":"The fields that failed validation."
 }
 },
 "documentation":"The request has failed validation due to missing required fields or having invalid inputs.",
 "error":{
 "httpStatusCode":400,
 "senderFault":true
 },
 "exception":true
 },
 "ValidationExceptionField":{
 "type":"structure",
 "required":[
 "name",
 "message"
 ],
 "members":{
 "name":{
 "shape":"String",
 "documentation":"The name of the validation exception. "
 },
 "message":{
 "shape":"String",
 "documentation":"The validation exception message. "
 }
 },
 "documentation":"The request has failed validation due to missing required fields or having invalid inputs. "
 },
 "ValidationExceptionFields":{
 "type":"list",
 "member":{"shape":"ValidationExceptionField"}
 },
 "ValidationExceptionReason":{
 "type":"string",
 "enum":[
 "UNKNOWN_OPERATION",
 "CANNOT_PARSE",
 "FIELD_VALIDATION_FAILED",
 "UNSUPPORTED_SBOM_TYPE",
 "OTHER"
 ]
 }
 },
 "documentation":"Amazon Inspector Scan is a vulnerability discovery service that scans a provided Software Bill of Materials (SBOM) for security vulnerabilities."
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 endpoint-rule-set-1.json	JSON	17.2 KB	2024-02-20 19:02	EDIT
📄 paginators-1.json	JSON	23 B	2024-02-20 19:02	EDIT
📄 service-2.json	JSON	5.7 KB	2024-02-20 19:02	EDIT