amazonka-codestar-connections-2.0: Amazon CodeStar connections SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeStarConnections.ListHosts

Description

Lists the hosts associated with your account.

Synopsis

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

ToHeaders ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Methods

toHeaders :: ListHosts -> [Header] #

ToPath ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

ToQuery ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

AWSRequest ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Associated Types

type AWSResponse ListHosts #

Generic ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Associated Types

type Rep ListHosts :: Type -> Type #

Read ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Show ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

NFData ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Methods

rnf :: ListHosts -> () #

Eq ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Hashable ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

type AWSResponse ListHosts Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

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 #

Read ListHostsResponse Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Show ListHostsResponse Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

NFData ListHostsResponse Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

Methods

rnf :: ListHostsResponse -> () #

Eq ListHostsResponse Source # 
Instance details

Defined in Amazonka.CodeStarConnections.ListHosts

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 #

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.