Amazon EC2 Auto Scaling #Action=DescribeWarmPool API

openapi: 3.0.0
info:
  version: 2011-01-01
  x-release: v4
  title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeWarmPool API'
  description: <fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: autoscaling
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://autoscaling.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Auto Scaling multi-region endpoint
- url: https://autoscaling.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Auto Scaling multi-region endpoint
- url: http://autoscaling.amazonaws.com
  variables: {}
  description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: https://autoscaling.amazonaws.com
  variables: {}
  description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: http://autoscaling.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
- url: https://autoscaling.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=DescribeWarmPool'
paths:
  /#Action=DescribeWarmPool:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    get:
      x-aws-operation-name: DescribeWarmPool
      operationId: GET_DescribeWarmPool
      description: <p>Gets information about a warm pool and its instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeWarmPoolAnswer'
              examples:
                GET_DescribeWarmPool200Example:
                  summary: Default GET_DescribeWarmPool 200 response
                  x-microcks-default: true
                  value:
                    WarmPoolConfiguration: example-string
                    Instances: example-string
                    NextToken: example-string
        '480':
          description: InvalidNextToken
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidNextToken'
              examples:
                GET_DescribeWarmPool480Example:
                  summary: Default GET_DescribeWarmPool 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: LimitExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededFault'
              examples:
                GET_DescribeWarmPool481Example:
                  summary: Default GET_DescribeWarmPool 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ResourceContentionFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceContentionFault'
      parameters:
      - name: AutoScalingGroupName
        in: query
        required: true
        description: The name of the Auto Scaling group.
        schema:
          type: string
          minLength: 1
          maxLength: 255
          x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
      - name: MaxRecords
        in: query
        required: false
        description: The maximum number of instances to return with this call. The maximum value is <code>50</code>.
        schema:
          type: integer
      - name: NextToken
        in: query
        required: false
        description: The token for the next set of instances to return. (You received this token from a previous call.)
        schema:
          type: string
          x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeWarmPool
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - 2011-01-01
      summary: Amazon EC2 Auto Scaling GET_ Describe Warm Pool
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeWarmPool'
    post:
      x-aws-operation-name: DescribeWarmPool
      operationId: POST_DescribeWarmPool
      description: <p>Gets information about a warm pool and its instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeWarmPoolAnswer'
              examples:
                POST_DescribeWarmPool200Example:
                  summary: Default POST_DescribeWarmPool 200 response
                  x-microcks-default: true
                  value:
                    WarmPoolConfiguration: example-string
                    Instances: example-string
                    NextToken: example-string
        '480':
          description: InvalidNextToken
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidNextToken'
              examples:
                POST_DescribeWarmPool480Example:
                  summary: Default POST_DescribeWarmPool 480 response
                  x-microcks-default: true
                  value: {}
        '481':
          description: LimitExceededFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededFault'
              examples:
                POST_DescribeWarmPool481Example:
                  summary: Default POST_DescribeWarmPool 481 response
                  x-microcks-default: true
                  value: {}
        '482':
          description: ResourceContentionFault
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceContentionFault'
      requestBody:
        content:
          text/xml:
            schema:
              $ref: '#/components/schemas/DescribeWarmPoolType'
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - DescribeWarmPool
      - name: Version
        in: query
        required: true
        schema:
          type: string
          enum:
          - 2011-01-01
      summary: Amazon EC2 Auto Scaling POST_ Describe Warm Pool
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#Action=DescribeWarmPool'
components:
  schemas:
    XmlString:
      type: string
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    WarmPoolStatus:
      type: string
      enum:
      - PendingDelete
    WarmPoolState:
      type: string
      enum:
      - Stopped
      - Running
      - Hibernated
    WarmPoolMinSize:
      type: integer
      minimum: 0
    ResourceContentionFault: {}
    Instances:
      type: array
      items:
        $ref: '#/components/schemas/Instance'
    XmlStringMaxLen32:
      type: string
      minLength: 1
      maxLength: 32
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    LaunchTemplateName:
      type: string
      pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
      minLength: 3
      maxLength: 128
    XmlStringMaxLen19:
      type: string
      minLength: 1
      maxLength: 19
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    MaxRecords:
      type: integer
    InstanceReusePolicy:
      type: object
      properties:
        ReuseOnScaleIn:
          allOf:
          - $ref: '#/components/schemas/ReuseOnScaleIn'
          - description: 'Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in. '
      description: <p>Describes an instance reuse policy for a warm pool. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html">Warm pools for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
    Instance:
      type: object
      required:
      - InstanceId
      - AvailabilityZone
      - LifecycleState
      - HealthStatus
      - ProtectedFromScaleIn
      properties:
        InstanceId:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen19'
          - description: The ID of the instance.
        InstanceType:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: The instance type of the EC2 instance.
        AvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: The Availability Zone in which the instance is running.
        LifecycleState:
          allOf:
          - $ref: '#/components/schemas/LifecycleState'
          - description: 'A description of the current lifecycle state. The <code>Quarantined</code> state is not used. For information about lifecycle states, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroupLifecycle.html">Instance lifecycle</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. '
        HealthStatus:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen32'
          - description: The last reported health status of the instance. <code>Healthy</code> means that the instance is healthy and should remain in service. <code>Unhealthy</code> means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
        LaunchConfigurationName:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: The launch configuration associated with the instance.
        LaunchTemplate:
          allOf:
          - $ref: '#/components/schemas/LaunchTemplateSpecification'
          - description: The launch template for the instance.
        ProtectedFromScaleIn:
          allOf:
          - $ref: '#/components/schemas/InstanceProtected'
          - description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
        WeightedCapacity:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen32'
          - description: '<p>The number of capacity units contributed by the instance based on its instance type.</p> <p>Valid Range: Minimum value of 1. Maximum value of 999.</p>'
      description: Describes an EC2 instance.
    LaunchTemplateSpecification:
      type: object
      properties:
        LaunchTemplateId:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: '<p>The ID of the launch template. To get the template ID, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p> <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a <code>LaunchTemplateName</code>.</p>'
        LaunchTemplateName:
          allOf:
          - $ref: '#/components/schemas/LaunchTemplateName'
          - description: '<p>The name of the launch template. To get the template name, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplates.html">DescribeLaunchTemplates</a> API operation. New launch templates can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplate.html">CreateLaunchTemplate</a> API. </p> <p>Conditional: You must specify either a <code>LaunchTemplateId</code> or a <code>LaunchTemplateName</code>.</p>'
        Version:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: The version number, <code>$Latest</code>, or <code>$Default</code>. To get the version number, use the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLaunchTemplateVersions.html">DescribeLaunchTemplateVersions</a> API operation. New launch template versions can be created using the Amazon EC2 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateLaunchTemplateVersion.html">CreateLaunchTemplateVersion</a> API. If the value is <code>$Latest</code>, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.
      description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
    XmlStringMaxLen255:
      type: string
      minLength: 1
      maxLength: 255
      x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
    InstanceProtected:
      type: boolean
    WarmPoolConfiguration:
      type: object
      properties:
        MaxGroupPreparedCapacity:
          allOf:
          - $ref: '#/components/schemas/MaxGroupPreparedCapacity'
          - description: The maximum number of instances that are allowed to be in the warm pool or in any state except <code>Terminated</code> for the Auto Scaling group.
        MinSize:
          allOf:
          - $ref: '#/components/schemas/WarmPoolMinSize'
          - description: The minimum number of instances to maintain in the warm pool.
        PoolState:
          allOf:
          - $ref: '#/components/schemas/WarmPoolState'
          - description: The instance state to transition to after the lifecycle actions are complete.
        Status:
          allOf:
          - $ref: '#/components/schemas/WarmPoolStatus'
          - description: The status of a warm pool that is marked for deletion.
        InstanceReusePolicy:
          allOf:
          - $ref: '#/components/schemas/InstanceReusePolicy'
          - description: The instance reuse policy.
      description: 'Describes a warm pool configuration. '
    LifecycleState:
      type: string
      enum:
      - Pending
      - Pending:Wait
      - Pending:Proceed
      - Quarantined
      - InService
      - Terminating
      - Terminating:Wait
      - Terminating:Proceed
      - Terminated
      - Detaching
      - Detached
      - EnteringStandby
      - Standby
      - Warmed:Pending
      - Warmed:Pending:Wait
      - Warmed:Pending:Proceed
      - Warmed:Terminating
      - Warmed:Terminating:Wait
      - Warmed:Terminating:Proceed
      - Warmed:Terminated
      - Warmed:Stopped
      - Warmed:Running
      - Warmed:Hibernated
    MaxGroupPreparedCapacity:
      type: integer
      minimum: -1
    InvalidNextToken: {}
    DescribeWarmPoolAnswer:
      type: object
      properties:
        WarmPoolConfiguration:
          allOf:
          - $ref: '#/components/schemas/WarmPoolConfiguration'
          - description: 'The warm pool configuration details. '
        Instances:
          allOf:
          - $ref: '#/components/schemas/Instances'
          - description: The instances that are currently in the warm pool.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/XmlString'
          - description: This string indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the <code>NextToken</code> value when requesting the next set of items. This value is null when there are no more items to return.
    DescribeWarmPoolType:
      type: object
      required:
      - AutoScalingGroupName
      title: DescribeWarmPoolType
      properties:
        AutoScalingGroupName:
          allOf:
          - $ref: '#/components/schemas/XmlStringMaxLen255'
          - description: The name of the Auto Scaling group.
        MaxRecords:
          allOf:
          - $ref: '#/components/schemas/MaxRecords'
          - description: The maximum number of instances to return with this call. The maximum value is <code>50</code>.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/XmlString'
          - description: The token for the next set of instances to return. (You received this token from a previous call.)
    ReuseOnScaleIn:
      type: boolean
    LimitExceededFault: {}
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/autoscaling/
x-hasEquivalentPaths: true