Amazon X-Ray SamplingTargets API

openapi: 3.0.0
info:
  version: '2016-04-12'
  x-release: v4
  title: AWS X-Ray CreateGroup SamplingTargets API
  description: Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    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: xray
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/xray-2016-04-12.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://xray.{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 X-Ray multi-region endpoint
- url: https://xray.{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 X-Ray multi-region endpoint
- url: http://xray.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)
- url: https://xray.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: SamplingTargets
paths:
  /SamplingTargets:
    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: GetSamplingTargets
      description: 'Requests a sampling quota for rules that the service is using to sample requests. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSamplingTargetsResult'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ThrottledException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottledException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - SamplingStatisticsDocuments
              properties:
                SamplingStatisticsDocuments:
                  description: Information about rules that the service is using to sample requests.
                  type: array
                  items:
                    $ref: '#/components/schemas/SamplingStatisticsDocument'
                  maxItems: 25
      summary: Amazon X-Ray Get Sampling Targets
      tags:
      - SamplingTargets
components:
  schemas:
    BorrowCount:
      type: integer
      minimum: 0
    GetSamplingTargetsResult:
      type: object
      properties:
        SamplingTargetDocuments:
          allOf:
          - $ref: '#/components/schemas/SamplingTargetDocumentList'
          - description: Updated rules that the service should use to sample requests.
        LastRuleModification:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingRules.html">GetSamplingRules</a> to get the latest version.
        UnprocessedStatistics:
          allOf:
          - $ref: '#/components/schemas/UnprocessedStatisticsList'
          - description: Information about <a href="https://docs.aws.amazon.com/xray/latest/api/API_SamplingStatisticsDocument.html">SamplingStatisticsDocument</a> that X-Ray could not process.
    UnprocessedStatistics:
      type: object
      properties:
        RuleName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the sampling rule.
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error code.
        Message:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The error message.
      description: Sampling statistics from a call to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a> that X-Ray could not process.
    String:
      type: string
    NullableInteger:
      type: integer
    SamplingTargetDocument:
      type: object
      properties:
        RuleName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the sampling rule.
        FixedRate:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The percentage of matching requests to instrument, after the reservoir is exhausted.
        ReservoirQuota:
          allOf:
          - $ref: '#/components/schemas/NullableInteger'
          - description: The number of requests per second that X-Ray allocated for this service.
        ReservoirQuotaTTL:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: When the reservoir quota expires.
        Interval:
          allOf:
          - $ref: '#/components/schemas/NullableInteger'
          - description: The number of seconds for the service to wait before getting sampling targets again.
      description: Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.
    RuleName:
      type: string
      minLength: 1
      maxLength: 32
    SamplingStatisticsDocument:
      type: object
      required:
      - RuleName
      - ClientID
      - Timestamp
      - RequestCount
      - SampledCount
      properties:
        RuleName:
          allOf:
          - $ref: '#/components/schemas/RuleName'
          - description: The name of the sampling rule.
        ClientID:
          allOf:
          - $ref: '#/components/schemas/ClientID'
          - description: A unique identifier for the service in hexadecimal.
        Timestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The current time.
        RequestCount:
          allOf:
          - $ref: '#/components/schemas/RequestCount'
          - description: The number of requests that matched the rule.
        SampledCount:
          allOf:
          - $ref: '#/components/schemas/SampledCount'
          - description: The number of requests recorded.
        BorrowCount:
          allOf:
          - $ref: '#/components/schemas/BorrowCount'
          - description: The number of requests recorded with borrowed reservoir quota.
      description: Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to <a href="https://docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html">GetSamplingTargets</a>.
    Double:
      type: number
      format: double
    RequestCount:
      type: integer
      minimum: 0
    ClientID:
      type: string
      minLength: 24
      maxLength: 24
    SamplingTargetDocumentList:
      type: array
      items:
        $ref: '#/components/schemas/SamplingTargetDocument'
    ThrottledException: {}
    InvalidRequestException: {}
    Timestamp:
      type: string
      format: date-time
    UnprocessedStatisticsList:
      type: array
      items:
        $ref: '#/components/schemas/UnprocessedStatistics'
    SampledCount:
      type: integer
      minimum: 0
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    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-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
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
  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/xray/