Amazon Global Accelerator #X Amz Target=GlobalAccelerator V20180706.UpdateEndpointGroup API

openapi: 3.2.0
info:
  version: '2018-08-08'
  x-release: v4
  title: 'AWS Global Accelerator #X Amz Target=GlobalAccelerator…'
  description: 'Global Accelerator

    This is the Global Accelerator 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: globalaccelerator
  x-aws-signingName: globalaccelerator
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/globalaccelerator-2018-08-08.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://globalaccelerator.{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 AWS Global Accelerator multi-region endpoint
- url: https://globalaccelerator.{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 AWS Global Accelerator multi-region endpoint
- url: http://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
- url: https://globalaccelerator.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Global Accelerator endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=GlobalAccelerator V20180706.UpdateEndpointGroup'
paths:
  /#X-Amz-Target=GlobalAccelerator_V20180706.UpdateEndpointGroup:
    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'
    post:
      operationId: UpdateEndpointGroup
      description: Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEndpointGroupResponse'
              examples:
                UpdateEndpointGroup200Example:
                  summary: Default UpdateEndpointGroup 200 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '480':
          description: InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
              examples:
                UpdateEndpointGroup480Example:
                  summary: Default UpdateEndpointGroup 480 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '481':
          description: EndpointGroupNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointGroupNotFoundException'
              examples:
                UpdateEndpointGroup481Example:
                  summary: Default UpdateEndpointGroup 481 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '482':
          description: InternalServiceErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
              examples:
                UpdateEndpointGroup482Example:
                  summary: Default UpdateEndpointGroup 482 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                UpdateEndpointGroup483Example:
                  summary: Default UpdateEndpointGroup 483 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
        '484':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
              examples:
                UpdateEndpointGroup484Example:
                  summary: Default UpdateEndpointGroup 484 response
                  x-microcks-default: true
                  value:
                    acceleratorArn: arn:aws:globalaccelerator::123456789012:accelerator/abc123
                    status: DEPLOYED
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEndpointGroupRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GlobalAccelerator_V20180706.UpdateEndpointGroup
      summary: Amazon Global Accelerator Update Endpoint Group
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GlobalAccelerator V20180706.UpdateEndpointGroup'
components:
  parameters:
    X-Amz-Signature:
      name: X-Amz-Signature
      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-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-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
  schemas:
    EndpointGroupNotFoundException: {}
    EndpointGroup:
      type: object
      properties:
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group.
        EndpointGroupRegion:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Web Services Region where the endpoint group is located.
        EndpointDescriptions:
          allOf:
          - $ref: '#/components/schemas/EndpointDescriptions'
          - description: The list of endpoint objects.
        TrafficDialPercentage:
          allOf:
          - $ref: '#/components/schemas/TrafficDialPercentage'
          - description: <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
        HealthCheckPort:
          allOf:
          - $ref: '#/components/schemas/HealthCheckPort'
          - description: <p>The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. </p> <p>The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.</p>
        HealthCheckProtocol:
          allOf:
          - $ref: '#/components/schemas/HealthCheckProtocol'
          - description: The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.
        HealthCheckPath:
          allOf:
          - $ref: '#/components/schemas/HealthCheckPath'
          - description: If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).
        HealthCheckIntervalSeconds:
          allOf:
          - $ref: '#/components/schemas/HealthCheckIntervalSeconds'
          - description: The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
        ThresholdCount:
          allOf:
          - $ref: '#/components/schemas/ThresholdCount'
          - description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
        PortOverrides:
          allOf:
          - $ref: '#/components/schemas/PortOverrides'
          - description: 'Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on. '
      description: 'A complex type for the endpoint group. An Amazon Web Services Region can have only one endpoint group for a specific listener. '
    InternalServiceErrorException: {}
    HealthState:
      type: string
      enum:
      - INITIAL
      - HEALTHY
      - UNHEALTHY
    UpdateEndpointGroupResponse:
      type: object
      properties:
        EndpointGroup:
          allOf:
          - $ref: '#/components/schemas/EndpointGroup'
          - description: The information about the endpoint group that was updated.
    EndpointDescriptions:
      type: array
      items:
        $ref: '#/components/schemas/EndpointDescription'
    HealthCheckIntervalSeconds:
      type: integer
      minimum: 10
      maximum: 30
    TrafficDialPercentage:
      type: number
      format: float
      minimum: 0
      maximum: 100
    PortOverride:
      type: object
      properties:
        ListenerPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on.
        EndpointPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The endpoint port that you want a listener port to be mapped to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance.
      description: <p>Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
    UpdateEndpointGroupRequest:
      type: object
      required:
      - EndpointGroupArn
      title: UpdateEndpointGroupRequest
      properties:
        EndpointGroupArn:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: The Amazon Resource Name (ARN) of the endpoint group.
        EndpointConfigurations:
          allOf:
          - $ref: '#/components/schemas/EndpointConfigurations'
          - description: The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
        TrafficDialPercentage:
          allOf:
          - $ref: '#/components/schemas/TrafficDialPercentage'
          - description: <p>The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. </p> <p>Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.</p> <p>The default value is 100.</p>
        HealthCheckPort:
          allOf:
          - $ref: '#/components/schemas/HealthCheckPort'
          - description: The port that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
        HealthCheckProtocol:
          allOf:
          - $ref: '#/components/schemas/HealthCheckProtocol'
          - description: The protocol that Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
        HealthCheckPath:
          allOf:
          - $ref: '#/components/schemas/HealthCheckPath'
          - description: If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
        HealthCheckIntervalSeconds:
          allOf:
          - $ref: '#/components/schemas/HealthCheckIntervalSeconds'
          - description: The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
        ThresholdCount:
          allOf:
          - $ref: '#/components/schemas/ThresholdCount'
          - description: The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
        PortOverrides:
          allOf:
          - $ref: '#/components/schemas/PortOverrides'
          - description: <p>Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html"> Overriding listener ports</a> in the <i>Global Accelerator Developer Guide</i>.</p>
    InvalidArgumentException: {}
    LimitExceededException: {}
    EndpointWeight:
      type: integer
      minimum: 0
      maximum: 255
    GenericBoolean:
      type: boolean
    EndpointConfigurations:
      type: array
      items:
        $ref: '#/components/schemas/EndpointConfiguration'
      minItems: 0
      maxItems: 10
    HealthCheckPort:
      type: integer
      minimum: 1
      maximum: 65535
    ThresholdCount:
      type: integer
      minimum: 1
      maximum: 10
    EndpointConfiguration:
      type: object
      properties:
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. A resource must be valid and active when you add it as an endpoint.</p> <p>An Application Load Balancer can be either internal or internet-facing.</p>
        Weight:
          allOf:
          - $ref: '#/components/schemas/EndpointWeight'
          - description: The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>.
        ClientIPPreservationEnabled:
          allOf:
          - $ref: '#/components/schemas/GenericBoolean'
          - description: <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
      description: A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
    HealthCheckPath:
      type: string
      pattern: ^/[-a-zA-Z0-9@:%_\\+.~#?&/=]*$
      maxLength: 255
    PortOverrides:
      type: array
      items:
        $ref: '#/components/schemas/PortOverride'
      minItems: 0
      maxItems: 10
    AccessDeniedException: {}
    EndpointDescription:
      type: object
      properties:
        EndpointId:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: <p>An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. For Amazon EC2 instances, this is the EC2 instance ID. </p> <p>An Application Load Balancer can be either internal or internet-facing.</p>
        Weight:
          allOf:
          - $ref: '#/components/schemas/EndpointWeight'
          - description: 'The weight associated with the endpoint. When you add weights to endpoints, you configure Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html">Endpoint weights</a> in the <i>Global Accelerator Developer Guide</i>. '
        HealthState:
          allOf:
          - $ref: '#/components/schemas/HealthState'
          - description: The health status of the endpoint.
        HealthReason:
          allOf:
          - $ref: '#/components/schemas/GenericString'
          - description: Returns a null result.
        ClientIPPreservationEnabled:
          allOf:
          - $ref: '#/components/schemas/GenericBoolean'
          - description: <p>Indicates whether client IP address preservation is enabled for an endpoint. The value is true or false. The default value is true for new accelerators. </p> <p>If the value is set to true, the client's IP address is preserved in the <code>X-Forwarded-For</code> request header as traffic travels to applications on the endpoint fronted by the accelerator.</p> <p>Client IP address preservation is supported, in specific Amazon Web Services Regions, for endpoints that are Application Load Balancers and Amazon EC2 instances.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html"> Preserve client IP addresses in Global Accelerator</a> in the <i>Global Accelerator Developer Guide</i>.</p>
      description: A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
    HealthCheckProtocol:
      type: string
      enum:
      - TCP
      - HTTP
      - HTTPS
    PortNumber:
      type: integer
      minimum: 1
      maximum: 65535
    GenericString:
      type: string
      maxLength: 255
  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/globalaccelerator/
x-hasEquivalentPaths: true