Amazon DMS #X Amz Target=AmazonDMSv20160101.CreateFleetAdvisorCollector API

openapi: 3.0.0
info:
  version: 2016-01-01
  x-release: v4
  title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.CreateFleetAdvisorCollector API'
  description: <fullname>Database Migration Service</fullname> <p>Database Migration Service (DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about DMS, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/Welcome.html">What Is Database Migration Service?</a> in the <i>Database Migration Service User Guide.</i> </p>
  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: dms
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/dms-2016-01-01.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://dms.{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 Database Migration Service multi-region endpoint
- url: https://dms.{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 Database Migration Service multi-region endpoint
- url: http://dms.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
- url: https://dms.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS Database Migration Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AmazonDMSv20160101.CreateFleetAdvisorCollector'
paths:
  /#X-Amz-Target=AmazonDMSv20160101.CreateFleetAdvisorCollector:
    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: CreateFleetAdvisorCollector
      description: Creates a Fleet Advisor collector using the specified parameters.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFleetAdvisorCollectorResponse'
        '480':
          description: InvalidResourceStateFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidResourceStateFault'
        '481':
          description: AccessDeniedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedFault'
        '482':
          description: S3AccessDeniedFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3AccessDeniedFault'
        '483':
          description: S3ResourceNotFoundFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/S3ResourceNotFoundFault'
        '484':
          description: ResourceQuotaExceededFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceQuotaExceededFault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFleetAdvisorCollectorRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.CreateFleetAdvisorCollector
      tags:
      - '#X Amz Target=AmazonDMSv20160101.CreateFleetAdvisorCollector'
components:
  schemas:
    InvalidResourceStateFault: {}
    String:
      type: string
    CreateFleetAdvisorCollectorRequest:
      type: object
      required:
      - CollectorName
      - ServiceAccessRoleArn
      - S3BucketName
      title: CreateFleetAdvisorCollectorRequest
      properties:
        CollectorName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of your Fleet Advisor collector (for example, <code>sample-collector</code>).
        Description:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A summary description of your Fleet Advisor collector.
        ServiceAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The IAM role that grants permissions to access the specified Amazon S3 bucket.
        S3BucketName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon S3 bucket that the Fleet Advisor collector uses to store inventory metadata.
    S3ResourceNotFoundFault: {}
    ResourceQuotaExceededFault: {}
    S3AccessDeniedFault: {}
    CreateFleetAdvisorCollectorResponse:
      type: object
      properties:
        CollectorReferencedId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The unique ID of the new Fleet Advisor collector, for example: <code>22fda70c-40d5-4acf-b233-a495bd8eb7f5</code> '
        CollectorName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the new Fleet Advisor collector.
        Description:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A summary description of the Fleet Advisor collector.
        ServiceAccessRoleArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The IAM role that grants permissions to access the specified Amazon S3 bucket.
        S3BucketName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon S3 bucket that the collector uses to store inventory metadata.
    AccessDeniedFault: {}
  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-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-Credential:
      name: X-Amz-Credential
      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-Signature:
      name: X-Amz-Signature
      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/dms/
x-hasEquivalentPaths: true