openapi: 3.0.0 info: version: '2018-05-10' x-release: v4 title: Amazon CodeGuru Security AccountConfiguration UpdateAccountConfiguration API description:

Amazon CodeGuru Security is in preview release and is subject to change.

This section provides documentation for the Amazon CodeGuru Security API operations. CodeGuru Security is a service that uses program analysis and machine learning to detect security policy violations and vulnerabilities, and recommends ways to address these security risks.

By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the Amazon CodeGuru Security User Guide.

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: codeguru-security x-aws-signingName: codeguru-security x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codeguru-security-2018-05-10.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://codeguru-security.{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 Amazon CodeGuru Security multi-region endpoint - url: https://codeguru-security.{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 Amazon CodeGuru Security multi-region endpoint - url: http://codeguru-security.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon CodeGuru Security endpoint for China (Beijing) and China (Ningxia) - url: https://codeguru-security.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon CodeGuru Security endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: UpdateAccountConfiguration paths: /updateAccountConfiguration: 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: UpdateAccountConfiguration description: Use to update account-level configuration with an encryption key. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateAccountConfigurationResponse' examples: UpdateAccountConfiguration200Example: summary: Default UpdateAccountConfiguration 200 response x-microcks-default: true value: encryptionConfig: example-value '480': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' examples: UpdateAccountConfiguration480Example: summary: Default UpdateAccountConfiguration 480 response x-microcks-default: true value: '123456789012' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' examples: UpdateAccountConfiguration481Example: summary: Default UpdateAccountConfiguration 481 response x-microcks-default: true value: '123456789012' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' examples: UpdateAccountConfiguration482Example: summary: Default UpdateAccountConfiguration 482 response x-microcks-default: true value: '123456789012' '483': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' examples: UpdateAccountConfiguration483Example: summary: Default UpdateAccountConfiguration 483 response x-microcks-default: true value: '123456789012' '484': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' examples: UpdateAccountConfiguration484Example: summary: Default UpdateAccountConfiguration 484 response x-microcks-default: true value: '123456789012' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - encryptionConfig properties: encryptionConfig: description: Information about account-level configuration. type: object properties: kmsKeyArn: allOf: - $ref: '#/components/schemas/KmsKeyArn' - description: The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource. examples: UpdateAccountConfigurationRequestExample: summary: Default UpdateAccountConfiguration request x-microcks-default: true value: encryptionConfig: kmsKeyArn: arn:aws:service:us-east-1:123456789012:resource/example summary: Amazon CodeGuru Security Update Account Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - UpdateAccountConfiguration components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 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-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false schemas: ResourceNotFoundException: {} KmsKeyArn: type: string pattern: ^arn:aws:kms:[\S]+:[\d]{12}:key\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$ minLength: 1 maxLength: 2048 ThrottlingException: {} EncryptionConfig: type: object properties: kmsKeyArn: allOf: - $ref: '#/components/schemas/KmsKeyArn' - description: The KMS key ARN to use for encryption. This must be provided as a header when uploading your code resource. description: Information about account-level configuration. UpdateAccountConfigurationResponse: type: object required: - encryptionConfig properties: encryptionConfig: allOf: - $ref: '#/components/schemas/EncryptionConfig' - description: An EncryptionConfig object that contains the KMS key ARN to use for encryption. AccessDeniedException: {} InternalServerException: {} ValidationException: {} 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/codeguru-security/ x-hasEquivalentPaths: true