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.CloudWatchEvents.ListConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list of connections from the account.

Synopsis

data ListConnections = ListConnections' {
- connectionState :: Maybe ConnectionState
- limit :: Maybe Natural
- namePrefix :: Maybe Text
- nextToken :: Maybe Text
}
newListConnections :: ListConnections
listConnections_connectionState :: Lens' ListConnections (Maybe ConnectionState)
listConnections_limit :: Lens' ListConnections (Maybe Natural)
listConnections_namePrefix :: Lens' ListConnections (Maybe Text)
listConnections_nextToken :: Lens' ListConnections (Maybe Text)
data ListConnectionsResponse = ListConnectionsResponse' {
- connections :: Maybe [Connection]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListConnectionsResponse :: Int -> ListConnectionsResponse
listConnectionsResponse_connections :: Lens' ListConnectionsResponse (Maybe [Connection])
listConnectionsResponse_nextToken :: Lens' ListConnectionsResponse (Maybe Text)
listConnectionsResponse_httpStatus :: Lens' ListConnectionsResponse Int

Creating a Request

data ListConnections Source #

See: newListConnections smart constructor.

Constructors

ListConnections'
Fields connectionState :: Maybe ConnectionState The state of the connection. limit :: Maybe Natural The maximum number of connections to return. namePrefix :: Maybe Text A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned. nextToken :: Maybe Text The token returned by a previous call to retrieve the next set of results.

Instances

Instances details

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

newListConnections :: ListConnections Source #

Create a value of ListConnections 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:

ListConnections, listConnections_connectionState - The state of the connection.

$sel:limit:ListConnections', listConnections_limit - The maximum number of connections to return.

$sel:namePrefix:ListConnections', listConnections_namePrefix - A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

ListConnections, listConnections_nextToken - The token returned by a previous call to retrieve the next set of results.

Request Lenses

listConnections_connectionState :: Lens' ListConnections (Maybe ConnectionState) Source #

The state of the connection.

listConnections_limit :: Lens' ListConnections (Maybe Natural) Source #

The maximum number of connections to return.

listConnections_namePrefix :: Lens' ListConnections (Maybe Text) Source #

A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.

listConnections_nextToken :: Lens' ListConnections (Maybe Text) Source #

The token returned by a previous call to retrieve the next set of results.

Destructuring the Response

data ListConnectionsResponse Source #

See: newListConnectionsResponse smart constructor.

Constructors

ListConnectionsResponse'
Fields connections :: Maybe [Connection] An array of connections objects that include details about the connections. nextToken :: Maybe Text A token you can use in a subsequent request to retrieve the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections Associated Types type Rep ListConnectionsResponse :: Type -> Type # Methods from :: ListConnectionsResponse -> Rep ListConnectionsResponse x # to :: Rep ListConnectionsResponse x -> ListConnectionsResponse #
Read ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections Methods readsPrec :: Int -> ReadS ListConnectionsResponse # readList :: ReadS [ListConnectionsResponse] # readPrec :: ReadPrec ListConnectionsResponse # readListPrec :: ReadPrec [ListConnectionsResponse] #
Show ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections Methods showsPrec :: Int -> ListConnectionsResponse -> ShowS # show :: ListConnectionsResponse -> String # showList :: [ListConnectionsResponse] -> ShowS #
NFData ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections Methods rnf :: ListConnectionsResponse -> () #
Eq ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections Methods (==) :: ListConnectionsResponse -> ListConnectionsResponse -> Bool # (/=) :: ListConnectionsResponse -> ListConnectionsResponse -> Bool #
type Rep ListConnectionsResponse Source #
Instance details Defined in Amazonka.CloudWatchEvents.ListConnections type Rep ListConnectionsResponse = D1 ('MetaData "ListConnectionsResponse" "Amazonka.CloudWatchEvents.ListConnections" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "ListConnectionsResponse'" '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))))

newListConnectionsResponse Source #

Arguments

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

Create a value of ListConnectionsResponse 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:ListConnectionsResponse', listConnectionsResponse_connections - An array of connections objects that include details about the connections.

ListConnections, listConnectionsResponse_nextToken - A token you can use in a subsequent request to retrieve the next set of results.

$sel:httpStatus:ListConnectionsResponse', listConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

listConnectionsResponse_connections :: Lens' ListConnectionsResponse (Maybe [Connection]) Source #

An array of connections objects that include details about the connections.

listConnectionsResponse_nextToken :: Lens' ListConnectionsResponse (Maybe Text) Source #

A token you can use in a subsequent request to retrieve the next set of results.

listConnectionsResponse_httpStatus :: Lens' ListConnectionsResponse Int Source #

The response's http status code.