Amazon EC2 Ec2 Image Usage Report API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Image Usage Report 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 Usage Report
paths:
  /?Action=CreateImageUsageReport:
    post:
      operationId: CreateImageUsageReport
      summary: Create Image Usage Report
      description: Creates a report that shows how your image is used across other Amazon Web Services accounts. The report provides visibility into which accounts are using the specified image, and how many resources (EC2 instances or launch templates) are referencing it. For more information, see View your AMI usage in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateImageUsageReportResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateImageUsageReport
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateImageUsageReportRequest'
      tags:
      - Image Usage Report
  /?Action=DeleteImageUsageReport:
    post:
      operationId: DeleteImageUsageReport
      summary: Delete Image Usage Report
      description: Deletes the specified image usage report. For more information, see View your AMI usage in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteImageUsageReportResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteImageUsageReport
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteImageUsageReportRequest'
      tags:
      - Image Usage Report
  /?Action=DescribeImageUsageReports:
    post:
      operationId: DescribeImageUsageReports
      summary: Describe Image Usage Reports
      description: Describes the configuration and status of image usage reports, filtered by report IDs or image IDs. For more information, see View your AMI usage in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeImageUsageReportsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeImageUsageReports
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeImageUsageReportsRequest'
      tags:
      - Image Usage Report
