openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeTrafficSources 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=DescribeTrafficSources' paths: /#Action=DescribeTrafficSources: 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: DescribeTrafficSources operationId: GET_DescribeTrafficSources description:Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTrafficSourcesResponse' examples: GET_DescribeTrafficSources200Example: summary: Default GET_DescribeTrafficSources 200 response x-microcks-default: true value: TrafficSources: example-string NextToken: example-string '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_DescribeTrafficSources480Example: summary: Default GET_DescribeTrafficSources 480 response x-microcks-default: true value: {} '481': description: InvalidNextToken content: text/xml: schema: $ref: '#/components/schemas/InvalidNextToken' examples: GET_DescribeTrafficSources481Example: summary: Default GET_DescribeTrafficSources 481 response x-microcks-default: true value: {} 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: TrafficSourceType in: query required: false description:The traffic source type that you want to describe.
The following lists the valid values:
elb if the traffic source is a Classic Load Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
vpc-lattice if the traffic source is VPC Lattice.
50.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficSources
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Traffic Sources
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeTrafficSources'
post:
x-aws-operation-name: DescribeTrafficSources
operationId: POST_DescribeTrafficSources
description: Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTrafficSourcesResponse' examples: POST_DescribeTrafficSources200Example: summary: Default POST_DescribeTrafficSources 200 response x-microcks-default: true value: TrafficSources: example-string NextToken: example-string '480': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: POST_DescribeTrafficSources480Example: summary: Default POST_DescribeTrafficSources 480 response x-microcks-default: true value: {} '481': description: InvalidNextToken content: text/xml: schema: $ref: '#/components/schemas/InvalidNextToken' examples: POST_DescribeTrafficSources481Example: summary: Default POST_DescribeTrafficSources 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeTrafficSourcesRequest' parameters: - name: MaxRecords in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeTrafficSources - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Traffic Sources x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=DescribeTrafficSources' components: schemas: XmlString: type: string x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' XmlStringMaxLen255: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' InvalidNextToken: {} TrafficSourceState: type: object properties: TrafficSource: allOf: - $ref: '#/components/schemas/XmlStringMaxLen511' - deprecated: true description: This is replaced byIdentifier.TrafficSource has been replaced by Identifier
State:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: Describes the current state of a traffic source.
The state values are as follows:
Adding - The Auto Scaling instances are being registered with the load balancer or target group.
Added - All Auto Scaling instances are registered with the load balancer or target group.
InService - For an Elastic Load Balancing load balancer or target group, at least one Auto Scaling instance passed an ELB health check. For VPC Lattice, at least one Auto Scaling instance passed an VPC_LATTICE health check.
Removing - The Auto Scaling instances are being deregistered from the load balancer or target group. If connection draining (deregistration delay) is enabled, Elastic Load Balancing or VPC Lattice waits for in-flight requests to complete before deregistering the instances.
Removed - All Auto Scaling instances are deregistered from the load balancer or target group.
Provides additional context for the value of Identifier.
The following lists the valid values:
elb if Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
description: Describes the state of a traffic source. XmlStringMaxLen511: type: string minLength: 1 maxLength: 511 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' DescribeTrafficSourcesRequest: type: object required: - AutoScalingGroupName title: DescribeTrafficSourcesRequest properties: AutoScalingGroupName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the Auto Scaling group. TrafficSourceType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description:The traffic source type that you want to describe.
The following lists the valid values:
elb if the traffic source is a Classic Load Balancer.
elbv2 if the traffic source is a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer.
vpc-lattice if the traffic source is VPC Lattice.
50.
MaxRecords:
type: integer
DescribeTrafficSourcesResponse:
type: object
example:
NextToken: ''
TrafficSources:
- Identifier: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-0e2f2665eEXAMPLE
State: InService
Type: vpc-lattice
properties:
TrafficSources:
allOf:
- $ref: '#/components/schemas/TrafficSourceStates'
- description: Information about the traffic sources.
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 NextToken value when requesting the next set of items. This value is null when there are no more items to return.
ResourceContentionFault: {}
TrafficSourceStates:
type: array
items:
$ref: '#/components/schemas/TrafficSourceState'
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
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