Amazon Lookout for Metrics GetSampleData API

openapi: 3.0.0
info:
  version: 2017-07-25
  x-release: v4
  title: Amazon Lookout for Metrics ActivateAnomalyDetector GetSampleData API
  description: This is the <i>Amazon Lookout for Metrics API Reference</i>. For an introduction to the service with tutorials for getting started, visit <a href="https://docs.aws.amazon.com/lookoutmetrics/latest/dev">Amazon Lookout for Metrics Developer Guide</a>.
  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: lookoutmetrics
  x-aws-signingName: lookoutmetrics
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lookoutmetrics-2017-07-25.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://lookoutmetrics.{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 LookoutMetrics multi-region endpoint
- url: https://lookoutmetrics.{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 LookoutMetrics multi-region endpoint
- url: http://lookoutmetrics.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia)
- url: https://lookoutmetrics.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: GetSampleData
paths:
  /GetSampleData:
    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: GetSampleData
      description: Returns a selection of sample records from an Amazon S3 datasource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSampleDataResponse'
        '480':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '482':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '483':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                S3SourceConfig:
                  description: Contains information about the source configuration in Amazon S3.
                  type: object
                  properties:
                    RoleArn:
                      allOf:
                      - $ref: '#/components/schemas/Arn'
                      - description: The Amazon Resource Name (ARN) of the role.
                    TemplatedPathList:
                      allOf:
                      - $ref: '#/components/schemas/TemplatedPathList'
                      - description: An array of strings containing the list of templated paths.
                    HistoricalDataPathList:
                      allOf:
                      - $ref: '#/components/schemas/HistoricalDataPathList'
                      - description: An array of strings containing the historical set of data paths.
                    FileFormatDescriptor:
                      $ref: '#/components/schemas/FileFormatDescriptor'
      summary: Amazon Lookout for Metrics Get Sample Data
      tags:
      - GetSampleData
components:
  schemas:
    TemplatedPath:
      type: string
      pattern: ^s3://[a-zA-Z0-9_\-\/ {}=]+$
      maxLength: 1024
    ResourceNotFoundException: {}
    ValidationException: {}
    FileFormatDescriptor:
      type: object
      properties:
        CsvFormatDescriptor:
          allOf:
          - $ref: '#/components/schemas/CsvFormatDescriptor'
          - description: Contains information about how a source CSV data file should be analyzed.
        JsonFormatDescriptor:
          allOf:
          - $ref: '#/components/schemas/JsonFormatDescriptor'
          - description: Contains information about how a source JSON data file should be analyzed.
      description: Contains information about a source file's formatting.
    JsonFormatDescriptor:
      type: object
      properties:
        FileCompression:
          allOf:
          - $ref: '#/components/schemas/JsonFileCompression'
          - description: The level of compression of the source CSV file.
        Charset:
          allOf:
          - $ref: '#/components/schemas/Charset'
          - description: The character set in which the source JSON file is written.
      description: Contains information about how a source JSON data file should be analyzed.
    DataItem:
      type: string
    CsvFormatDescriptor:
      type: object
      properties:
        FileCompression:
          allOf:
          - $ref: '#/components/schemas/CSVFileCompression'
          - description: The level of compression of the source CSV file.
        Charset:
          allOf:
          - $ref: '#/components/schemas/Charset'
          - description: The character set in which the source CSV file is written.
        ContainsHeader:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Whether or not the source CSV file contains a header.
        Delimiter:
          allOf:
          - $ref: '#/components/schemas/Delimiter'
          - description: The character used to delimit the source CSV file.
        HeaderList:
          allOf:
          - $ref: '#/components/schemas/HeaderList'
          - description: A list of the source CSV file's headers, if any.
        QuoteSymbol:
          allOf:
          - $ref: '#/components/schemas/QuoteSymbol'
          - description: The character used as a quote character.
      description: Contains information about how a source CSV data file should be analyzed.
    HistoricalDataPathList:
      type: array
      items:
        $ref: '#/components/schemas/HistoricalDataPath'
      minItems: 1
      maxItems: 1
    HeaderValueList:
      type: array
      items:
        $ref: '#/components/schemas/HeaderValue'
    SampleRows:
      type: array
      items:
        $ref: '#/components/schemas/SampleRow'
    ColumnName:
      type: string
      pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
      minLength: 1
      maxLength: 63
    Boolean:
      type: boolean
    SampleRow:
      type: array
      items:
        $ref: '#/components/schemas/DataItem'
    HeaderValue:
      type: string
    Charset:
      type: string
      pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
      maxLength: 63
    QuoteSymbol:
      type: string
      pattern: '[^\r\n]|^$'
      maxLength: 1
    Arn:
      type: string
      pattern: arn:([a-z\d-]+):.*:.*:.*:.+
      maxLength: 256
    HistoricalDataPath:
      type: string
      pattern: ^s3://[a-z0-9].+$
      maxLength: 1024
    AccessDeniedException: {}
    TooManyRequestsException: {}
    HeaderList:
      type: array
      items:
        $ref: '#/components/schemas/ColumnName'
    InternalServerException: {}
    TemplatedPathList:
      type: array
      items:
        $ref: '#/components/schemas/TemplatedPath'
      minItems: 1
      maxItems: 1
    GetSampleDataResponse:
      type: object
      properties:
        HeaderValues:
          allOf:
          - $ref: '#/components/schemas/HeaderValueList'
          - description: A list of header labels for the records.
        SampleRows:
          allOf:
          - $ref: '#/components/schemas/SampleRows'
          - description: A list of records.
    JsonFileCompression:
      type: string
      enum:
      - NONE
      - GZIP
    Delimiter:
      type: string
      pattern: '[^\r\n]'
      maxLength: 1
    CSVFileCompression:
      type: string
      enum:
      - NONE
      - GZIP
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      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-Algorithm:
      name: X-Amz-Algorithm
      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
  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/lookoutmetrics/
x-hasEquivalentPaths: true