openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=ExitStandby API'
description:
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
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=ExitStandby' paths: /#Action=ExitStandby: 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: ExitStandby operationId: GET_ExitStandby description:Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ExitStandbyAnswer' examples: GET_ExitStandby200Example: summary: Default GET_ExitStandby 200 response x-microcks-default: true value: Activities: example-string '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_ExitStandby480Example: summary: Default GET_ExitStandby 480 response x-microcks-default: true value: {} parameters: - name: InstanceIds in: query required: false description: The IDs of the instances. You can specify up to 20 instances. schema: type: array items: $ref: '#/components/schemas/XmlStringMaxLen19' - 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: Action in: query required: true schema: type: string enum: - ExitStandby - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling GET_ Exit Standby x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=ExitStandby' post: x-aws-operation-name: ExitStandby operationId: POST_ExitStandby description:Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ExitStandbyAnswer' examples: POST_ExitStandby200Example: summary: Default POST_ExitStandby 200 response x-microcks-default: true value: Activities: example-string '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: POST_ExitStandby480Example: summary: Default POST_ExitStandby 480 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: '#/components/schemas/ExitStandbyQuery' parameters: - name: Action in: query required: true schema: type: string enum: - ExitStandby - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Exit Standby x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=ExitStandby' components: schemas: XmlString: type: string x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' Progress: type: integer Activities: type: array items: $ref: '#/components/schemas/Activity' ResourceContentionFault: {} XmlStringMaxLen1023: type: string minLength: 1 maxLength: 1023 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' ScalingActivityStatusCode: type: string enum: - PendingSpotBidPlacement - WaitingForSpotInstanceRequestId - WaitingForSpotInstanceId - WaitingForInstanceId - PreInService - InProgress - WaitingForELBConnectionDraining - MidLifecycleAction - WaitingForInstanceWarmup - Successful - Failed - Cancelled - WaitingForConnectionDraining TimestampType: type: string format: date-time ExitStandbyAnswer: type: object example: Activities: - ActivityId: 142928e1-a2dc-453a-9b24-b85ad6735928 AutoScalingGroupName: my-auto-scaling-group Cause: At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2. Description: 'Moving EC2 instance out of Standby: i-93633f9b' Details: details Progress: 30 StartTime: 2015-04-12 15:14:29.886000+00:00 StatusCode: PreInService properties: Activities: allOf: - $ref: '#/components/schemas/Activities' - description: The activities related to moving instances out ofStandby mode.
XmlStringMaxLen19:
type: string
minLength: 1
maxLength: 19
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
AutoScalingGroupState:
type: string
minLength: 1
maxLength: 32
XmlStringMaxLen255:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
InstanceIds:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen19'
ExitStandbyQuery:
type: object
required:
- AutoScalingGroupName
title: ExitStandbyQuery
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIds'
- description: The IDs of the instances. You can specify up to 20 instances.
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
Activity:
type: object
required:
- ActivityId
- AutoScalingGroupName
- Cause
- StartTime
- StatusCode
properties:
ActivityId:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The ID of the activity.
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
Description:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: A friendly, more verbose description of the activity.
Cause:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1023'
- description: The reason the activity began.
StartTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The start time of the activity.
EndTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The end time of the activity.
StatusCode:
allOf:
- $ref: '#/components/schemas/ScalingActivityStatusCode'
- description: The current status of the activity.
StatusMessage:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: A friendly, more verbose description of the activity status.
Progress:
allOf:
- $ref: '#/components/schemas/Progress'
- description: A value between 0 and 100 that indicates the progress of the activity.
Details:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The details about the activity.
AutoScalingGroupState:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupState'
- description: The state of the Auto Scaling group, which is either InService or Deleted.
AutoScalingGroupARN:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The Amazon Resource Name (ARN) of the Auto Scaling group.
description: Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
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