@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Amazon Inspector
@version 2016-02-16
@auth AWS SigV4
@endpoints 37
@hint download_for_search
@toc root(37)

@endpoint POST /
@required {findingArns: [str], attributes: [Attribute]}
@returns(200) {failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {assessmentTargetName: str}
@optional {resourceGroupArn: str}
@returns(200) {assessmentTargetArn: str}

@endpoint POST /
@required {assessmentTargetArn: str, assessmentTemplateName: str, durationInSeconds: int, rulesPackageArns: [str]}
@optional {userAttributesForFindings: [Attribute]}
@returns(200) {assessmentTemplateArn: str}

@endpoint POST /
@required {assessmentTemplateArn: str}
@returns(200) {previewToken: str}

@endpoint POST /
@required {resourceGroupTags: [ResourceGroupTag]}
@returns(200) {resourceGroupArn: str}

@endpoint POST /
@required {assessmentRunArn: str}

@endpoint POST /
@required {assessmentTargetArn: str}

@endpoint POST /
@required {assessmentTemplateArn: str}

@endpoint POST /
@required {assessmentRunArns: [str]}
@returns(200) {assessmentRuns: [AssessmentRun], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {assessmentTargetArns: [str]}
@returns(200) {assessmentTargets: [AssessmentTarget], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {assessmentTemplateArns: [str]}
@returns(200) {assessmentTemplates: [AssessmentTemplate], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@returns(200) {roleArn: str, valid: bool, registeredAt: str(timestamp)}

@endpoint POST /
@required {exclusionArns: [str]}
@optional {locale: str}
@returns(200) {exclusions: map<str,Exclusion>, failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {findingArns: [str]}
@optional {locale: str}
@returns(200) {findings: [Finding], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {resourceGroupArns: [str]}
@returns(200) {resourceGroups: [ResourceGroup], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {rulesPackageArns: [str]}
@optional {locale: str}
@returns(200) {rulesPackages: [RulesPackage], failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {assessmentRunArn: str, reportFileFormat: str, reportType: str}
@returns(200) {status: str, url: str?}

@endpoint POST /
@required {assessmentTemplateArn: str, previewToken: str}
@optional {nextToken: str, maxResults: int, locale: str}
@returns(200) {previewStatus: str, exclusionPreviews: [ExclusionPreview]?, nextToken: str?}

@endpoint POST /
@required {assessmentRunArn: str}
@returns(200) {telemetryMetadata: [TelemetryMetadata]}

@endpoint POST /
@required {assessmentRunArn: str}
@optional {filter: AgentFilter, nextToken: str, maxResults: int}
@returns(200) {assessmentRunAgents: [AssessmentRunAgent], nextToken: str?}

@endpoint POST /
@optional {assessmentTemplateArns: [str], filter: AssessmentRunFilter, nextToken: str, maxResults: int}
@returns(200) {assessmentRunArns: [str], nextToken: str?}

@endpoint POST /
@optional {filter: AssessmentTargetFilter, nextToken: str, maxResults: int}
@returns(200) {assessmentTargetArns: [str], nextToken: str?}

@endpoint POST /
@optional {assessmentTargetArns: [str], filter: AssessmentTemplateFilter, nextToken: str, maxResults: int}
@returns(200) {assessmentTemplateArns: [str], nextToken: str?}

@endpoint POST /
@optional {resourceArn: str, nextToken: str, maxResults: int}
@returns(200) {subscriptions: [Subscription], nextToken: str?}

@endpoint POST /
@required {assessmentRunArn: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {exclusionArns: [str], nextToken: str?}

@endpoint POST /
@optional {assessmentRunArns: [str], filter: FindingFilter, nextToken: str, maxResults: int}
@returns(200) {findingArns: [str], nextToken: str?}

@endpoint POST /
@optional {nextToken: str, maxResults: int}
@returns(200) {rulesPackageArns: [str], nextToken: str?}

@endpoint POST /
@required {resourceArn: str}
@returns(200) {tags: [Tag]}

@endpoint POST /
@required {previewAgentsArn: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {agentPreviews: [AgentPreview], nextToken: str?}

@endpoint POST /
@required {roleArn: str}

@endpoint POST /
@required {findingArns: [str], attributeKeys: [str]}
@returns(200) {failedItems: map<str,FailedItemDetails>}

@endpoint POST /
@required {resourceArn: str}
@optional {tags: [Tag]}

@endpoint POST /
@required {assessmentTemplateArn: str}
@optional {assessmentRunName: str}
@returns(200) {assessmentRunArn: str}

@endpoint POST /
@required {assessmentRunArn: str}
@optional {stopAction: str}

@endpoint POST /
@required {resourceArn: str, event: str, topicArn: str}

@endpoint POST /
@required {resourceArn: str, event: str, topicArn: str}

@endpoint POST /
@required {assessmentTargetArn: str, assessmentTargetName: str}
@optional {resourceGroupArn: str}

@end