Menu
AWS Database Migration Service
API Reference (API Version 2016-01-01)

DescribeEndpoints

Returns information about the endpoints for your account in the current region.

Request Syntax

{
   "Filters": [ 
      { 
         "Name": "string",
         "Values": [ "string" ]
      }
   ],
   "Marker": "string",
   "MaxRecords": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filters

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

Type: Array of Filter objects

Required: No

Marker

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 MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Syntax

{
   "Endpoints": [ 
      { 
         "CertificateArn": "string",
         "DatabaseName": "string",
         "DynamoDbSettings": { 
            "ServiceAccessRoleArn": "string"
         },
         "EndpointArn": "string",
         "EndpointIdentifier": "string",
         "EndpointType": "string",
         "EngineName": "string",
         "ExternalId": "string",
         "ExtraConnectionAttributes": "string",
         "KmsKeyId": "string",
         "MongoDbSettings": { 
            "AuthMechanism": "string",
            "AuthSource": "string",
            "AuthType": "string",
            "DatabaseName": "string",
            "DocsToInvestigate": "string",
            "ExtractDocId": "string",
            "NestingLevel": "string",
            "Password": "string",
            "Port": number,
            "ServerName": "string",
            "Username": "string"
         },
         "Port": number,
         "S3Settings": { 
            "BucketFolder": "string",
            "BucketName": "string",
            "CompressionType": "string",
            "CsvDelimiter": "string",
            "CsvRowDelimiter": "string",
            "ExternalTableDefinition": "string",
            "ServiceAccessRoleArn": "string"
         },
         "ServerName": "string",
         "SslMode": "string",
         "Status": "string",
         "Username": "string"
      }
   ],
   "Marker": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Endpoints

Endpoint description.

Type: Array of Endpoint objects

Marker

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 MaxRecords.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Example

Sample Request

   
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 
Credential=<Credential>, 
SignedHeaders=contenttype;date;host;user-
agent;x-amz-date;x-amz-target;x-amzn-
requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.DescribeEndpoints
{
   "Filters":[
      {
         "Name":"endpoint-type",
         "Values":[
            "source"
         ]
      }
   ],
   "MaxRecords":0,
   "Marker":""
}
 

Sample Response


 HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
   "Endpoints":[
      {
         "Username":"dms",
         "Status":"active",
         "EndpointArn":"arn:aws:dms:us-east-
1:152683116123:endpoint:SFLP3SJIHID2WOFLWY2OKWKVEE",
         "ServerName":"ec2-52-32-48-61.us-west-2.compute.amazonaws.com",
         "EndpointType":"SOURCE",
         "KmsKeyId":"arn:aws:kms:us-east-1:152683116123:key/945c4e7d-
4ec4-44be-b58a-c8a7adf57dcd",
         "DatabaseName":"sbtest",
         "EngineName":"mysql",
         "EndpointIdentifier":"pri100",
         "Port":8193
      },
      {
         "Username":"admin",
         "Status":"active",
         "EndpointArn":"arn:aws:dms:us-east-
1:152683116123:endpoint:TJTJ2JZCIH3CWFR4VC32WEJRU4",
         "ServerName":"test.oracle.com",
         "EndpointType":"SOURCE",
         "KmsKeyId":"arn:aws:kms:us-east-1:152683116123:key/24021b31-
f21c-4a2d-b772-59bce32a9e43",
         "DatabaseName":"ORCL",
         "EngineName":"oracle",
         "EndpointIdentifier":"test",
         "Port":1521
      }
   ]
}
    
 

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: