Amazon EC2 Ec2 Image Attribute API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Image Attribute 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: Image Attribute
paths:
  /?Action=DescribeImageAttribute:
    post:
      operationId: DescribeImageAttribute
      summary: Describe Image Attribute
      description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ImageAttribute'
              example:
                ImageId: ami-5731123e
                LaunchPermissions:
                - UserId: '123456789012'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeImageAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeImageAttributeRequest'
            example:
              Attribute: launchPermission
              ImageId: ami-5731123e
      tags:
      - Image Attribute
  /?Action=ModifyImageAttribute:
    post:
      operationId: ModifyImageAttribute
      summary: Modify Image Attribute
      description: 'Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. To specify the attribute, you can use the Attribute parameter, or one of the following parameters: Description, ImdsSupport, or LaunchPermission. Images with an Amazon Web Services Marketplace product code cannot be made public. To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
              example: {}
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ModifyImageAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ModifyImageAttributeRequest'
            example:
              ImageId: ami-5731123e
              LaunchPermission:
                Add:
                - UserId: '123456789012'
      tags:
      - Image Attribute
  /?Action=ResetImageAttribute:
    post:
      operationId: ResetImageAttribute
      summary: Reset Image Attribute
      description: Resets an attribute of an AMI to its default value.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
              example: {}
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: ResetImageAttribute
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/ResetImageAttributeRequest'
            example:
              Attribute: launchPermission
              ImageId: ami-5731123e
      tags:
      - Image Attribute
