DescribeCertiﬁcates

Provides a description of the certiﬁcate.

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 (p. 364).

The request accepts the following data in JSON format.

Filters (p. 85)

Filters applied to the certiﬁcates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.

Type: Array of Filter (p. 273) objects Required: No

Marker (p. 85)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 85)

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

Default: 10 Type: Integer Required: No

Response Syntax

{

Response Elements

"Certificates": [ {

"CertificateArn": "string", "CertificateCreationDate": number, "CertificateIdentifier": "string", "CertificateOwner": "string", "CertificatePem": "string", "CertificateWallet": blob, "KeyLength": number,

"SigningAlgorithm": "string", "ValidFromDate": number, "ValidToDate": number }

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

Certiﬁcates (p. 85)

The Secure Sockets Layer (SSL) certiﬁcates associated with the replication instance.

Type: Array of Certiﬁcate (p. 250) objects Marker (p. 85)

The pagination token.

Type: String

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

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 (p. 364).

The request accepts the following data in JSON format.

Filters (p. 88)

The ﬁlters applied to the connection.

Valid ﬁlter names: endpoint-arn | replication-instance-arn Type: Array of Filter (p. 273) objects

Required: No Marker (p. 88)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 88)

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer Required: No

Response Syntax

{ "Connections": [ {

"EndpointArn": "string", "EndpointIdentifier": "string", "LastFailureMessage": "string", "ReplicationInstanceArn": "string", "ReplicationInstanceIdentifier": "string", "Status": "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.

Connections (p. 89)

A description of the connections.

Type: Array of Connection (p. 252) objects Marker (p. 89)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeConnections.

Sample Request

POST / HTTP/1.1

Host: dms.<region>.<domain>

See Also

"MaxRecords":0, "Marker":""

}

{ "Connections":[

{

"Status":"successful",

"ReplicationInstanceIdentifier":"akshay1",

"EndpointArn":"arn:aws:dms:us-east-1:123456789012:endpoint:RZZK4EZW5UANC7Y3P4E776WHBE", "EndpointIdentifier":"akssrc1",

"ReplicationInstanceArn":"arn:aws:dms:us-east-1:123456789012:rep:6USOU366XFJUWATDJGBCJS3VIQ"

} ] }

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 (p. 364).

The request accepts the following data in JSON format.

Filters (p. 92)

Filters applied to the endpoints.

Valid ﬁlter names: endpoint-arn | endpoint-type | endpoint-id | engine-name Type: Array of Filter (p. 273) objects

Required: No Marker (p. 92)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 92)

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer Required: No

Response Syntax

{

Response Syntax

"ExternalTableDefinition": "string", "ExtraConnectionAttributes": "string", "GcpMySQLSettings": {

Response Syntax

"SecretsManagerOracleAsmAccessRoleArn": "string", "SecretsManagerOracleAsmSecretId": "string", "SecretsManagerSecretId": "string",

"SecurityDbEncryption": "string", "SecurityDbEncryptionName": "string", "ServerName": "string",

"SpatialDataOptionToGeoJsonFunctionName": "string", "StandbyDelayTime": number,

Response Syntax

"ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string",

Response Elements

"ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string",

"TimestampColumnName": "string", "UseCsvNoSupValue": boolean,

"UseTaskStartTimeForFullLoadTimestamp": boolean },

"ServerName": "string",

"ServiceAccessRoleArn": "string", "SslMode": "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 (p. 92) Endpoint description.

Errors

Type: Array of Endpoint (p. 260) objects Marker (p. 92)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DescribeEndpoints.

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

See Also

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:123456789012:endpoint:SFLP3SJIHID2WOFLWY2OKWKVEE",

"ServerName":"ec2-52-32-48-61.us-west-2.compute.amazonaws.com", "EndpointType":"SOURCE",

"KmsKeyId":"arn:aws:kms:us-east-1:123456789012: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:123456789012:endpoint:TJTJ2JZCIH3CWFR4VC32WEJRU4", "ServerName":"test.oracle.com",

"EndpointType":"SOURCE",

"KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/24021b31-f21c-4a2d-b772-59bce32a9e43",

"DatabaseName":"ORCL", "EngineName":"oracle", "EndpointIdentifier":"test", "Port":1521

} ] }

Request Syntax

{ "EngineName": "string", "Marker": "string", "MaxRecords": number }

Request Parameters

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

The request accepts the following data in JSON format.

EngineName (p. 100)

The databse engine used for your source or target endpoint.

Type: String Required: Yes Marker (p. 100)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 100)

Type: Integer Required: No

Response Syntax

