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.ListHosts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the hosts associated with your account.

Synopsis

data ListHosts = ListHosts' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListHosts :: ListHosts
listHosts_maxResults :: Lens' ListHosts (Maybe Natural)
listHosts_nextToken :: Lens' ListHosts (Maybe Text)
data ListHostsResponse = ListHostsResponse' {
- hosts :: Maybe [Host]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListHostsResponse :: Int -> ListHostsResponse
listHostsResponse_hosts :: Lens' ListHostsResponse (Maybe [Host])
listHostsResponse_nextToken :: Lens' ListHostsResponse (Maybe Text)
listHostsResponse_httpStatus :: Lens' ListHostsResponse Int

Creating a Request

data ListHosts Source #

See: newListHosts smart constructor.

Constructors

ListHosts'
Fields 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 `ListHosts` call, which can be used to return the next set of hosts in the list.

Instances

Instances details

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

newListHosts :: ListHosts Source #

Create a value of ListHosts 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:maxResults:ListHosts', listHosts_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.

ListHosts, listHosts_nextToken - The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

Request Lenses

listHosts_maxResults :: Lens' ListHosts (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.

listHosts_nextToken :: Lens' ListHosts (Maybe Text) Source #

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

Destructuring the Response

data ListHostsResponse Source #

See: newListHostsResponse smart constructor.

Constructors

ListHostsResponse'
Fields hosts :: Maybe [Host] A list of hosts and the details for each host, such as status, endpoint, and provider type. nextToken :: Maybe Text A token that can be used in the next `ListHosts` 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 ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts Associated Types type Rep ListHostsResponse :: Type -> Type # Methods from :: ListHostsResponse -> Rep ListHostsResponse x # to :: Rep ListHostsResponse x -> ListHostsResponse #
Read ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts Methods readsPrec :: Int -> ReadS ListHostsResponse # readList :: ReadS [ListHostsResponse] # readPrec :: ReadPrec ListHostsResponse # readListPrec :: ReadPrec [ListHostsResponse] #
Show ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts Methods showsPrec :: Int -> ListHostsResponse -> ShowS # show :: ListHostsResponse -> String # showList :: [ListHostsResponse] -> ShowS #
NFData ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts Methods rnf :: ListHostsResponse -> () #
Eq ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts Methods (==) :: ListHostsResponse -> ListHostsResponse -> Bool # (/=) :: ListHostsResponse -> ListHostsResponse -> Bool #
type Rep ListHostsResponse Source #
Instance details Defined in Amazonka.CodeStarConnections.ListHosts type Rep ListHostsResponse = D1 ('MetaData "ListHostsResponse" "Amazonka.CodeStarConnections.ListHosts" "amazonka-codestar-connections-2.0-JfXvFjuvjBh3smH2VU30JL" 'False) (C1 ('MetaCons "ListHostsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hosts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Host])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListHostsResponse Source #

Arguments

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

Create a value of ListHostsResponse 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:hosts:ListHostsResponse', listHostsResponse_hosts - A list of hosts and the details for each host, such as status, endpoint, and provider type.

ListHosts, listHostsResponse_nextToken - A token that can be used in the next ListHosts 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:ListHostsResponse', listHostsResponse_httpStatus - The response's http status code.

Response Lenses

listHostsResponse_hosts :: Lens' ListHostsResponse (Maybe [Host]) Source #

A list of hosts and the details for each host, such as status, endpoint, and provider type.

listHostsResponse_nextToken :: Lens' ListHostsResponse (Maybe Text) Source #

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

listHostsResponse_httpStatus :: Lens' ListHostsResponse Int Source #

The response's http status code.