Amazon DMS #X Amz Target=AmazonDMSv20160101.DescribeReplicationInstances API

openapi: 3.0.0
info:
  version: 2016-01-01
  x-release: v4
  title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.DescribeReplicationInstances 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.DescribeReplicationInstances'
paths:
  /#X-Amz-Target=AmazonDMSv20160101.DescribeReplicationInstances:
    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: DescribeReplicationInstances
      description: Returns information about replication instances for your account in the current region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeReplicationInstancesResponse'
        '480':
          description: ResourceNotFoundFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundFault'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeReplicationInstancesMessage'
      parameters:
      - name: MaxRecords
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: Marker
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonDMSv20160101.DescribeReplicationInstances
      tags:
      - '#X Amz Target=AmazonDMSv20160101.DescribeReplicationInstances'
components:
  schemas:
    AvailabilityZone:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the Availability Zone.
      description: The name of an Availability Zone for use during database migration. <code>AvailabilityZone</code> is an optional parameter to the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_CreateReplicationInstance.html"> <code>CreateReplicationInstance</code> </a> operation, and it’s value relates to the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.
    FilterList:
      type: array
      items:
        $ref: '#/components/schemas/Filter'
    Filter:
      type: object
      required:
      - Name
      - Values
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of the filter as specified for a <code>Describe*</code> or similar operation.
        Values:
          allOf:
          - $ref: '#/components/schemas/FilterValueList'
          - description: The filter value, which can specify one or more values used to narrow the returned results.
      description: 'Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular <code>Describe*</code> call or similar operation. Filters are used as an optional parameter for certain API operations. '
    BooleanOptional:
      type: boolean
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    Subnet:
      type: object
      properties:
        SubnetIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The subnet identifier.
        SubnetAvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/AvailabilityZone'
          - description: The Availability Zone of the subnet.
        SubnetStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the subnet.
      description: In response to a request by the <code>DescribeReplicationSubnetGroups</code> operation, this object identifies a subnet by its given Availability Zone, subnet identifier, and status.
    ReplicationPendingModifiedValues:
      type: object
      properties:
        ReplicationInstanceClass:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The compute and memory capacity of the replication instance as defined for the specified replication instance class.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </p>
        AllocatedStorage:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: The amount of storage (in gigabytes) that is allocated for the replication instance.
        MultiAZ:
          allOf:
          - $ref: '#/components/schemas/BooleanOptional'
          - description: ' Specifies whether the replication instance is a Multi-AZ deployment. You can''t set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. '
        EngineVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The engine version number of the replication instance.
        NetworkType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
      description: 'Provides information about the values of pending modifications to a replication instance. This data type is an object of the <a href="https://docs.aws.amazon.com/dms/latest/APIReference/API_ReplicationInstance.html"> <code>ReplicationInstance</code> </a> user-defined data type. '
    FilterValueList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    ReplicationInstanceIpv6AddressList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    TStamp:
      type: string
      format: date-time
    SubnetList:
      type: array
      items:
        $ref: '#/components/schemas/Subnet'
    ReplicationInstance:
      type: object
      properties:
        ReplicationInstanceIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: '<p>The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain 1-63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>'
        ReplicationInstanceClass:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.</p> <p>For more information on the settings and capacities for the available replication instance classes, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth"> Selecting the right DMS replication instance for your migration</a>. </p>
        ReplicationInstanceStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The status of the replication instance. The possible return values include:</p> <ul> <li> <p> <code>"available"</code> </p> </li> <li> <p> <code>"creating"</code> </p> </li> <li> <p> <code>"deleted"</code> </p> </li> <li> <p> <code>"deleting"</code> </p> </li> <li> <p> <code>"failed"</code> </p> </li> <li> <p> <code>"modifying"</code> </p> </li> <li> <p> <code>"upgrading"</code> </p> </li> <li> <p> <code>"rebooting"</code> </p> </li> <li> <p> <code>"resetting-master-credentials"</code> </p> </li> <li> <p> <code>"storage-full"</code> </p> </li> <li> <p> <code>"incompatible-credentials"</code> </p> </li> <li> <p> <code>"incompatible-network"</code> </p> </li> <li> <p> <code>"maintenance"</code> </p> </li> </ul>
        AllocatedStorage:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The amount of storage (in gigabytes) that is allocated for the replication instance.
        InstanceCreateTime:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: The time the replication instance was created.
        VpcSecurityGroups:
          allOf:
          - $ref: '#/components/schemas/VpcSecurityGroupMembershipList'
          - description: The VPC security group for the instance.
        AvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Availability Zone for the instance.
        ReplicationSubnetGroup:
          allOf:
          - $ref: '#/components/schemas/ReplicationSubnetGroup'
          - description: The subnet group for the replication instance.
        PreferredMaintenanceWindow:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.
        PendingModifiedValues:
          allOf:
          - $ref: '#/components/schemas/ReplicationPendingModifiedValues'
          - description: The pending modification values.
        MultiAZ:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specifies whether the replication instance is a Multi-AZ deployment. You can''t set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. '
        EngineVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The engine version number of the replication instance.</p> <p>If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.</p> <p>When modifying a major engine version of an instance, also set <code>AllowMajorVersionUpgrade</code> to <code>true</code>.</p>
        AutoMinorVersionUpgrade:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Boolean value indicating if minor version upgrades will be automatically applied to the instance.
        KmsKeyId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>An KMS key identifier that is used to encrypt the data on the replication instance.</p> <p>If you don't specify a value for the <code>KmsKeyId</code> parameter, then DMS uses your default encryption key.</p> <p>KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.</p>
        ReplicationInstanceArn:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Amazon Resource Name (ARN) of the replication instance.
        ReplicationInstancePublicIpAddress:
          allOf:
          - $ref: '#/components/schemas/String'
          - deprecated: true
            description: The public IP address of the replication instance.
        ReplicationInstancePrivateIpAddress:
          allOf:
          - $ref: '#/components/schemas/String'
          - deprecated: true
            description: The private IP address of the replication instance.
        ReplicationInstancePublicIpAddresses:
          allOf:
          - $ref: '#/components/schemas/ReplicationInstancePublicIpAddressList'
          - description: One or more public IP addresses for the replication instance.
        ReplicationInstancePrivateIpAddresses:
          allOf:
          - $ref: '#/components/schemas/ReplicationInstancePrivateIpAddressList'
          - description: One or more private IP addresses for the replication instance.
        ReplicationInstanceIpv6Addresses:
          allOf:
          - $ref: '#/components/schemas/ReplicationInstanceIpv6AddressList'
          - description: One or more IPv6 addresses for the replication instance.
        PubliclyAccessible:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specifies the accessibility options for the replication instance. A value of <code>true</code> represents an instance with a public IP address. A value of <code>false</code> represents an instance with a private IP address. The default value is <code>true</code>. '
        SecondaryAvailabilityZone:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The Availability Zone of the standby replication instance in a Multi-AZ deployment.
        FreeUntil:
          allOf:
          - $ref: '#/components/schemas/TStamp'
          - description: ' The expiration date of the free replication instance that is part of the Free DMS program. '
        DnsNameServers:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The DNS name servers supported for the replication instance to access your on-premise source or target database.
        NetworkType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
      description: Provides information that defines a replication instance.
    Integer:
      type: integer
    ReplicationInstancePublicIpAddressList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    ReplicationInstanceList:
      type: array
      items:
        $ref: '#/components/schemas/ReplicationInstance'
    DescribeReplicationInstancesResponse:
      type: object
      example:
        Marker: ''
        ReplicationInstances: []
      properties:
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. '
        ReplicationInstances:
          allOf:
          - $ref: '#/components/schemas/ReplicationInstanceList'
          - description: The replication instances described.
      description: <p/>
    VpcSecurityGroupMembership:
      type: object
      properties:
        VpcSecurityGroupId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The VPC security group ID.
        Status:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the VPC security group.
      description: Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.
    DescribeReplicationInstancesMessage:
      type: object
      title: DescribeReplicationInstancesMessage
      properties:
        Filters:
          allOf:
          - $ref: '#/components/schemas/FilterList'
          - description: '<p>Filters applied to replication instances.</p> <p>Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version</p>'
        MaxRecords:
          allOf:
          - $ref: '#/components/schemas/IntegerOptional'
          - description: '<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>'
        Marker:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. '
      description: <p/>
    IntegerOptional:
      type: integer
    String:
      type: string
    Boolean:
      type: boolean
    VpcSecurityGroupMembershipList:
      type: array
      items:
        $ref: '#/components/schemas/VpcSecurityGroupMembership'
    ReplicationInstancePrivateIpAddressList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    ResourceNotFoundFault: {}
    ReplicationSubnetGroup:
      type: object
      properties:
        ReplicationSubnetGroupIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the replication instance subnet group.
        ReplicationSubnetGroupDescription:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A description for the replication subnet group.
        VpcId:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ID of the VPC.
        SubnetGroupStatus:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The status of the subnet group.
        Subnets:
          allOf:
          - $ref: '#/components/schemas/SubnetList'
          - description: The subnets that are in the subnet group.
        SupportedNetworkTypes:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.
      description: Describes a subnet group in response to a request by the <code>DescribeReplicationSubnetGroups</code> operation.
  parameters:
    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
    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
  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