Amazon Application Discovery Service Exports API

openapi: 3.1.0
info:
  title: AWS Application Discovery Service Exports API
  version: '2015-11-01'
  description: Generated from AWS's published Smithy model for AWS Application Discovery Service. 5 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://discovery.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DescribeContinuousExports:
    post:
      operationId: DescribeContinuousExports
      summary: Describe Continuous Exports
      description: Lists exports as specified by ID. All continuous exports associated with your user can be listed if you
        call DescribeContinuousExports as is without passing any parameters.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeContinuousExportsResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '429':
          description: OperationNotPermittedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.DescribeContinuousExports
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeContinuousExportsRequest'
      tags:
      - Exports
  /#StartContinuousExport:
    post:
      operationId: StartContinuousExport
      summary: Start Continuous Export
      description: Start the continuous flow of agent's discovered data into Amazon Athena.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartContinuousExportResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '409':
          description: ConflictErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException; ResourceInUseException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '429':
          description: OperationNotPermittedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StartContinuousExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartContinuousExportRequest'
      tags:
      - Exports
  /#StopContinuousExport:
    post:
      operationId: StopContinuousExport
      summary: Stop Continuous Export
      description: Stop the continuous flow of agent's discovered data into Amazon Athena.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopContinuousExportResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException; ResourceInUseException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '429':
          description: OperationNotPermittedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StopContinuousExport
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopContinuousExportRequest'
      tags:
      - Exports
  /#DescribeExportTasks:
    post:
      operationId: DescribeExportTasks
      summary: Describe Export Tasks
      description: Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExportTasksResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.DescribeExportTasks
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExportTasksRequest'
      tags:
      - Exports
  /#StartExportTask:
    post:
      operationId: StartExportTask
      summary: Start Export Task
      description: Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services. Exports
        might provide an estimate of fees and savings based on certain information that you provide. Fee estimates do not
        include any taxes that might apply. Your actual fees and savings depend on a variety of factors, including your actual
        usage of Amazon Web Services services, which might vary from the estimates provided in this report. If you do not
        specify preferences or agentIds in the filter, a summary of all servers, applications, tags, and performance is generated.
        This data is an aggregation of all server data collected through on-premises tooling, file import, application grouping
        and applying tags. If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected
        by the identified Application Discovery Agent, including network, process, and performance details. A time range for
        exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently
        running exports. Export of detailed agent data is limited to two exports per day. If you enable ec2RecommendationsPreferences
        in preferences , a
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartExportTaskResponse'
        '403':
          description: AuthorizationErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AuthorizationErrorException'
        '400':
          description: HomeRegionNotSetException; InvalidParameterException; InvalidParameterValueException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/HomeRegionNotSetException'
        '429':
          description: OperationNotPermittedException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/OperationNotPermittedException'
        '500':
          description: ServerInternalErrorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServerInternalErrorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSPoseidonService_V2015_11_01.StartExportTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartExportTaskRequest'
      tags:
      - Exports
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: discovery
  schemas:
    AuthorizationErrorException:
      type: object
      properties:
        message:
          type: string
    ConflictErrorException:
      type: object
      properties:
        message:
          type: string
    ContinuousExportDescription:
      type: object
      properties:
        exportId:
          type: string
          description: The unique ID assigned to this export.
        status:
          type: string
          enum:
          - START_IN_PROGRESS
          - START_FAILED
          - ACTIVE
          - ERROR
          - STOP_IN_PROGRESS
          - STOP_FAILED
          - INACTIVE
          description: 'Describes the status of the export. Can be one of the following values: START_IN_PROGRESS - setting
            up resources to start continuous export. START_FAILED - an error occurred setting up continuous export. To recover,
            call start-continuous-export again. ACTIVE - data is being exported to the customer bucket. ERROR - an error occurred
            during export. To fix the issue, call stop-continuous-export and start-continuous-export. STOP_IN_PROGRESS - stopping
            the export. STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.
            INACTIVE - the continuous export has'
        statusDetail:
          type: string
          description: 'Contains information about any errors that have occurred. This data type can have the following values:
            ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your Amazon Web
            Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery
            Service in the Application Discovery Service User Guide. DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit
            for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and
            try again. For more information, see Kinesis Data S'
        s3Bucket:
          type: string
          description: The name of the s3 bucket where the export data parquet files are stored.
        startTime:
          type: string
          format: date-time
          description: The timestamp representing when the continuous export was started.
        stopTime:
          type: string
          format: date-time
          description: The timestamp that represents when this continuous export was stopped.
        dataSource:
          type: string
          enum:
          - AGENT
          description: The type of data collector used to gather this data (currently only offered for AGENT).
        schemaStorageConfig:
          type: object
          additionalProperties:
            type: string
          description: An object which describes how the data is stored. databaseName - the name of the Glue database used
            to store the schema.
    DescribeContinuousExportsRequest:
      type: object
      properties:
        exportIds:
          type: array
          items:
            type: string
          description: The unique IDs assigned to the exports.
        maxResults:
          type: integer
          description: A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
        nextToken:
          type: string
          description: The token from the previous call to DescribeExportTasks.
    DescribeContinuousExportsResponse:
      type: object
      properties:
        descriptions:
          type: array
          items:
            $ref: '#/components/schemas/ContinuousExportDescription'
          description: A list of continuous export descriptions.
        nextToken:
          type: string
          description: The token from the previous call to DescribeExportTasks.
    DescribeExportTasksRequest:
      type: object
      properties:
        exportIds:
          type: array
          items:
            type: string
          description: One or more unique identifiers used to query the status of an export request.
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ExportFilter'
          description: One or more filters. AgentId - ID of the agent whose collected data will be exported
        maxResults:
          type: integer
          description: The maximum number of volume results returned by DescribeExportTasks in paginated output. When this
            parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken
            response element.
        nextToken:
          type: string
          description: The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults
            was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous
            results that returned the nextToken value. This value is null when there are no more results to return.
    DescribeExportTasksResponse:
      type: object
      properties:
        exportsInfo:
          type: array
          items:
            $ref: '#/components/schemas/ExportInfo'
          description: Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the
            response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.
        nextToken:
          type: string
          description: The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks
            request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when
            there are no more results to return.
    Ec2RecommendationsExportPreferences:
      type: object
      properties:
        enabled:
          type: boolean
          description: If set to true, the export preferences is set to Ec2RecommendationsExportPreferences.
        cpuPerformanceMetricBasis:
          $ref: '#/components/schemas/UsageMetricBasis'
        ramPerformanceMetricBasis:
          $ref: '#/components/schemas/UsageMetricBasis'
        tenancy:
          type: string
          enum:
          - DEDICATED
          - SHARED
          description: The target tenancy to use for your recommended EC2 instances.
        excludedInstanceTypes:
          type: array
          items:
            type: string
          description: An array of instance types to exclude from recommendations.
        preferredRegion:
          type: string
          description: The target Amazon Web Services Region for the recommendations. You can use any of the Region codes
            available for the chosen service, as listed in Amazon Web Services service endpoints in the Amazon Web Services
            General Reference.
        reservedInstanceOptions:
          $ref: '#/components/schemas/ReservedInstanceOptions'
    ExportFilter:
      type: object
      properties:
        name:
          type: string
          description: 'A single ExportFilter name. Supported filters: agentIds.'
        values:
          type: array
          items:
            type: string
          description: A single agent ID for a Discovery Agent. An agent ID can be found using the DescribeAgents action.
            Typically an ADS agent ID is in the form o-0123456789abcdef0.
        condition:
          type: string
          description: 'Supported condition: EQUALS'
      required:
      - name
      - values
      - condition
    ExportInfo:
      type: object
      properties:
        exportId:
          type: string
          description: A unique identifier used to query an export.
        exportStatus:
          type: string
          enum:
          - FAILED
          - SUCCEEDED
          - IN_PROGRESS
          description: The status of the data export job.
        statusMessage:
          type: string
          description: A status message provided for API callers.
        configurationsDownloadUrl:
          type: string
          description: A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if
            the export succeeded.
        exportRequestTime:
          type: string
          format: date-time
          description: The time that the data export was initiated.
        isTruncated:
          type: boolean
          description: If true, the export of agent information exceeded the size limit for a single export and the exported
            data is incomplete for the requested time range. To address this, select a smaller time range for the export by
            using startDate and endDate.
        requestedStartTime:
          type: string
          format: date-time
          description: The value of startTime parameter in the StartExportTask request. If no startTime was requested, this
            result does not appear in ExportInfo.
        requestedEndTime:
          type: string
          format: date-time
          description: The endTime used in the StartExportTask request. If no endTime was requested, this result does not
            appear in ExportInfo.
      required:
      - exportId
      - exportStatus
      - statusMessage
      - exportRequestTime
    ExportPreferences:
      type: object
      properties:
        ec2RecommendationsPreferences:
          $ref: '#/components/schemas/Ec2RecommendationsExportPreferences'
      description: Exactly one member is set.
    HomeRegionNotSetException:
      type: object
      properties:
        message:
          type: string
    OperationNotPermittedException:
      type: object
      properties:
        message:
          type: string
    ReservedInstanceOptions:
      type: object
      properties:
        purchasingOption:
          type: string
          enum:
          - ALL_UPFRONT
          - PARTIAL_UPFRONT
          - NO_UPFRONT
          description: The payment plan to use for your Reserved Instance.
        offeringClass:
          type: string
          enum:
          - STANDARD
          - CONVERTIBLE
          description: The flexibility to change the instance types needed for your Reserved Instance.
        termLength:
          type: string
          enum:
          - ONE_YEAR
          - THREE_YEAR
          description: The preferred duration of the Reserved Instance term.
      required:
      - purchasingOption
      - offeringClass
      - termLength
    ServerInternalErrorException:
      type: object
      properties:
        message:
          type: string
    StartContinuousExportRequest:
      type: object
      properties: {}
    StartContinuousExportResponse:
      type: object
      properties:
        exportId:
          type: string
          description: The unique ID assigned to this export.
        s3Bucket:
          type: string
          description: The name of the s3 bucket where the export data parquet files are stored.
        startTime:
          type: string
          format: date-time
          description: The timestamp representing when the continuous export was started.
        dataSource:
          type: string
          enum:
          - AGENT
          description: The type of data collector used to gather this data (currently only offered for AGENT).
        schemaStorageConfig:
          type: object
          additionalProperties:
            type: string
          description: A dictionary which describes how the data is stored. databaseName - the name of the Glue database used
            to store the schema.
    StartExportTaskRequest:
      type: object
      properties:
        exportDataFormat:
          type: array
          items:
            type: string
            enum:
            - CSV
          description: 'The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been
            deprecated.'
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ExportFilter'
          description: If a filter is present, it selects the single agentId of the Application Discovery Agent for which
            data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present,
            startTime and endTime are ignored and exported data includes both Amazon Web Services Application Discovery Service
            Agentless Collector collectors data and summary data from Application Discovery Agent agents.
        startTime:
          type: string
          format: date-time
          description: The start timestamp for exported data from the single Application Discovery Agent selected in the filters.
            If no value is specified, data is exported starting from the first data collected by the agent.
        endTime:
          type: string
          format: date-time
          description: The end timestamp for exported data from the single Application Discovery Agent selected in the filters.
            If no value is specified, exported data includes the most recent data collected by the agent.
        preferences:
          $ref: '#/components/schemas/ExportPreferences'
    StartExportTaskResponse:
      type: object
      properties:
        exportId:
          type: string
          description: A unique identifier used to query the status of an export request.
    StopContinuousExportRequest:
      type: object
      properties:
        exportId:
          type: string
          description: The unique ID assigned to this export.
      required:
      - exportId
    StopContinuousExportResponse:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
          description: Timestamp that represents when this continuous export started collecting data.
        stopTime:
          type: string
          format: date-time
          description: Timestamp that represents when this continuous export was stopped.
    UsageMetricBasis:
      type: object
      properties:
        name:
          type: string
          description: A utilization metric that is used by the recommendations.
        percentageAdjust:
          type: number
          description: Specifies the percentage of the specified utilization metric that is used by the recommendations.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/application-discovery-service/service/2015-11-01/application-discovery-service-2015-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)