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.Outposts.StartConnection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Amazon Web Services uses this action to install Outpost servers.

Starts the connection required for Outpost server installation.

Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see Amazon Web Services managed policies for Amazon Web Services Outposts and Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail in the Amazon Web Services Outposts User Guide.

Synopsis

data StartConnection = StartConnection' {
- deviceSerialNumber :: Text
- assetId :: Text
- clientPublicKey :: Text
- networkInterfaceDeviceIndex :: Natural
}
newStartConnection :: Text -> Text -> Text -> Natural -> StartConnection
startConnection_deviceSerialNumber :: Lens' StartConnection Text
startConnection_assetId :: Lens' StartConnection Text
startConnection_clientPublicKey :: Lens' StartConnection Text
startConnection_networkInterfaceDeviceIndex :: Lens' StartConnection Natural
data StartConnectionResponse = StartConnectionResponse' {
- connectionId :: Maybe Text
- underlayIpAddress :: Maybe Text
- httpStatus :: Int
}
newStartConnectionResponse :: Int -> StartConnectionResponse
startConnectionResponse_connectionId :: Lens' StartConnectionResponse (Maybe Text)
startConnectionResponse_underlayIpAddress :: Lens' StartConnectionResponse (Maybe Text)
startConnectionResponse_httpStatus :: Lens' StartConnectionResponse Int

Creating a Request

data StartConnection Source #

See: newStartConnection smart constructor.

Constructors

StartConnection'
Fields deviceSerialNumber :: Text The serial number of the dongle. assetId :: Text The ID of the Outpost server. clientPublicKey :: Text The public key of the client. networkInterfaceDeviceIndex :: Natural The device index of the network interface on the Outpost server.

Instances

Instances details

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

newStartConnection Source #

Arguments

:: Text	`$sel:deviceSerialNumber:StartConnection'`
-> Text	`StartConnection`
-> Text	`StartConnection`
-> Natural	`$sel:networkInterfaceDeviceIndex:StartConnection'`
-> StartConnection

Create a value of StartConnection 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:deviceSerialNumber:StartConnection', startConnection_deviceSerialNumber - The serial number of the dongle.

StartConnection, startConnection_assetId - The ID of the Outpost server.

StartConnection, startConnection_clientPublicKey - The public key of the client.

$sel:networkInterfaceDeviceIndex:StartConnection', startConnection_networkInterfaceDeviceIndex - The device index of the network interface on the Outpost server.

Request Lenses

startConnection_deviceSerialNumber :: Lens' StartConnection Text Source #

The serial number of the dongle.

startConnection_assetId :: Lens' StartConnection Text Source #

The ID of the Outpost server.

startConnection_clientPublicKey :: Lens' StartConnection Text Source #

The public key of the client.

startConnection_networkInterfaceDeviceIndex :: Lens' StartConnection Natural Source #

The device index of the network interface on the Outpost server.

Destructuring the Response

data StartConnectionResponse Source #

See: newStartConnectionResponse smart constructor.

Constructors

StartConnectionResponse'
Fields connectionId :: Maybe Text The ID of the connection. underlayIpAddress :: Maybe Text The underlay IP address. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection Associated Types type Rep StartConnectionResponse :: Type -> Type # Methods from :: StartConnectionResponse -> Rep StartConnectionResponse x # to :: Rep StartConnectionResponse x -> StartConnectionResponse #
Read StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection Methods readsPrec :: Int -> ReadS StartConnectionResponse # readList :: ReadS [StartConnectionResponse] # readPrec :: ReadPrec StartConnectionResponse # readListPrec :: ReadPrec [StartConnectionResponse] #
Show StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection Methods showsPrec :: Int -> StartConnectionResponse -> ShowS # show :: StartConnectionResponse -> String # showList :: [StartConnectionResponse] -> ShowS #
NFData StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection Methods rnf :: StartConnectionResponse -> () #
Eq StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection Methods (==) :: StartConnectionResponse -> StartConnectionResponse -> Bool # (/=) :: StartConnectionResponse -> StartConnectionResponse -> Bool #
type Rep StartConnectionResponse Source #
Instance details Defined in Amazonka.Outposts.StartConnection type Rep StartConnectionResponse = D1 ('MetaData "StartConnectionResponse" "Amazonka.Outposts.StartConnection" "amazonka-outposts-2.0-7IMF8shlTNW2uMOjzEu2r2" 'False) (C1 ('MetaCons "StartConnectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "underlayIpAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartConnectionResponse Source #

Arguments

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

Create a value of StartConnectionResponse 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:connectionId:StartConnectionResponse', startConnectionResponse_connectionId - The ID of the connection.

$sel:underlayIpAddress:StartConnectionResponse', startConnectionResponse_underlayIpAddress - The underlay IP address.

$sel:httpStatus:StartConnectionResponse', startConnectionResponse_httpStatus - The response's http status code.

Response Lenses

startConnectionResponse_connectionId :: Lens' StartConnectionResponse (Maybe Text) Source #

The ID of the connection.

startConnectionResponse_underlayIpAddress :: Lens' StartConnectionResponse (Maybe Text) Source #

The underlay IP address.

startConnectionResponse_httpStatus :: Lens' StartConnectionResponse Int Source #

The response's http status code.