openapi: 3.0.0 info: version: '2020-06-08' x-release: v4 title: Inspector2 Accountpermissions Encryptionkey API description: Amazon Inspector is a vulnerability discovery service that automates continuous scanning for security vulnerabilities within your Amazon EC2 and Amazon ECR environments. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: inspector2 x-aws-signingName: inspector2 x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/inspector2-2020-06-08.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://inspector2.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Inspector2 multi-region endpoint - url: https://inspector2.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Inspector2 multi-region endpoint - url: http://inspector2.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Inspector2 endpoint for China (Beijing) and China (Ningxia) - url: https://inspector2.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Inspector2 endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Encryptionkey paths: /encryptionkey/get#resourceType&scanType: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetEncryptionKey description: Gets an encryption key. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetEncryptionKeyResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: - name: resourceType in: query required: true description: The resource type the key encrypts. schema: type: string enum: - AWS_EC2_INSTANCE - AWS_ECR_CONTAINER_IMAGE - AWS_ECR_REPOSITORY - AWS_LAMBDA_FUNCTION - name: scanType in: query required: true description: The scan type the key encrypts. schema: type: string enum: - NETWORK - PACKAGE - CODE summary: Amazon Inspector Get Encryption Key x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Encryptionkey /encryptionkey/reset: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: ResetEncryptionKey description: Resets an encryption key. After the key is reset your resources will be encrypted by an Amazon Web Services owned key. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResetEncryptionKeyResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - resourceType - scanType properties: resourceType: description: The resource type the key encrypts. type: string enum: - AWS_EC2_INSTANCE - AWS_ECR_CONTAINER_IMAGE - AWS_ECR_REPOSITORY - AWS_LAMBDA_FUNCTION scanType: description: The scan type the key encrypts. type: string enum: - NETWORK - PACKAGE - CODE summary: Amazon Inspector Reset Encryption Key x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Encryptionkey /encryptionkey/update: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateEncryptionKey description: Updates an encryption key. A ResourceNotFoundException means that an AWS owned key is being used for encryption. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateEncryptionKeyResponse' '480': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - kmsKeyId - resourceType - scanType properties: kmsKeyId: description: A KMS key ID for the encryption key. type: string pattern: ^arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))$ resourceType: description: The resource type for the encryption key. type: string enum: - AWS_EC2_INSTANCE - AWS_ECR_CONTAINER_IMAGE - AWS_ECR_REPOSITORY - AWS_LAMBDA_FUNCTION scanType: description: The scan type for the encryption key. type: string enum: - NETWORK - PACKAGE - CODE summary: Amazon Inspector Update Encryption Key x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Encryptionkey components: schemas: GetEncryptionKeyResponse: type: object required: - kmsKeyId properties: kmsKeyId: allOf: - $ref: '#/components/schemas/KmsKeyArn' - description: A kms key ID. InternalServerException: {} ResetEncryptionKeyResponse: type: object properties: {} AccessDeniedException: {} KmsKeyArn: type: string pattern: ^arn:aws(-(us-gov|cn))?:kms:([a-z0-9][-.a-z0-9]{0,62})?:[0-9]{12}?:key/(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(mrk-[0-9a-zA-Z]{32}))$ UpdateEncryptionKeyResponse: type: object properties: {} ThrottlingException: {} ResourceNotFoundException: {} ValidationException: {} parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/inspector2/ x-hasEquivalentPaths: true