Amazon VPC Lattice BatchUpdateRule API

The BatchUpdateRule API from Amazon VPC Lattice — 1 operation(s) for batchupdaterule.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 1

PATCH /services/{serviceIdentifier}/listeners/{listenerIdentifier}/rules Batch Update Rule #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-vpc-lattice:amazon-vpc-lattice-batchupdaterule-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-vpc-lattice-batchupdaterule-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon VPC Lattice Batchupdaterule API
  version: '2022-11-30'
  description: Generated from AWS's published Smithy model for Amazon VPC Lattice. 1 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://vpc-lattice.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /services/{serviceIdentifier}/listeners/{listenerIdentifier}/rules:
    patch:
      operationId: BatchUpdateRule
      summary: Batch Update Rule
      description: 'Updates the listener rules in a batch. You can use this operation to change the priority of listener rules.
        This can be useful when bulk updating or swapping rule priority. Required permissions: vpc-lattice:UpdateRule For
        more information, see How Amazon VPC Lattice works with IAM in the Amazon VPC Lattice User Guide.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpdateRuleResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: serviceIdentifier
        in: path
        required: true
        schema:
          type: string
        description: The ID or ARN of the service.
      - name: listenerIdentifier
        in: path
        required: true
        schema:
          type: string
        description: The ID or ARN of the listener.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  type: array
                  items:
                    $ref: '#/components/schemas/RuleUpdate'
                  description: The rules for the specified listener.
              required:
              - rules
      tags:
      - Batchupdaterule
components:
  securitySchemes:
    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: vpc-lattice
  schemas:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    BatchUpdateRuleResponse:
      type: object
      properties:
        successful:
          type: array
          items:
            $ref: '#/components/schemas/RuleUpdateSuccess'
          description: The rules that were successfully updated.
        unsuccessful:
          type: array
          items:
            $ref: '#/components/schemas/RuleUpdateFailure'
          description: The rules that the operation couldn't update.
    ConflictException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The resource ID.
        resourceType:
          type: string
          description: The resource type.
      required:
      - message
      - resourceId
      - resourceType
    FixedResponseAction:
      type: object
      properties:
        statusCode:
          type: integer
          description: The HTTP response code. Only 404 and 500 status codes are supported.
      required:
      - statusCode
    ForwardAction:
      type: object
      properties:
        targetGroups:
          type: array
          items:
            $ref: '#/components/schemas/WeightedTargetGroup'
          description: The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward
            actions, you can assign a weight that controls the prioritization and selection of each target group. This means
            that requests are distributed to individual target groups based on their weights. For example, if two target groups
            have the same weight, each target group receives half of the traffic. The default value is 1. This means that
            if only one target group is provided, there is no need to set the weight; 100% of the traffic goes to that target
            group.
      required:
      - targetGroups
    HeaderMatch:
      type: object
      properties:
        name:
          type: string
          description: The name of the header.
        match:
          $ref: '#/components/schemas/HeaderMatchType'
        caseSensitive:
          type: boolean
          description: Indicates whether the match is case sensitive.
      required:
      - name
      - match
    HeaderMatchType:
      type: object
      properties:
        exact:
          type: string
          description: An exact type match.
        prefix:
          type: string
          description: A prefix type match. Matches the value with the prefix.
        contains:
          type: string
          description: A contains type match.
      description: Exactly one member is set.
    HttpMatch:
      type: object
      properties:
        method:
          type: string
          description: The HTTP method type.
        pathMatch:
          $ref: '#/components/schemas/PathMatch'
        headerMatches:
          type: array
          items:
            $ref: '#/components/schemas/HeaderMatch'
          description: The header matches. Matches incoming requests with rule based on request header value before applying
            rule action.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying.
      required:
      - message
    PathMatch:
      type: object
      properties:
        match:
          $ref: '#/components/schemas/PathMatchType'
        caseSensitive:
          type: boolean
          description: Indicates whether the match is case sensitive.
      required:
      - match
    PathMatchType:
      type: object
      properties:
        exact:
          type: string
          description: An exact match of the path.
        prefix:
          type: string
          description: A prefix match of the path.
      description: Exactly one member is set.
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The resource ID.
        resourceType:
          type: string
          description: The resource type.
      required:
      - message
      - resourceId
      - resourceType
    RuleAction:
      type: object
      properties:
        forward:
          $ref: '#/components/schemas/ForwardAction'
        fixedResponse:
          $ref: '#/components/schemas/FixedResponseAction'
      description: Exactly one member is set.
    RuleMatch:
      type: object
      properties:
        httpMatch:
          $ref: '#/components/schemas/HttpMatch'
      description: Exactly one member is set.
    RuleUpdate:
      type: object
      properties:
        ruleIdentifier:
          type: string
          description: The ID or ARN of the rule.
        match:
          $ref: '#/components/schemas/RuleMatch'
        priority:
          type: integer
          description: The rule priority. A listener can't have multiple rules with the same priority.
        action:
          $ref: '#/components/schemas/RuleAction'
      required:
      - ruleIdentifier
    RuleUpdateFailure:
      type: object
      properties:
        ruleIdentifier:
          type: string
          description: The ID or ARN of the rule.
        failureCode:
          type: string
          description: The failure code.
        failureMessage:
          type: string
          description: The failure message.
    RuleUpdateSuccess:
      type: object
      properties:
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the listener.
        id:
          type: string
          description: The ID of the listener.
        name:
          type: string
          description: The name of the listener.
        isDefault:
          type: boolean
          description: Indicates whether this is the default rule.
        match:
          $ref: '#/components/schemas/RuleMatch'
        priority:
          type: integer
          description: The rule priority.
        action:
          $ref: '#/components/schemas/RuleAction'
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
        serviceCode:
          type: string
          description: The service code.
        quotaCode:
          type: string
          description: The ID of the service quota that was exceeded.
        retryAfterSeconds:
          type: integer
          description: The number of seconds to wait before retrying.
      required:
      - message
    ValidationException:
      type: object
      properties:
        message:
          type: string
        reason:
          type: string
          description: The reason.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The fields that failed validation.
      required:
      - message
      - reason
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the validation exception.
        message:
          type: string
          description: Additional information about why the validation failed.
      required:
      - name
      - message
    WeightedTargetGroup:
      type: object
      properties:
        targetGroupIdentifier:
          type: string
          description: The ID or ARN of the target group.
        weight:
          type: integer
          description: Only required if you specify multiple target groups for a forward action. The weight determines how
            requests are distributed to the target group. For example, if you specify two target groups, each with a weight
            of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10
            and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the
            other target group. If there's only one target group specified, then the default value is 100.
      required:
      - targetGroupIdentifier
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/vpc-lattice/service/2022-11-30/vpc-lattice-2022-11-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)