Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.TestConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Tests the connection between the replication instance and the endpoint.

Creating a Request

data TestConnection Source #

See: newTestConnection smart constructor.

Constructors

TestConnection'
Fields replicationInstanceArn :: Text The Amazon Resource Name (ARN) of the replication instance. endpointArn :: Text The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Instances

Instances details

ToJSON TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods toJSON :: TestConnection -> Value # toEncoding :: TestConnection -> Encoding # toJSONList :: [TestConnection] -> Value # toEncodingList :: [TestConnection] -> Encoding #
ToHeaders TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods toHeaders :: TestConnection -> [Header] #
ToPath TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods toPath :: TestConnection -> ByteString #
ToQuery TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods toQuery :: TestConnection -> QueryString #
AWSRequest TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Associated Types type AWSResponse TestConnection # Methods request :: (Service -> Service) -> TestConnection -> Request TestConnection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestConnection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestConnection))) #
Generic TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Associated Types type Rep TestConnection :: Type -> Type # Methods from :: TestConnection -> Rep TestConnection x # to :: Rep TestConnection x -> TestConnection #
Read TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods readsPrec :: Int -> ReadS TestConnection # readList :: ReadS [TestConnection] # readPrec :: ReadPrec TestConnection # readListPrec :: ReadPrec [TestConnection] #
Show TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods showsPrec :: Int -> TestConnection -> ShowS # show :: TestConnection -> String # showList :: [TestConnection] -> ShowS #
NFData TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods rnf :: TestConnection -> () #
Eq TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods (==) :: TestConnection -> TestConnection -> Bool # (/=) :: TestConnection -> TestConnection -> Bool #
Hashable TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods hashWithSalt :: Int -> TestConnection -> Int # hash :: TestConnection -> Int #
type AWSResponse TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection type AWSResponse TestConnection = TestConnectionResponse
type Rep TestConnection Source #
Instance details Defined in Amazonka.DMS.TestConnection type Rep TestConnection = D1 ('MetaData "TestConnection" "Amazonka.DMS.TestConnection" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "TestConnection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endpointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newTestConnection Source #

Arguments

:: Text	`TestConnection`
-> Text	`TestConnection`
-> TestConnection

Create a value of TestConnection with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TestConnection, testConnection_replicationInstanceArn - The Amazon Resource Name (ARN) of the replication instance.

TestConnection, testConnection_endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Request Lenses

testConnection_replicationInstanceArn :: Lens' TestConnection Text Source #

The Amazon Resource Name (ARN) of the replication instance.

testConnection_endpointArn :: Lens' TestConnection Text Source #

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Destructuring the Response

data TestConnectionResponse Source #

See: newTestConnectionResponse smart constructor.

Constructors

TestConnectionResponse'
Fields connection :: Maybe Connection The connection tested. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection Associated Types type Rep TestConnectionResponse :: Type -> Type # Methods from :: TestConnectionResponse -> Rep TestConnectionResponse x # to :: Rep TestConnectionResponse x -> TestConnectionResponse #
Read TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods readsPrec :: Int -> ReadS TestConnectionResponse # readList :: ReadS [TestConnectionResponse] # readPrec :: ReadPrec TestConnectionResponse # readListPrec :: ReadPrec [TestConnectionResponse] #
Show TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods showsPrec :: Int -> TestConnectionResponse -> ShowS # show :: TestConnectionResponse -> String # showList :: [TestConnectionResponse] -> ShowS #
NFData TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods rnf :: TestConnectionResponse -> () #
Eq TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection Methods (==) :: TestConnectionResponse -> TestConnectionResponse -> Bool # (/=) :: TestConnectionResponse -> TestConnectionResponse -> Bool #
type Rep TestConnectionResponse Source #
Instance details Defined in Amazonka.DMS.TestConnection type Rep TestConnectionResponse = D1 ('MetaData "TestConnectionResponse" "Amazonka.DMS.TestConnection" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "TestConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Connection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTestConnectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestConnectionResponse'`
-> TestConnectionResponse

Create a value of TestConnectionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:connection:TestConnectionResponse', testConnectionResponse_connection - The connection tested.

$sel:httpStatus:TestConnectionResponse', testConnectionResponse_httpStatus - The response's http status code.

Response Lenses

testConnectionResponse_connection :: Lens' TestConnectionResponse (Maybe Connection) Source #

The connection tested.

testConnectionResponse_httpStatus :: Lens' TestConnectionResponse Int Source #

The response's http status code.