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.NetworkManager.GetConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about one or more of your connections in a global network.

This operation returns paginated results.

Synopsis

data GetConnections = GetConnections' {
- connectionIds :: Maybe [Text]
- deviceId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- globalNetworkId :: Text
}
newGetConnections :: Text -> GetConnections
getConnections_connectionIds :: Lens' GetConnections (Maybe [Text])
getConnections_deviceId :: Lens' GetConnections (Maybe Text)
getConnections_maxResults :: Lens' GetConnections (Maybe Natural)
getConnections_nextToken :: Lens' GetConnections (Maybe Text)
getConnections_globalNetworkId :: Lens' GetConnections Text
data GetConnectionsResponse = GetConnectionsResponse' {
- connections :: Maybe [Connection]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetConnectionsResponse :: Int -> GetConnectionsResponse
getConnectionsResponse_connections :: Lens' GetConnectionsResponse (Maybe [Connection])
getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text)
getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int

Creating a Request

data GetConnections Source #

See: newGetConnections smart constructor.

Constructors

GetConnections'
Fields connectionIds :: Maybe [Text] One or more connection IDs. deviceId :: Maybe Text The ID of the device. maxResults :: Maybe Natural The maximum number of results to return. nextToken :: Maybe Text The token for the next page of results. globalNetworkId :: Text The ID of the global network.

Instances

Instances details

ToHeaders GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods toHeaders :: GetConnections -> [Header] #
ToPath GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods toPath :: GetConnections -> ByteString #
ToQuery GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods toQuery :: GetConnections -> QueryString #
AWSPager GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods page :: GetConnections -> AWSResponse GetConnections -> Maybe GetConnections #
AWSRequest GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Associated Types type AWSResponse GetConnections # Methods request :: (Service -> Service) -> GetConnections -> Request GetConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetConnections))) #
Generic GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Associated Types type Rep GetConnections :: Type -> Type # Methods from :: GetConnections -> Rep GetConnections x # to :: Rep GetConnections x -> GetConnections #
Read GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods readsPrec :: Int -> ReadS GetConnections # readList :: ReadS [GetConnections] # readPrec :: ReadPrec GetConnections # readListPrec :: ReadPrec [GetConnections] #
Show GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods showsPrec :: Int -> GetConnections -> ShowS # show :: GetConnections -> String # showList :: [GetConnections] -> ShowS #
NFData GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods rnf :: GetConnections -> () #
Eq GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods (==) :: GetConnections -> GetConnections -> Bool # (/=) :: GetConnections -> GetConnections -> Bool #
Hashable GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections Methods hashWithSalt :: Int -> GetConnections -> Int # hash :: GetConnections -> Int #
type AWSResponse GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections type AWSResponse GetConnections = GetConnectionsResponse
type Rep GetConnections Source #
Instance details Defined in Amazonka.NetworkManager.GetConnections type Rep GetConnections = D1 ('MetaData "GetConnections" "Amazonka.NetworkManager.GetConnections" "amazonka-networkmanager-2.0-4HNcDlBc00x67cUJWWz3sw" 'False) (C1 ('MetaCons "GetConnections'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectionIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "deviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "globalNetworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetConnections Source #

Arguments

:: Text	`GetConnections`
-> GetConnections

Create a value of GetConnections 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:connectionIds:GetConnections', getConnections_connectionIds - One or more connection IDs.

GetConnections, getConnections_deviceId - The ID of the device.

$sel:maxResults:GetConnections', getConnections_maxResults - The maximum number of results to return.

GetConnections, getConnections_nextToken - The token for the next page of results.

GetConnections, getConnections_globalNetworkId - The ID of the global network.

Request Lenses

getConnections_connectionIds :: Lens' GetConnections (Maybe [Text]) Source #

One or more connection IDs.

getConnections_deviceId :: Lens' GetConnections (Maybe Text) Source #

The ID of the device.

getConnections_maxResults :: Lens' GetConnections (Maybe Natural) Source #

The maximum number of results to return.

getConnections_nextToken :: Lens' GetConnections (Maybe Text) Source #

The token for the next page of results.

getConnections_globalNetworkId :: Lens' GetConnections Text Source #

The ID of the global network.

Destructuring the Response

data GetConnectionsResponse Source #

See: newGetConnectionsResponse smart constructor.

Constructors

GetConnectionsResponse'
Fields connections :: Maybe [Connection] Information about the connections. nextToken :: Maybe Text The token to use for the next page of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetConnectionsResponse Source #

Arguments

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

Create a value of GetConnectionsResponse 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:connections:GetConnectionsResponse', getConnectionsResponse_connections - Information about the connections.

GetConnections, getConnectionsResponse_nextToken - The token to use for the next page of results.

$sel:httpStatus:GetConnectionsResponse', getConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

getConnectionsResponse_connections :: Lens' GetConnectionsResponse (Maybe [Connection]) Source #

Information about the connections.

getConnectionsResponse_nextToken :: Lens' GetConnectionsResponse (Maybe Text) Source #

The token to use for the next page of results.

getConnectionsResponse_httpStatus :: Lens' GetConnectionsResponse Int Source #

The response's http status code.