Amazon Elastic Load Balancing Targets API

openapi: 3.2.0
info:
  title: Amazon Elastic Load Balancing Targets API
  version: '2015-12-01'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  description: 'Operations tagged Targets across 2 of this provider''s published API definitions: amazon-elastic-load-balancing-openapi.yml, amazon-elastic-load-balancing-targets-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://elasticloadbalancing.{region}.amazonaws.com
  description: Amazon Elastic Load Balancing Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
tags:
- name: Targets
  description: Operations for registering and deregistering targets
paths:
  /?Action=RegisterTargets:
    get:
      operationId: registerTargets
      summary: Amazon Elastic Load Balancing Register Targets with a Target Group
      description: Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it.
      tags:
      - Targets
      parameters:
      - name: TargetGroupArn
        in: query
        required: true
        description: The ARN of the target group
        schema:
          type: string
      - name: Targets.member.1.Id
        in: query
        required: true
        description: The ID of the target (instance ID, IP address, or Lambda ARN)
        schema:
          type: string
      - name: Targets.member.1.Port
        in: query
        description: The port on which the target is listening
        schema:
          type: integer
          minimum: 1
          maximum: 65535
      - name: Targets.member.1.AvailabilityZone
        in: query
        description: The Availability Zone where the target is located
        schema:
          type: string
      responses:
        '200':
          description: Successfully registered targets
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication failure
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - sigv4Auth: []
    post:
      operationId: RegisterTargets
      summary: Register Targets
      description: 'Registers the specified targets with the specified target group. If the target is an EC2 instance, it must be in the running state when you register it. By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports. For more information, see the following: Register targets for your Application Load Balancer Register targets for your Network Load Balancer Register targets for your Gateway Load Balancer'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RegisterTargetsOutput'
        '400':
          description: InvalidTargetException; TargetGroupNotFoundException; TooManyRegistrationsForTargetIdException; TooManyTargetsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTargetException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: RegisterTargets
                  Version:
                    type: string
                    const: '2015-12-01'
              - $ref: '#/components/schemas/RegisterTargetsInput'
            example:
              TargetGroupArn: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
              Targets:
              - Id: i-80c8dd94
              - Id: i-ceddcd4d
      tags:
      - Targets
      security:
      - sigv4Auth: []
    servers:
    - url: https://elasticloadbalancing.{region}.amazonaws.com
      description: Amazon Elastic Load Balancing Regional Endpoint
      variables:
        region:
          default: us-east-1
          description: AWS Region
  /?Action=DeregisterTargets:
    get:
      operationId: deregisterTargets
      summary: Amazon Elastic Load Balancing Deregister Targets from a Target Group
      description: Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.
      tags:
      - Targets
      parameters:
      - name: TargetGroupArn
        in: query
        required: true
        description: The ARN of the target group
        schema:
          type: string
      - name: Targets.member.1.Id
        in: query
        required: true
        description: The ID of the target
        schema:
          type: string
      - name: Targets.member.1.Port
        in: query
        description: The port on which the target is listening
        schema:
          type: integer
      responses:
        '200':
          description: Successfully deregistered targets
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication failure
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - sigv4Auth: []
    post:
      operationId: DeregisterTargets
      summary: Deregister Targets
      description: 'Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer. The load balancer stops sending requests to targets that are deregistering, but uses connection draining to ensure that in-flight traffic completes on the existing connections. This deregistration delay is configured by default but can be updated for each target group. For more information, see the following: Deregistration delay in the Application Load Balancers User Guide Deregistration delay in the Network Load Balancers User Guide Deregistration delay in the Gateway Load Balancers User Guide Note: If the specified target does not exist, the action returns successfully.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeregisterTargetsOutput'
        '400':
          description: InvalidTargetException; TargetGroupNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTargetException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeregisterTargets
                  Version:
                    type: string
                    const: '2015-12-01'
              - $ref: '#/components/schemas/DeregisterTargetsInput'
            example:
              TargetGroupArn: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067
              Targets:
              - Id: i-0f76fade
      tags:
      - Targets
      security:
      - sigv4Auth: []
    servers:
    - url: https://elasticloadbalancing.{region}.amazonaws.com
      description: Amazon Elastic Load Balancing Regional Endpoint
      variables:
        region:
          default: us-east-1
          description: AWS Region
  /?Action=DescribeTargetHealth:
    get:
      operationId: describeTargetHealth
      summary: Amazon Elastic Load Balancing Describe Target Health
      description: Describes the health of the specified targets or all of your targets registered with the specified target group.
      tags:
      - Targets
      parameters:
      - name: TargetGroupArn
        in: query
        required: true
        description: The ARN of the target group
        schema:
          type: string
      - name: Targets.member.1.Id
        in: query
        description: The ID of the target
        schema:
          type: string
      - name: Targets.member.1.Port
        in: query
        description: The port on which the target is listening
        schema:
          type: integer
      responses:
        '200':
          description: Successfully described target health
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/DescribeTargetHealthResponse'
              examples:
                describeTargetHealth200Example:
                  summary: Default describeTargetHealth 200 response
                  x-microcks-default: true
                  value:
                    targetHealthDescriptions: []
        '400':
          description: Invalid request parameters
        '401':
          description: Authentication failure
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - sigv4Auth: []
    servers:
    - url: https://elasticloadbalancing.{region}.amazonaws.com
      description: Amazon Elastic Load Balancing Regional Endpoint
      variables:
        region:
          default: us-east-1
          description: AWS Region
