openapi: 3.0.0 info: version: '2020-06-08' x-release: v4 title: Inspector2 Accountpermissions Organizationconfiguration 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: Organizationconfiguration paths: /organizationconfiguration/describe: 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' post: operationId: DescribeOrganizationConfiguration description: Describe Amazon Inspector configuration settings for an Amazon Web Services organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeOrganizationConfigurationResponse' '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: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] summary: Amazon Inspector Describe Organization Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Organizationconfiguration /organizationconfiguration/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' post: operationId: UpdateOrganizationConfiguration description: Updates the configurations for your Amazon Inspector organization. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateOrganizationConfigurationResponse' '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '481': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - autoEnable properties: autoEnable: description: Represents which scan types are automatically enabled for new members of your Amazon Inspector organization. type: object properties: ec2: allOf: - $ref: '#/components/schemas/Boolean' - description: Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization. ecr: allOf: - $ref: '#/components/schemas/Boolean' - description: Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization. lambda: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Represents whether AWS Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization. ' lambdaCode: allOf: - $ref: '#/components/schemas/Boolean' - description: Represents whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization.
</p>
summary: Amazon Inspector Update Organization Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Organizationconfiguration
components:
schemas:
DescribeOrganizationConfigurationResponse:
type: object
properties:
autoEnable:
allOf:
- $ref: '#/components/schemas/AutoEnable'
- description: The scan types are automatically enabled for new members of your organization.
maxAccountLimitReached:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Represents whether your organization has reached the maximum Amazon Web Services account limit for Amazon Inspector.
InternalServerException: {}
AutoEnable:
type: object
required:
- ec2
- ecr
properties:
ec2:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Represents whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization.
ecr:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Represents whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization.
lambda:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Represents whether AWS Lambda standard scans are automatically enabled for new members of your Amazon Inspector organization. '
lambdaCode:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Represents whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization. </p>
description: Represents which scan types are automatically enabled for new members of your Amazon Inspector organization.
Boolean:
type: boolean
AccessDeniedException: {}
ThrottlingException: {}
UpdateOrganizationConfigurationResponse:
type: object
required:
- autoEnable
properties:
autoEnable:
allOf:
- $ref: '#/components/schemas/AutoEnable'
- description: The updated status of scan types automatically enabled for new members of your Amazon Inspector organization.
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