Amazon Fault Injection Simulator Safety Levers API

Manage safety levers for experiment control

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

amazon-fault-injection-simulator-safety-levers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Fault Injection Simulator Actions Safety Levers API
  description: AWS Fault Injection Simulator (FIS) is a fully managed service for running fault injection experiments on AWS. This API enables creating experiment templates, starting and stopping experiments, managing safety levers, and configuring multi-account targets for chaos engineering.
  version: '2020-12-01'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: https://fis.{region}.amazonaws.com
  description: AWS FIS Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
security:
- aws_signature_v4: []
tags:
- name: Safety Levers
  description: Manage safety levers for experiment control
paths:
  /safetyLevers/{id}:
    get:
      operationId: getSafetyLever
      summary: AWS Fault Injection Simulator Get Safety Lever
      description: Gets information about the specified safety lever.
      tags:
      - Safety Levers
      parameters:
      - name: id
        in: path
        required: true
        description: Safety lever ID
        schema:
          type: string
        example: SL123
      responses:
        '200':
          description: Safety lever details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyLeverResponse'
              examples:
                GetSafetyLever200Example:
                  summary: Default response
                  x-microcks-default: true
                  value:
                    safetyLever:
                      id: SL123
                      arn: arn:aws:fis:us-east-1:123456789012:safety-lever/SL123
                      state:
                        status: engaged
                        reason: No active experiments
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateSafetyLeverState
      summary: AWS Fault Injection Simulator Update Safety Lever State
      description: Updates the state of the safety lever.
      tags:
      - Safety Levers
      parameters:
      - name: id
        in: path
        required: true
        description: Safety lever ID
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSafetyLeverStateRequest'
            examples:
              UpdateSafetyLeverStateRequestExample:
                summary: Default request
                x-microcks-default: true
                value:
                  state:
                    status: disengaged
                    reason: Running planned experiment
      responses:
        '200':
          description: Safety lever updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SafetyLeverResponse'
              examples:
                UpdateSafetyLeverState200Example:
                  summary: Default response
                  x-microcks-default: true
                  value:
                    safetyLever:
                      id: SL123
                      state:
                        status: disengaged
                        reason: Running planned experiment
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateSafetyLeverStateRequest:
      type: object
      required:
      - state
      description: Request to update safety lever state
      properties:
        state:
          $ref: '#/components/schemas/SafetyLeverState'
    SafetyLever:
      type: object
      description: A safety mechanism that can stop or prevent FIS experiments
      properties:
        id:
          type: string
          description: Safety lever ID
          example: SL123
        arn:
          type: string
          description: Safety lever ARN
          example: arn:aws:fis:us-east-1:123456789012:safety-lever/SL123
        state:
          $ref: '#/components/schemas/SafetyLeverState'
    ErrorResponse:
      type: object
      description: Error response from the FIS API
      properties:
        message:
          type: string
          description: Error message
          example: The specified resource does not exist.
    SafetyLeverResponse:
      type: object
      description: Response containing safety lever
      properties:
        safetyLever:
          $ref: '#/components/schemas/SafetyLever'
    SafetyLeverState:
      type: object
      description: State of a safety lever
      properties:
        status:
          type: string
          description: Safety lever status
          example: engaged
          enum:
          - engaged
          - disengaged
          - engaging
          - disengaging
        reason:
          type: string
          description: Status reason
          example: No active experiments
  securitySchemes:
    aws_signature_v4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 authentication
externalDocs:
  description: AWS FIS API Reference
  url: https://docs.aws.amazon.com/fis/latest/APIReference/Welcome.html