openapi: 3.0.0
info:
version: 2016-01-01
x-release: v4
title: 'AWS Database Migration Service Endpoints #X Amz Target=AmazonDMSv20160101.DescribeRefreshSchemasStatus API'
description:
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.
For more information about DMS, see What Is Database Migration Service? in the Database Migration Service User Guide.
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.DescribeRefreshSchemasStatus' paths: /#X-Amz-Target=AmazonDMSv20160101.DescribeRefreshSchemasStatus: 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: DescribeRefreshSchemasStatus description: Returns the status of the RefreshSchemas operation. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRefreshSchemasStatusResponse' '480': description: InvalidResourceStateFault content: application/json: schema: $ref: '#/components/schemas/InvalidResourceStateFault' '481': description: ResourceNotFoundFault content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundFault' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeRefreshSchemasStatusMessage' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AmazonDMSv20160101.DescribeRefreshSchemasStatus tags: - '#X Amz Target=AmazonDMSv20160101.DescribeRefreshSchemasStatus' components: schemas: InvalidResourceStateFault: {} String: type: string DescribeRefreshSchemasStatusResponse: type: object example: RefreshSchemasStatus: {} properties: RefreshSchemasStatus: allOf: - $ref: '#/components/schemas/RefreshSchemasStatus' - description: The status of the schema. description: RefreshSchemasStatus: type: object properties: EndpointArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint. ReplicationInstanceArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the replication instance. Status: allOf: - $ref: '#/components/schemas/RefreshSchemasStatusTypeValue' - description: The status of the schema. LastRefreshDate: allOf: - $ref: '#/components/schemas/TStamp' - description: The date the schema was last refreshed. LastFailureMessage: allOf: - $ref: '#/components/schemas/String' - description: The last failure message for the schema. description: Provides information that describes status of a schema at an endpoint specified by theDescribeRefreshSchemaStatus operation.
TStamp:
type: string
format: date-time
ResourceNotFoundFault: {}
DescribeRefreshSchemasStatusMessage:
type: object
required:
- EndpointArn
title: DescribeRefreshSchemasStatusMessage
properties:
EndpointArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
description:
RefreshSchemasStatusTypeValue:
type: string
enum:
- successful
- failed
- refreshing
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