Amazon EC2 Ec2 Allowed Images Setting API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Allowed Images Setting API
  version: '2016-11-15'
  description: Generated from AWS's published Smithy model for Amazon Elastic Compute Cloud. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ec2.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Allowed Images Setting
paths:
  /?Action=DisableAllowedImagesSettings:
    post:
      operationId: DisableAllowedImagesSettings
      summary: Disable Allowed Images Settings
      description: Disables Allowed AMIs for your account in the specified Amazon Web Services Region. When set to disabled, the image criteria in your Allowed AMIs settings do not apply, and no restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisableAllowedImagesSettingsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DisableAllowedImagesSettings
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DisableAllowedImagesSettingsRequest'
      tags:
      - Allowed Images Setting
  /?Action=EnableAllowedImagesSettings:
    post:
      operationId: EnableAllowedImagesSettings
      summary: Enable Allowed Images Settings
      description: 'Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are accepted: enabled: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances. audit-mode: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. The purpose of audit-mode is to indicate which AMIs will be affected when Allowed AMIs is enabled. In audit-mode, each AMI displays either "ImageAllowed": true or "ImageAllowed": false to indicate whether the AMI will be discoverable and available to users in the account when Allowed AMIs is enabled. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EnableAllowedImagesSettingsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: EnableAllowedImagesSettings
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/EnableAllowedImagesSettingsRequest'
      tags:
      - Allowed Images Setting
  /?Action=GetAllowedImagesSettings:
    post:
      operationId: GetAllowedImagesSettings
      summary: Get Allowed Images Settings
      description: Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region. The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetAllowedImagesSettingsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: GetAllowedImagesSettings
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/GetAllowedImagesSettingsRequest'
      tags:
      - Allowed Images Setting
components:
  schemas:
    GetAllowedImagesSettingsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    ImageCriterion:
      type: object
      properties:
        ImageProviders:
          type: array
          items:
            type: string
          description: 'The image providers whose images are allowed. Possible values: amazon: Allow AMIs created by Amazon or verified providers. aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services Marketplace. aws-backup-vault: Allow AMIs created by Amazon Web Services Backup. 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified. none: Allow AMIs created by your own account only. Maximum: 200 values'
        MarketplaceProductCodes:
          type: array
          items:
            type: string
          description: 'The Amazon Web Services Marketplace product codes for allowed images. Length: 1-25 characters Valid characters: Letters (A–Z, a–z) and numbers (0–9) Maximum: 50 values'
        ImageNames:
          type: array
          items:
            type: string
          description: 'The names of allowed images. Names can include wildcards (? and *). Length: 1–128 characters. With ?, the minimum is 3 characters. Valid characters: Letters: A–Z, a–z Numbers: 0–9 Special characters: ( ) [ ] . / - '' @ _ * ? Spaces Maximum: 50 values'
        DeprecationTimeCondition:
          $ref: '#/components/schemas/DeprecationTimeCondition'
        CreationDateCondition:
          $ref: '#/components/schemas/CreationDateCondition'
        ImageWatermarks:
          type: array
          items:
            $ref: '#/components/schemas/ImageWatermarkFilterResponse'
          description: 'The watermark criteria that an AMI must match to be allowed. An AMI is allowed if it carries at least one watermark that satisfies an ImageWatermarkFilter. A watermark satisfies a filter when all specified fields in the ImageWatermarkFilter match the corresponding values on the watermark of the AMI. Maximum: 50 values'
        ScanResultCondition:
          $ref: '#/components/schemas/ScanResultCondition'
    ImageWatermarkFilterResponse:
      type: object
      properties:
        WatermarkKey:
          type: string
          description: The accountId:name of the watermark. Supports wildcards (*, ?).
        SourceImageRegion:
          type: string
          description: The Region where the watermark was originally created. Supports wildcards (*, ?).
        MaximumDaysSinceSourceImageCreated:
          type: integer
          description: 'The maximum number of days that have elapsed since the source image was created. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaximumDaysSinceWatermarkCreated:
          type: integer
          description: 'The maximum number of days that have elapsed since the watermark was attached to the image. Constraints: Minimum value of 0. Maximum value of 2147483647.'
    ScanResultCondition:
      type: object
      properties:
        MaxDaysSinceLastFindingScan:
          type: integer
          description: 'The maximum number of days that have elapsed since Amazon Inspector last scanned the AMI. For example, a value of 7 allows AMIs that were scanned within the last 7 days. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaximumSeverityLabel:
          type: string
          enum:
          - informational
          - low
          - medium
          - high
          - critical
          description: 'The maximum severity that an AMI''s Amazon Inspector findings can have for the AMI to be allowed. Findings count whether or not a fix is available. For example, a value of medium allows AMIs whose highest severity is informational, low, or medium. The valid values are the following Amazon Inspector severity levels, which correspond to CVSS score ranges: informational - CVSS score of 0. low - CVSS score of 0.1 to 3.9. medium - CVSS score of 4.0 to 6.9. high - CVSS score of 7.0 to 8.9. critical - CVSS score of 9.0 to 10.0. For more information, see Software package vulnerability severity in the A'
        MaxDaysSinceInformationalFixAvailable:
          type: integer
          description: 'The maximum number of days since Amazon Inspector reported a fix as available for an informational severity finding on the AMI. For example, a value of 7 does not allow an AMI if Amazon Inspector reported such a fix more than 7 days ago. A scanned AMI that has no informational severity finding with a fix available meets this limit. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaxDaysSinceLowFixAvailable:
          type: integer
          description: 'The maximum number of days since Amazon Inspector reported a fix as available for a low severity finding on the AMI. For example, a value of 7 does not allow an AMI if Amazon Inspector reported such a fix more than 7 days ago. A scanned AMI that has no low severity finding with a fix available meets this limit. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaxDaysSinceMediumFixAvailable:
          type: integer
          description: 'The maximum number of days since Amazon Inspector reported a fix as available for a medium severity finding on the AMI. For example, a value of 7 does not allow an AMI if Amazon Inspector reported such a fix more than 7 days ago. A scanned AMI that has no medium severity finding with a fix available meets this limit. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaxDaysSinceHighFixAvailable:
          type: integer
          description: 'The maximum number of days since Amazon Inspector reported a fix as available for a high severity finding on the AMI. For example, a value of 7 does not allow an AMI if Amazon Inspector reported such a fix more than 7 days ago. A scanned AMI that has no high severity finding with a fix available meets this limit. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
        MaxDaysSinceCriticalFixAvailable:
          type: integer
          description: 'The maximum number of days since Amazon Inspector reported a fix as available for a critical severity finding on the AMI. For example, a value of 7 does not allow an AMI if Amazon Inspector reported such a fix more than 7 days ago. A scanned AMI that has no critical severity finding with a fix available meets this limit. AMIs that Amazon Inspector has not scanned are not allowed. Constraints: Minimum value of 0. Maximum value of 2147483647.'
    DisableAllowedImagesSettingsRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
    DisableAllowedImagesSettingsResult:
      type: object
      properties:
        AllowedImagesSettingsState:
          type: string
          enum:
          - disabled
          description: Returns disabled if the request succeeds; otherwise, it returns an error.
    EnableAllowedImagesSettingsRequest:
      type: object
      properties:
        AllowedImagesSettingsState:
          type: string
          enum:
          - enabled
          - audit-mode
          description: Specify enabled to apply the image criteria specified by the Allowed AMIs settings. Specify audit-mode so that you can check which AMIs will be allowed or not allowed by the image criteria.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      required:
      - AllowedImagesSettingsState
    CreationDateCondition:
      type: object
      properties:
        MaximumDaysSinceCreated:
          type: integer
          description: The maximum number of days that have elapsed since the image was created. For example, a value of 300 allows images that were created within the last 300 days.
    EnableAllowedImagesSettingsResult:
      type: object
      properties:
        AllowedImagesSettingsState:
          type: string
          enum:
          - enabled
          - audit-mode
          description: Returns enabled or audit-mode if the request succeeds; otherwise, it returns an error.
    DeprecationTimeCondition:
      type: object
      properties:
        MaximumDaysSinceDeprecated:
          type: integer
          description: The maximum number of days that have elapsed since the image was deprecated. When set to 0, no deprecated images are allowed.
    GetAllowedImagesSettingsResult:
      type: object
      properties:
        State:
          type: string
          description: 'The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services Region. Possible values: disabled: All AMIs are allowed. audit-mode: All AMIs are allowed, but the ImageAllowed field is set to true if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled. enabled: Only AMIs matching the image criteria are discoverable and available for use.'
        ImageCriteria:
          type: array
          items:
            $ref: '#/components/schemas/ImageCriterion'
          description: The list of criteria for images that are discoverable and usable in the account in the specified Amazon Web Services Region.
        ManagedBy:
          type: string
          enum:
          - account
          - declarative-policy
          description: 'The entity that manages the Allowed AMIs settings. Possible values include: account - The Allowed AMIs settings is managed by the account. declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can''t be modified by the account.'
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: ec2
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ec2/service/2016-11-15/ec2-2016-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)