Amazon EC2 Ec2 Placement Group API

openapi: 3.2.0
info:
  title: Amazon Elastic Compute Cloud Placement Group 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: Placement Group
paths:
  /?Action=CreatePlacementGroup:
    post:
      operationId: CreatePlacementGroup
      summary: Create Placement Group
      description: Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. A precision-time placement group places instances on supported hardware with direct access to high-precision time sources in Amazon Web Services infrastructure. For more information, see Placement groups in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreatePlacementGroupResult'
              example: {}
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreatePlacementGroup
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/CreatePlacementGroupRequest'
            example:
              GroupName: my-cluster
              Strategy: cluster
      tags:
      - Placement Group
  /?Action=DeletePlacementGroup:
    post:
      operationId: DeletePlacementGroup
      summary: Delete Placement Group
      description: Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. You cannot delete a placement group that is a parent of a cluster placement group. Delete the cluster placement groups first. For more information, see Placement groups in the Amazon EC2 User Guide.
      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: DeletePlacementGroup
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DeletePlacementGroupRequest'
            example:
              GroupName: my-cluster
      tags:
      - Placement Group
  /?Action=DescribePlacementGroups:
    post:
      operationId: DescribePlacementGroups
      summary: Describe Placement Groups
      description: Describes the specified placement groups or all of your placement groups. To describe a specific placement group that is shared with your account, you must specify the ID of the placement group using the GroupId parameter. Specifying the name of a shared placement group using the GroupNames parameter will result in an error. For more information, see Placement groups in the Amazon EC2 User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribePlacementGroupsResult'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribePlacementGroups
                  Version:
                    type: string
                    const: '2016-11-15'
              - $ref: '#/components/schemas/DescribePlacementGroupsRequest'
      tags:
      - Placement Group
components:
  schemas:
    PlacementGroup:
      type: object
      properties:
        GroupName:
          type: string
          description: The name of the placement group.
        State:
          type: string
          enum:
          - pending
          - available
          - deleting
          - deleted
          description: The state of the placement group.
        Strategy:
          type: string
          enum:
          - cluster
          - spread
          - partition
          - precision-time
          description: The placement strategy.
        PartitionCount:
          type: integer
          description: The number of partitions. Valid only if strategy is set to partition.
        GroupId:
          type: string
          description: The ID of the placement group.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Any tags applied to the placement group.
        GroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the placement group.
        SpreadLevel:
          type: string
          enum:
          - host
          - rack
          description: The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
        LinkedGroupId:
          type: string
          description: Reserved for future use.
        Operator:
          $ref: '#/components/schemas/OperatorResponse'
        ParentGroupId:
          type: string
          description: The ID of the parent placement group.
    DescribePlacementGroupsRequest:
      type: object
      properties:
        GroupIds:
          type: array
          items:
            type: string
          description: The IDs of the placement groups.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        GroupNames:
          type: array
          items:
            type: string
          description: 'The names of the placement groups. Constraints: You can specify a name only if the placement group is owned by your account. If a placement group is shared with your account, specifying the name results in an error. You must use the GroupId parameter instead.'
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
          description: 'The filters. group-name - The name of the placement group. group-arn - The Amazon Resource Name (ARN) of the placement group. spread-level - The spread level for the placement group (host | rack). state - The state of the placement group (pending | available | deleting | deleted). strategy - The strategy of the placement group (cluster | spread | partition | precision-time). 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 va'
    OperatorRequest:
      type: object
      properties:
        Principal:
          type: string
          description: The service provider that manages the resource.
    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.'
    DescribePlacementGroupsResult:
      type: object
      properties:
        PlacementGroups:
          type: array
          items:
            $ref: '#/components/schemas/PlacementGroup'
          description: Information about the placement groups.
    DeletePlacementGroupRequest:
      type: object
      properties:
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        GroupName:
          type: string
          description: The name of the placement group.
      required:
      - GroupName
    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.
    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.
    OperatorResponse:
      type: object
      properties:
        Managed:
          type: boolean
          description: If true, the resource is managed by a service provider.
        Principal:
          type: string
          description: If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
        HiddenByDefault:
          type: boolean
          description: If true, the resource is hidden by default based on the managed resource visibility settings for the account.
    CreatePlacementGroupResult:
      type: object
      properties:
        PlacementGroup:
          $ref: '#/components/schemas/PlacementGroup'
    CreatePlacementGroupRequest:
      type: object
      properties:
        PartitionCount:
          type: integer
          description: The number of partitions. Valid only when Strategy is set to partition.
        TagSpecifications:
          type: array
          items:
            $ref: '#/components/schemas/TagSpecification'
          description: The tags to apply to the new placement group.
        SpreadLevel:
          type: string
          enum:
          - host
          - rack
          description: Determines how placement groups spread instances. Host – You can use host only with Outpost placement groups. Rack – No usage restrictions.
        LinkedGroupId:
          type: string
          description: Reserved for future use.
        Operator:
          $ref: '#/components/schemas/OperatorRequest'
        ParentGroupId:
          type: string
          description: The ID of a parent placement group. Valid only when Strategy is set to cluster.
        DryRun:
          type: boolean
          description: Checks whether you have the required permissions for the operation, 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.
        GroupName:
          type: string
          description: 'A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters'
        Strategy:
          type: string
          enum:
          - cluster
          - spread
          - partition
          - precision-time
          description: The placement strategy.
  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)