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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the connections associated with your account.

Synopsis

data ListConnections = ListConnections' {
- hostArnFilter :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- providerTypeFilter :: Maybe ProviderType
}
newListConnections :: ListConnections
listConnections_hostArnFilter :: Lens' ListConnections (Maybe Text)
listConnections_maxResults :: Lens' ListConnections (Maybe Natural)
listConnections_nextToken :: Lens' ListConnections (Maybe Text)
listConnections_providerTypeFilter :: Lens' ListConnections (Maybe ProviderType)
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

hostArnFilter :: Maybe Text
Filters the list of connections to those associated with a specified host.
maxResults :: Maybe Natural
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken :: Maybe Text
The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.
providerTypeFilter :: Maybe ProviderType
Filters the list of connections to those associated with a specified provider, such as Bitbucket.

Instances

Instances details

ToJSON ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods toJSON :: ListConnections -> Value # toEncoding :: ListConnections -> Encoding # toJSONList :: [ListConnections] -> Value # toEncodingList :: [ListConnections] -> Encoding #
ToHeaders ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods toHeaders :: ListConnections -> [Header] #
ToPath ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods toPath :: ListConnections -> ByteString #
ToQuery ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods toQuery :: ListConnections -> QueryString #
AWSRequest ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.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.CodeStarConnections.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.CodeStarConnections.ListConnections Methods readsPrec :: Int -> ReadS ListConnections # readList :: ReadS [ListConnections] # readPrec :: ReadPrec ListConnections # readListPrec :: ReadPrec [ListConnections] #
Show ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods showsPrec :: Int -> ListConnections -> ShowS # show :: ListConnections -> String # showList :: [ListConnections] -> ShowS #
NFData ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods rnf :: ListConnections -> () #
Eq ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods (==) :: ListConnections -> ListConnections -> Bool # (/=) :: ListConnections -> ListConnections -> Bool #
Hashable ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods hashWithSalt :: Int -> ListConnections -> Int # hash :: ListConnections -> Int #
type AWSResponse ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections type AWSResponse ListConnections = ListConnectionsResponse
type Rep ListConnections Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections type Rep ListConnections = D1 ('MetaData "ListConnections" "Amazonka.CodeStarConnections.ListConnections" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "ListConnections'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hostArnFilter") '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 "providerTypeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProviderType)))))

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:

$sel:hostArnFilter:ListConnections', listConnections_hostArnFilter - Filters the list of connections to those associated with a specified host.

$sel:maxResults:ListConnections', listConnections_maxResults - The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

ListConnections, listConnections_nextToken - The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

$sel:providerTypeFilter:ListConnections', listConnections_providerTypeFilter - Filters the list of connections to those associated with a specified provider, such as Bitbucket.

Request Lenses

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

Filters the list of connections to those associated with a specified host.

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

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

listConnections_providerTypeFilter :: Lens' ListConnections (Maybe ProviderType) Source #

Filters the list of connections to those associated with a specified provider, such as Bitbucket.

Destructuring the Response

data ListConnectionsResponse Source #

See: newListConnectionsResponse smart constructor.

Constructors

ListConnectionsResponse'

Fields

connections :: Maybe [Connection]
A list of connections and the details for each connection, such as status, owner, and provider type.
nextToken :: Maybe Text
A token that can be used in the next ListConnections call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListConnectionsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.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.CodeStarConnections.ListConnections Methods readsPrec :: Int -> ReadS ListConnectionsResponse # readList :: ReadS [ListConnectionsResponse] # readPrec :: ReadPrec ListConnectionsResponse # readListPrec :: ReadPrec [ListConnectionsResponse] #
Show ListConnectionsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods showsPrec :: Int -> ListConnectionsResponse -> ShowS # show :: ListConnectionsResponse -> String # showList :: [ListConnectionsResponse] -> ShowS #
NFData ListConnectionsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods rnf :: ListConnectionsResponse -> () #
Eq ListConnectionsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections Methods (==) :: ListConnectionsResponse -> ListConnectionsResponse -> Bool # (/=) :: ListConnectionsResponse -> ListConnectionsResponse -> Bool #
type Rep ListConnectionsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListConnections type Rep ListConnectionsResponse = D1 ('MetaData "ListConnectionsResponse" "Amazonka.CodeStarConnections.ListConnections" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" '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 - A list of connections and the details for each connection, such as status, owner, and provider type.

ListConnections, listConnectionsResponse_nextToken - A token that can be used in the next ListConnections call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

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

Response Lenses

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

A list of connections and the details for each connection, such as status, owner, and provider type.

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

A token that can be used in the next ListConnections call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

listConnectionsResponse_httpStatus :: Lens' ListConnectionsResponse Int Source #

The response's http status code.