Amazon EC2 Ec2 Capacity Manager Data Export API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Capacity Manager Data Export…
  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: Capacity Manager Data Export
paths:
  /?Action=CreateCapacityManagerDataExport:
    post:
      operationId: CreateCapacityManagerDataExport
      summary: Create Capacity Manager Data Export
      description: Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateCapacityManagerDataExportResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateCapacityManagerDataExport
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreateCapacityManagerDataExportRequest'
      tags:
      - Capacity Manager Data Export
  /?Action=DeleteCapacityManagerDataExport:
    post:
      operationId: DeleteCapacityManagerDataExport
      summary: Delete Capacity Manager Data Export
      description: Deletes an existing Capacity Manager data export configuration. This stops future scheduled exports but does not delete previously exported files from S3.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteCapacityManagerDataExportResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteCapacityManagerDataExport
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeleteCapacityManagerDataExportRequest'
      tags:
      - Capacity Manager Data Export
  /?Action=DescribeCapacityManagerDataExports:
    post:
      operationId: DescribeCapacityManagerDataExports
      summary: Describe Capacity Manager Data Exports
      description: Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeCapacityManagerDataExportsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeCapacityManagerDataExports
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribeCapacityManagerDataExportsRequest'
      tags:
      - Capacity Manager Data Export
components:
  schemas:
    CreateCapacityManagerDataExportResult:
      type: object
      properties:
        CapacityManagerDataExportId:
          type: string
          description: The unique identifier for the created data export configuration. Use this ID to reference the export in other API calls.
    DescribeCapacityManagerDataExportsResult:
      type: object
      properties:
        CapacityManagerDataExports:
          type: array
          items:
            $ref: '#/components/schemas/CapacityManagerDataExportResponse'
          description: Information about the data export configurations, including export settings, delivery status, and recent activity.
        NextToken:
          type: string
          description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
    CreateCapacityManagerDataExportRequest:
      type: object
      properties:
        S3BucketName:
          type: string
          description: The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it.
        S3BucketPrefix:
          type: string
          description: The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root.
        Schedule:
          type: string
          enum:
          - hourly
          description: The frequency at which data exports are generated.
        OutputFormat:
          type: string
          enum:
          - csv
          - parquet
          description: The file format for the exported data. Parquet format is recommended for large datasets and better compression.
        ClientToken:
          type: string
          description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
        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.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes.
      required:
      - S3BucketName
      - Schedule
      - OutputFormat
    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.'
    DescribeCapacityManagerDataExportsRequest:
      type: object
      properties:
        CapacityManagerDataExportIds:
          type: array
          items:
            type: string
          description: The IDs of the data export configurations to describe. If not specified, all export configurations are returned.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call. If not specified, up to 1000 results are returned.
        NextToken:
          type: string
          description: The token for the next page of results. Use this value in a subsequent call to retrieve additional results.
        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.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.
    DeleteCapacityManagerDataExportRequest:
      type: object
      properties:
        CapacityManagerDataExportId:
          type: string
          description: The unique identifier of the data export configuration 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:
      - CapacityManagerDataExportId
    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.
    CapacityManagerDataExportResponse:
      type: object
      properties:
        CapacityManagerDataExportId:
          type: string
          description: The unique identifier for the data export configuration.
        S3BucketName:
          type: string
          description: The name of the S3 bucket where export files are delivered.
        S3BucketPrefix:
          type: string
          description: The S3 key prefix used for organizing export files within the bucket.
        Schedule:
          type: string
          enum:
          - hourly
          description: The frequency at which data exports are generated.
        OutputFormat:
          type: string
          enum:
          - csv
          - parquet
          description: The file format of the exported data.
        CreateTime:
          type: string
          format: date-time
          description: The timestamp when the data export configuration was created.
        LatestDeliveryStatus:
          type: string
          enum:
          - pending
          - in-progress
          - delivered
          - failed
          description: The status of the most recent export delivery.
        LatestDeliveryStatusMessage:
          type: string
          description: A message describing the status of the most recent export delivery, including any error details if the delivery failed.
        LatestDeliveryS3LocationUri:
          type: string
          description: The S3 URI of the most recently delivered export file.
        LatestDeliveryTime:
          type: string
          format: date-time
          description: The timestamp when the most recent export was delivered to S3.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags associated with the data export configuration.
    DeleteCapacityManagerDataExportResult:
      type: object
      properties:
        CapacityManagerDataExportId:
          type: string
          description: The unique identifier of the deleted data export configuration.
    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.
  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)