{

"EndpointSettings": [ {

"Applicability": "string", "DefaultValue": "string", "EnumValues": [ "string" ], "IntValueMax": number, "IntValueMin": number,

Response Elements

"Name": "string", "Sensitive": boolean, "Type": "string", "Units": "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.

EndpointSettings (p. 100)

Descriptions of the endpoint settings available for your source or target database engine.

Type: Array of EndpointSetting (p. 266) objects Marker (p. 100)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

Errors

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

Examples

Example

This example illustrates one usage of DescribeEndpointSettings.

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.DescribeEndpointSettings { "Filters":[

{

"Name":"engine-name",

Examples

"MaxRecords":0, "Marker":""

}

"EndpointSettings": [ {

See Also

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DescribeEndpointTypes

Returns information about the type of endpoints available.

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 (p. 364).

The request accepts the following data in JSON format.

Filters (p. 104)

Filters applied to the endpoint types.

Valid ﬁlter names: engine-name | endpoint-type Type: Array of Filter (p. 273) objects

Required: No Marker (p. 104)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 104)

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer Required: No

Response Syntax

{

Response Elements

"Marker": "string",

"SupportedEndpointTypes": [ {

"EndpointType": "string", "EngineDisplayName": "string", "EngineName": "string",

"ReplicationInstanceEngineMinimumVersion": "string", "SupportsCDC": boolean

} ]}

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.

Marker (p. 104)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

SupportedEndpointTypes (p. 104)

The types of endpoints that are supported.

Type: Array of SupportedEndpointType (p. 354) objects

Errors

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

Examples

Example

This example illustrates one usage of DescribeEndpointTypes.

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.DescribeEndpointTypes {

Examples

"MaxRecords":0, "Marker":""

}

"SupportedEndpointTypes": [ {

"EngineDisplayName": "Amazon Aurora MySQL Serverless"

"EngineName": "aurora-postgresql-serverless", "SupportsCDC": true,

"EndpointType": "target",

"EngineDisplayName": "Amazon Aurora PostgreSQL Serverless"

}, {

"EngineName": "docdb", "SupportsCDC": true, "EndpointType": "source",

"ReplicationInstanceEngineMinimumVersion": "3.1.1",

Examples

"EngineDisplayName": "Amazon DocumentDB (with MongoDB compatibility)"

}, {

"EngineName": "docdb", "SupportsCDC": true, "EndpointType": "target",

"ReplicationInstanceEngineMinimumVersion": "3.1.1",

"EngineDisplayName": "Amazon DocumentDB (with MongoDB compatibility)"

"ReplicationInstanceEngineMinimumVersion": "3.1.3", "EngineDisplayName": "Amazon Kinesis"

"ReplicationInstanceEngineMinimumVersion": "3.3.2", "EngineDisplayName": "Amazon Neptune"

"EngineDisplayName": "Amazon OpenSearch Service (successor to Amazon Elasticsearch Service)"

"ReplicationInstanceEngineMinimumVersion": "3.1.1", "EngineDisplayName": "Elasticsearch Service"

Examples

"ReplicationInstanceEngineMinimumVersion": "3.3.1", "EngineDisplayName": "Kafka"

See Also

"ReplicationInstanceEngineMinimumVersion": "3.4.4", "EngineDisplayName": "Redis"

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DescribeEventCategories

Lists categories for all event source types, or, if speciﬁed, for a speciﬁed source type. You can see a list of the event categories and source types in Working with Events and Notiﬁcations in the AWS Database Migration Service User Guide.

Request Syntax

{

"Filters": [ {

"Name": "string", "Values": [ "string" ] }

"SourceType": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

Filters (p. 110)

Filters applied to the event categories.

Type: Array of Filter (p. 273) objects Required: No

SourceType (p. 110)

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-task Type: String

Required: No

Response Syntax

{ "EventCategoryGroupList": [ {

"EventCategories": [ "string" ], "SourceType": "string"

} ]}

Response Elements

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

Errors

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

EventCategoryGroupList (p. 110) A list of event categories.

Type: Array of EventCategoryGroup (p. 270) objects

Errors

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

Request Syntax

{ "Duration": number, "EndTime": number,

"EventCategories": [ "string" ], "Filters": [

{

"Name": "string", "Values": [ "string" ] }

"Marker": "string", "MaxRecords": number,

"SourceIdentifier": "string", "SourceType": "string", "StartTime": number }

Request Parameters

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

The request accepts the following data in JSON format.

Duration (p. 112)

The duration of the events to be listed.

Type: Integer Required: No EndTime (p. 112)

The end time for the events to be listed.

Type: Timestamp Required: No

EventCategories (p. 112)

A list of event categories for the source type that you've chosen.

Type: Array of strings Required: No

Filters (p. 112)

Filters applied to events. The only valid ﬁlter is replication-instance-id.

Type: Array of Filter (p. 273) objects

Response Syntax

Required: No Marker (p. 112)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 112)

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer Required: No SourceIdentiﬁer (p. 112)

The identiﬁer of an event source.

Type: String Required: No SourceType (p. 112)

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-task Type: String

Valid Values: replication-instance Required: No

StartTime (p. 112)

The start time for the events to be listed.

Type: Timestamp Required: No

Response Syntax

{

"Events": [ {

"Date": number,

"EventCategories": [ "string" ], "Message": "string",

"SourceIdentifier": "string", "SourceType": "string"

Response Elements

} ],

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

Events (p. 113)

The events described.

Type: Array of Event (p. 268) objects Marker (p. 113)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

Errors

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

Request Syntax

{

"Filters": [ {

"Name": "string", "Values": [ "string" ] }

"Marker": "string", "MaxRecords": number,

"SubscriptionName": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

Filters (p. 115)

Filters applied to event subscriptions.

Valid ﬁlter names: event-subscription-arn | event-subscription-id Type: Array of Filter (p. 273) objects

Required: No Marker (p. 115)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String Required: No MaxRecords (p. 115)

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Response Syntax

Required: No

SubscriptionName (p. 115)

The name of the AWS DMS event subscription to be described.

Type: String Required: No

Response Syntax

{

"EventSubscriptionsList": [ {

"CustomerAwsId": "string", "CustSubscriptionId": "string", "Enabled": boolean,

"EventCategoriesList": [ "string" ], "SnsTopicArn": "string",

"SourceIdsList": [ "string" ], "SourceType": "string", "Status": "string",

"SubscriptionCreationTime": "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.

EventSubscriptionsList (p. 116)

A list of event subscriptions.

Type: Array of EventSubscription (p. 271) objects Marker (p. 116)

An optional pagination token provided by a previous request. If this parameter is speciﬁed, the response includes only records beyond the marker, up to the value speciﬁed by MaxRecords.

Type: String

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

See Also

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

DescribeOrderableReplicationInstances

Returns information about the replication instance types that can be created in the speciﬁed region.

在文檔中 AWS Database Migration Service (頁 97-180)

DescribeCertiﬁcates