components:
  schemas:
    ImageAttribute:
      type: object
      properties:
        Description:
          $ref: '#/components/schemas/AttributeValue'
        KernelId:
          $ref: '#/components/schemas/AttributeValue'
        RamdiskId:
          $ref: '#/components/schemas/AttributeValue'
        SriovNetSupport:
          $ref: '#/components/schemas/AttributeValue'
        BootMode:
          $ref: '#/components/schemas/AttributeValue'
        TpmSupport:
          $ref: '#/components/schemas/AttributeValue'
        UefiData:
          $ref: '#/components/schemas/AttributeValue'
        LastLaunchedTime:
          $ref: '#/components/schemas/AttributeValue'
        ImdsSupport:
          $ref: '#/components/schemas/AttributeValue'
        DeregistrationProtection:
          $ref: '#/components/schemas/AttributeValue'
        ImageId:
          type: string
          description: The ID of the AMI.
        LaunchPermissions:
          type: array
          items:
            $ref: '#/components/schemas/LaunchPermission'
          description: The launch permissions.
        ProductCodes:
          type: array
          items:
            $ref: '#/components/schemas/ProductCode'
          description: The product codes.
        BlockDeviceMappings:
          type: array
          items:
            $ref: '#/components/schemas/BlockDeviceMapping'
          description: The block device mapping entries.
    AttributeValue:
      type: object
      properties:
        Value:
          type: string
          description: The attribute value. The value is case-sensitive.
    ResetImageAttributeRequest:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - launchPermission
          description: The attribute to reset (currently you can only reset the launch permission attribute).
        ImageId:
          type: string
          description: The ID of the AMI.
        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:
      - Attribute
      - ImageId
    ModifyImageAttributeRequest:
      type: object
      properties:
        Attribute:
          type: string
          description: 'The name of the attribute to modify. Valid values: description | imdsSupport | launchPermission'
        Description:
          $ref: '#/components/schemas/AttributeValue'
        ImageId:
          type: string
          description: The ID of the AMI.
        LaunchPermission:
          $ref: '#/components/schemas/LaunchPermissionModifications'
        OperationType:
          type: string
          enum:
          - add
          - remove
          description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
        ProductCodes:
          type: array
          items:
            type: string
          description: Not supported.
        UserGroups:
          type: array
          items:
            type: string
          description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
        UserIds:
          type: array
          items:
            type: string
          description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
        Value:
          type: string
          description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
        OrganizationArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
        OrganizationalUnitArns:
          type: array
          items:
            type: string
          description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
        ImdsSupport:
          $ref: '#/components/schemas/AttributeValue'
        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:
      - ImageId
    BlockDeviceMapping:
      type: object
      properties:
        Ebs:
          $ref: '#/components/schemas/EbsBlockDevice'
        NoDevice:
          type: string
          description: To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.
        DeviceName:
          type: string
          description: The device name. For available device names, see Device names for volumes.
        VirtualName:
          type: string
          description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume. NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect. Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. '
    LaunchPermission:
      type: object
      properties:
        OrganizationArn:
          type: string
          description: The Amazon Resource Name (ARN) of an organization.
        OrganizationalUnitArn:
          type: string
          description: The Amazon Resource Name (ARN) of an organizational unit (OU).
        UserId:
          type: string
          description: 'The Amazon Web Services account ID. Constraints: Up to 10 000 account IDs can be specified in a single request.'
        Group:
          type: string
          enum:
          - all
          description: The name of the group.
    DescribeImageAttributeRequest:
      type: object
      properties:
        Attribute:
          type: string
          enum:
          - description
          - kernel
          - ramdisk
          - launchPermission
          - productCodes
          - blockDeviceMapping
          - sriovNetSupport
          - bootMode
          - tpmSupport
          - uefiData
          - lastLaunchedTime
          - imdsSupport
          - deregistrationProtection
          description: 'The AMI attribute. Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, describe the image instead.'
        ImageId:
          type: string
          description: The ID of the AMI.
        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:
      - Attribute
      - ImageId
    ProductCode:
      type: object
      properties:
        ProductCodeId:
          type: string
          description: The product code.
        ProductCodeType:
          type: string
          enum:
          - devpay
          - marketplace
          description: The type of product code.
    EbsBlockDevice:
      type: object
      properties:
        DeleteOnTermination:
          type: boolean
          description: Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
        Iops:
          type: integer
          description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: gp3: 3,000 - 80,000 IOPS io1: 100 - 64,000 IOPS io2: 100 - 256,000 IOPS For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS. This parameter'
        SnapshotId:
          type: string
          description: The ID of the snapshot.
        VolumeSize:
          type: integer
          description: 'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported sizes for each volume type: gp2: 1 - 16,384 GiB gp3: 1 - 65,536 GiB io1: 4 - 16,384 GiB io2: 4 - 65,536 GiB st1 and sc1: 125 - 16,384 GiB standard: 1 - 1024 GiB'
        VolumeType:
          type: string
          enum:
          - standard
          - io1
          - io2
          - gp2
          - sc1
          - st1
          - gp3
          description: The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
        KmsKeyId:
          type: string
          description: Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption. This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        Throughput:
          type: integer
          description: 'The throughput that the volume supports, in MiB/s. This parameter is valid only for gp3 volumes. Valid Range: Minimum value of 125. Maximum value of 2,000.'
        OutpostArn:
          type: string
          description: The ARN of the Outpost on which the snapshot is stored. This parameter is not supported when using CreateImage.
        AvailabilityZone:
          type: string
          description: The Availability Zone where the EBS volume will be created (for example, us-east-1a). Either AvailabilityZone or AvailabilityZoneId can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances.
        Encrypted:
          type: boolean
          description: Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide. In no case can you remove encryption from an encrypted volume. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. This parameter i
        VolumeInitializationRate:
          type: integer
          description: 'Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide. This parameter is supported only for volumes created from snapshots. Omit this parameter if: You want to create the volume using fast snapshot restore. You mu'
        AvailabilityZoneId:
          type: string
          description: The ID of the Availability Zone where the EBS volume will be created (for example, use1-az1). Either AvailabilityZone or AvailabilityZoneId can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region. This parameter is not supported when using CreateFleet, CreateImage, DescribeImages, RequestSpotFleet, RequestSpotInstances, and RunInstances.
        EbsCardIndex:
          type: integer
          description: The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.
    LaunchPermissionModifications:
      type: object
      properties:
        Add:
          type: array
          items:
            $ref: '#/components/schemas/LaunchPermission'
          description: The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
        Remove:
          type: array
          items:
            $ref: '#/components/schemas/LaunchPermission'
          description: The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
  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)