AWS App Runner Observability API

openapi: 3.1.0
info:
  title: AWS App Runner Observability API
  version: '2020-05-15'
  description: Generated from AWS's published Smithy model for AWS App Runner. 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://apprunner.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateObservabilityConfiguration:
    post:
      operationId: CreateObservabilityConfiguration
      summary: Create Observability Configuration
      description: Create an App Runner observability configuration resource. App Runner requires this resource when you create
        or update App Runner services and you want to enable non-default observability features. You can share an observability
        configuration across multiple services. Create multiple revisions of a configuration by calling this action multiple
        times using the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision
        values. When you create a service and configure an observability configuration resource, the service uses the latest
        active revision of the observability configuration by default. You can optionally configure the service to use a specific
        revision. The observability configuration resource is designed to configure multiple features (currently one feature,
        tracing). This action takes optional parameters that describe the configuration of these features (currently one parameter,
        TraceConfiguration). If you don't specify a feature parameter, App Runner doesn't enable the feature.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateObservabilityConfigurationResponse'
        '500':
          description: InternalServiceErrorException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServiceErrorException'
        '400':
          description: InvalidRequestException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AppRunner.CreateObservabilityConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateObservabilityConfigurationRequest'
      tags:
      - Observability
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: apprunner
  schemas:
    CreateObservabilityConfigurationRequest:
      type: object
      properties:
        ObservabilityConfigurationName:
          type: string
          description: A name for the observability configuration. When you use it for the first time in an Amazon Web Services
            Region, App Runner creates revision number 1 of this name. When you use the same name in subsequent calls, App
            Runner creates incremental revisions of the configuration. The name DefaultConfiguration is reserved. You can't
            use it to create a new observability configuration, and you can't create a revision of it. When you want to use
            your own observability configuration for your App Runner service, create a configuration with a different name,
            and then provide it when you create or update yo
        TraceConfiguration:
          $ref: '#/components/schemas/TraceConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of metadata items that you can associate with your observability configuration resource. A tag
            is a key-value pair.
      required:
      - ObservabilityConfigurationName
    CreateObservabilityConfigurationResponse:
      type: object
      properties:
        ObservabilityConfiguration:
          $ref: '#/components/schemas/ObservabilityConfiguration'
      required:
      - ObservabilityConfiguration
    InternalServiceErrorException:
      type: object
      properties:
        Message:
          type: string
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
    ObservabilityConfiguration:
      type: object
      properties:
        ObservabilityConfigurationArn:
          type: string
          description: The Amazon Resource Name (ARN) of this observability configuration.
        ObservabilityConfigurationName:
          type: string
          description: The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
        TraceConfiguration:
          $ref: '#/components/schemas/TraceConfiguration'
        ObservabilityConfigurationRevision:
          type: integer
          description: 'The revision of this observability configuration. It''s unique among all the active configurations
            ("Status": "ACTIVE") that share the same ObservabilityConfigurationName.'
        Latest:
          type: boolean
          description: It's set to true for the configuration with the highest Revision among all configurations that share
            the same ObservabilityConfigurationName. It's set to false otherwise.
        Status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: The current state of the observability configuration. If the status of a configuration revision is
            INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time
            after they are deleted.
        CreatedAt:
          type: string
          format: date-time
          description: The time when the observability configuration was created. It's in Unix time stamp format.
        DeletedAt:
          type: string
          format: date-time
          description: The time when the observability configuration was deleted. It's in Unix time stamp format.
    ServiceQuotaExceededException:
      type: object
      properties:
        Message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag.
        Value:
          type: string
          description: The value of the tag.
    TraceConfiguration:
      type: object
      properties:
        Vendor:
          type: string
          enum:
          - AWSXRAY
          description: The implementation provider chosen for tracing App Runner services.
      required:
      - Vendor
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/apprunner/service/2020-05-15/apprunner-2020-05-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)