components:
  schemas:
    DescribeTargetHealthResponse:
      type: object
      description: Response from the DescribeTargetHealth action
      properties:
        targetHealthDescriptions:
          type: array
          description: Information about the health of the targets
          items:
            type: object
            properties:
              target:
                type: object
                properties:
                  id:
                    type: string
                    description: The ID of the target
                  port:
                    type: integer
                    description: The port on which the target is listening
              targetHealth:
                type: object
                properties:
                  state:
                    type: string
                    description: The state of the target
                    enum:
                    - initial
                    - healthy
                    - unhealthy
                    - unused
                    - draining
                    - unavailable
                  reason:
                    type: string
                    description: The reason code
                  description:
                    type: string
                    description: A description of the target health
    RegisterTargetsInput:
      type: object
      properties:
        TargetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target group.
        Targets:
          type: array
          items:
            $ref: '#/components/schemas/TargetDescription'
          description: The targets.
      required:
      - TargetGroupArn
      - Targets
    DeregisterTargetsInput:
      type: object
      properties:
        TargetGroupArn:
          type: string
          description: The Amazon Resource Name (ARN) of the target group.
        Targets:
          type: array
          items:
            $ref: '#/components/schemas/TargetDescription'
          description: The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.
      required:
      - TargetGroupArn
      - Targets
    DeregisterTargetsOutput:
      type: object
      properties: {}
    RegisterTargetsOutput:
      type: object
      properties: {}
    InvalidTargetException:
      type: object
      properties:
        Message:
          type: string
    TargetDescription:
      type: object
      properties:
        Id:
          type: string
          description: The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.
        Port:
          type: integer
          description: The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.
        AvailabilityZone:
          type: string
          description: An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer. For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all. This parameter is not supported if the target type of the target group is instance or alb. If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availabili
        QuicServerId:
          type: string
          description: The server ID for the targets. This value is required if the protocol is QUIC or TCP_QUIC and can't be used with other protocols. The ID consists of the 0x prefix followed by 16 hexadecimal characters. Any letters must be lowercase. The value must be unique at the listener level. You can't modify the server ID for a registered target. You must deregister the target and then provide a new server ID when you register the target again.
      required:
      - Id
  securitySchemes:
    sigv4Auth:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication
    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: elasticloadbalancing
externalDocs:
  description: Amazon Elastic Load Balancing API Reference
  url: https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/
x-refined-from:
- amazon-elastic-load-balancing-openapi.yml
- amazon-elastic-load-balancing-targets-api-openapi.yml