components:
  schemas:
    ImageUsageResourceTypeRequest:
      type: object
      properties:
        ResourceType:
          type: string
          description: 'The resource type. Valid values: ec2:Instance | ec2:LaunchTemplate'
        ResourceTypeOptions:
          type: array
          items:
            $ref: '#/components/schemas/ImageUsageResourceTypeOptionRequest'
          description: The options that affect the scope of the report. Valid only when ResourceType is ec2:LaunchTemplate.
    CreateImageUsageReportResult:
      type: object
      properties:
        ReportId:
          type: string
          description: The ID of the report.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.'
        Value:
          type: string
          description: 'The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.'
    TagSpecification:
      type: object
      properties:
        ResourceType:
          type: string
          enum:
          - capacity-reservation
          - client-vpn-endpoint
          - customer-gateway
          - carrier-gateway
          - coip-pool
          - declarative-policies-report
          - dedicated-host
          - dhcp-options
          - egress-only-internet-gateway
          - elastic-ip
          - elastic-gpu
          - export-image-task
          - export-instance-task
          - fleet
          - fpga-image
          - host-reservation
          - image
          - image-usage-report
          - import-image-task
          - import-snapshot-task
          - instance
          - instance-event-window
          - internet-gateway
          - ipam
          - ipam-pool
          - ipam-scope
          - ipv4pool-ec2
          - ipv6pool-ec2
          - key-pair
          - launch-template
          - local-gateway
          - local-gateway-route-table
          - local-gateway-virtual-interface
          - local-gateway-virtual-interface-group
          - local-gateway-route-table-vpc-association
          - local-gateway-route-table-virtual-interface-group-association
          - natgateway
          - network-acl
          - network-interface
          - network-insights-analysis
          - network-insights-path
          - network-insights-access-scope
          - network-insights-access-scope-analysis
          - outpost-lag
          - placement-group
          - prefix-list
          - replace-root-volume-task
          - reserved-instances
          - route-table
          - security-group
          - security-group-rule
          - service-link-virtual-interface
          - snapshot
          - spot-fleet-request
          - spot-instances-request
          - subnet
          - subnet-cidr-reservation
          - traffic-mirror-filter
          - traffic-mirror-session
          - traffic-mirror-target
          - transit-gateway
          - transit-gateway-attachment
          - transit-gateway-connect-peer
          - transit-gateway-multicast-domain
          - transit-gateway-policy-table
          - transit-gateway-metering-policy
          - transit-gateway-route-table
          - transit-gateway-route-table-announcement
          - volume
          - vpc
          - vpc-endpoint
          - vpc-endpoint-connection
          - vpc-endpoint-service
          - vpc-endpoint-service-permission
          - vpc-peering-connection
          - vpn-connection
          - vpn-gateway
          - vpc-flow-log
          - capacity-reservation-fleet
          - traffic-mirror-filter-rule
          - vpc-endpoint-connection-device-type
          - verified-access-instance
          - verified-access-group
          - verified-access-endpoint
          - verified-access-policy
          - verified-access-trust-provider
          - vpn-connection-device-type
          - vpc-block-public-access-exclusion
          - vpc-encryption-control
          - route-server
          - route-server-endpoint
          - route-server-peer
          - ipam-resource-discovery
          - ipam-resource-discovery-association
          - instance-connect-endpoint
          - verified-access-endpoint-target
          - ipam-external-resource-verification-token
          - capacity-block
          - mac-modification-task
          - ipam-prefix-list-resolver
          - ipam-policy
          - ipam-prefix-list-resolver-target
          - ipam-internet-registry-association
          - secondary-interface
          - secondary-network
          - secondary-subnet
          - capacity-manager-data-export
          - vpn-concentrator
          - ipam-pool-allocation
          - capacity-reservation-cancellation-quote
          - application-status-check
          - capacity-reservation-modification-quote
          description: The type of resource to tag on creation.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to apply to the resource.
    ImageUsageResourceTypeOptionRequest:
      type: object
      properties:
        OptionName:
          type: string
          description: 'The name of the option. Valid value: version-depth - The number of launch template versions to check.'
        OptionValues:
          type: array
          items:
            type: string
          description: 'A value for the specified option. Valid values: Integers between 1 and 10000 Default: 20'
    DescribeImageUsageReportsRequest:
      type: object
      properties:
        ImageIds:
          type: array
          items:
            type: string
          description: The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.
        ReportIds:
          type: array
          items:
            type: string
          description: The IDs of the image usage reports.
        NextToken:
          type: string
          description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. creation-time - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2025-11-29T11:04:43.305Z. You can use a wildcard (*), for example, 2025-11-29T*, which matches an entire day. state - The state of the report (available | pending | error). tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and '
        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.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
    ImageUsageResourceTypeOption:
      type: object
      properties:
        OptionName:
          type: string
          description: The name of the option.
        OptionValues:
          type: array
          items:
            type: string
          description: The number of launch template versions to check.
    CreateImageUsageReportRequest:
      type: object
      properties:
        ImageId:
          type: string
          description: The ID of the image to report on.
        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.
        ResourceTypes:
          type: array
          items:
            $ref: '#/components/schemas/ImageUsageResourceTypeRequest'
          description: The resource types to include in the report.
        AccountIds:
          type: array
          items:
            type: string
          description: The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure idempotency of the request.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the report on creation. The ResourceType must be set to image-usage-report; any other value will cause the report creation to fail. To tag a report after it has been created, see CreateTags.
      required:
      - ImageId
      - ResourceTypes
    DescribeImageUsageReportsResult:
      type: object
      properties:
        NextToken:
          type: string
          description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
        ImageUsageReports:
          type: array
          items:
            $ref: '#/components/schemas/ImageUsageReport'
          description: The image usage reports.
    Filter:
      type: object
      properties:
        Name:
          type: string
          description: The name of the filter. Filter names are case-sensitive.
        Values:
          type: array
          items:
            type: string
          description: The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    DeleteImageUsageReportResult:
      type: object
      properties:
        Return:
          type: boolean
          description: Returns true if the request succeeds; otherwise, it returns an error.
    DeleteImageUsageReportRequest:
      type: object
      properties:
        ReportId:
          type: string
          description: The ID of the report to delete.
        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:
      - ReportId
    ImageUsageReport:
      type: object
      properties:
        ImageId:
          type: string
          description: The ID of the image that was specified when the report was created.
        ReportId:
          type: string
          description: The ID of the report.
        ResourceTypes:
          type: array
          items:
            $ref: '#/components/schemas/ImageUsageResourceType'
          description: The resource types that were specified when the report was created.
        AccountIds:
          type: array
          items:
            type: string
          description: The IDs of the Amazon Web Services accounts that were specified when the report was created.
        State:
          type: string
          description: 'The current state of the report. Possible values: available - The report is available to view. pending - The report is being created and not available to view. error - The report could not be created.'
        StateReason:
          type: string
          description: Provides additional details when the report is in an error state.
        CreationTime:
          type: string
          format: date-time
          description: The date and time when the report was created.
        ExpirationTime:
          type: string
          format: date-time
          description: The date and time when Amazon EC2 will delete the report (30 days after the report was created).
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags assigned to the report.
    ImageUsageResourceType:
      type: object
      properties:
        ResourceType:
          type: string
          description: 'The resource type. Valid values: ec2:Instance | ec2:LaunchTemplate'
        ResourceTypeOptions:
          type: array
          items:
            $ref: '#/components/schemas/ImageUsageResourceTypeOption'
          description: The options that affect the scope of the report. Valid only when ResourceType is ec2:LaunchTemplate.
  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)