Amazonka.AlexaBusiness.ListGateways

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

Creating a Request

data ListGateways

See: newListGateways smart constructor.

Constructors

ListGateways'

Fields

• gatewayGroupArn :: Maybe Text

  The gateway group ARN for which to list gateways.

• maxResults :: Maybe Natural

  The maximum number of gateway summaries to return. The default is 50.

• nextToken :: Maybe Text

  The token used to paginate though multiple pages of gateway summaries.

Instances

ToJSON ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

toJSON :: ListGateways -> Value

toEncoding :: ListGateways -> Encoding

toJSONList :: [ListGateways] -> Value

toEncodingList :: [ListGateways] -> Encoding

ToHeaders ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

toHeaders :: ListGateways -> [Header]

ToPath ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

toPath :: ListGateways -> ByteString

ToQuery ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

toQuery :: ListGateways -> QueryString

AWSRequest ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Associated Types

type AWSResponse ListGateways

Methods

request :: (Service -> Service) -> ListGateways -> Request ListGateways

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGateways -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGateways)))

Generic ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Associated Types

type Rep ListGateways :: Type -> Type

Methods

from :: ListGateways -> Rep ListGateways x

to :: Rep ListGateways x -> ListGateways

Read ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

readsPrec :: Int -> ReadS ListGateways

readList :: ReadS [ListGateways]

readPrec :: ReadPrec ListGateways

readListPrec :: ReadPrec [ListGateways]

Show ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

showsPrec :: Int -> ListGateways -> ShowS

show :: ListGateways -> String

showList :: [ListGateways] -> ShowS

NFData ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

rnf :: ListGateways -> ()

Eq ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

(==) :: ListGateways -> ListGateways -> Bool

(/=) :: ListGateways -> ListGateways -> Bool

Hashable ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

hashWithSalt :: Int -> ListGateways -> Int

hash :: ListGateways -> Int

type AWSResponse ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

type AWSResponse ListGateways = ListGatewaysResponse

type Rep ListGateways

Defined in Amazonka.AlexaBusiness.ListGateways

type Rep ListGateways = D1 ('MetaData "ListGateways" "Amazonka.AlexaBusiness.ListGateways" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ListGateways'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gatewayGroupArn") '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)))))

newListGateways :: ListGateways

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

ListGateways, listGateways_gatewayGroupArn - The gateway group ARN for which to list gateways.

$sel:maxResults:ListGateways', listGateways_maxResults - The maximum number of gateway summaries to return. The default is 50.

ListGateways, listGateways_nextToken - The token used to paginate though multiple pages of gateway summaries.

Request Lenses

listGateways_gatewayGroupArn :: Lens' ListGateways (Maybe Text)

The gateway group ARN for which to list gateways.

listGateways_maxResults :: Lens' ListGateways (Maybe Natural)

The maximum number of gateway summaries to return. The default is 50.

listGateways_nextToken :: Lens' ListGateways (Maybe Text)

The token used to paginate though multiple pages of gateway summaries.

Destructuring the Response

data ListGatewaysResponse

See: newListGatewaysResponse smart constructor.

Constructors

ListGatewaysResponse'

Fields

• gateways :: Maybe [GatewaySummary]

  The gateways in the list.

• nextToken :: Maybe Text

  The token used to paginate though multiple pages of gateway summaries.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

Associated Types

type Rep ListGatewaysResponse :: Type -> Type

Methods

from :: ListGatewaysResponse -> Rep ListGatewaysResponse x

to :: Rep ListGatewaysResponse x -> ListGatewaysResponse

Read ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

readsPrec :: Int -> ReadS ListGatewaysResponse

readList :: ReadS [ListGatewaysResponse]

readPrec :: ReadPrec ListGatewaysResponse

readListPrec :: ReadPrec [ListGatewaysResponse]

Show ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

showsPrec :: Int -> ListGatewaysResponse -> ShowS

show :: ListGatewaysResponse -> String

showList :: [ListGatewaysResponse] -> ShowS

NFData ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

rnf :: ListGatewaysResponse -> ()

Eq ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

Methods

(==) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool

(/=) :: ListGatewaysResponse -> ListGatewaysResponse -> Bool

type Rep ListGatewaysResponse

Defined in Amazonka.AlexaBusiness.ListGateways

type Rep ListGatewaysResponse = D1 ('MetaData "ListGatewaysResponse" "Amazonka.AlexaBusiness.ListGateways" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "ListGatewaysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gateways") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GatewaySummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGatewaysResponse

Arguments

:: Int

$sel:httpStatus:ListGatewaysResponse'

-> ListGatewaysResponse

Create a value of ListGatewaysResponse 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:gateways:ListGatewaysResponse', listGatewaysResponse_gateways - The gateways in the list.

ListGateways, listGatewaysResponse_nextToken - The token used to paginate though multiple pages of gateway summaries.

$sel:httpStatus:ListGatewaysResponse', listGatewaysResponse_httpStatus - The response's http status code.

Response Lenses

listGatewaysResponse_gateways :: Lens' ListGatewaysResponse (Maybe [GatewaySummary])

The gateways in the list.

listGatewaysResponse_nextToken :: Lens' ListGatewaysResponse (Maybe Text)

The token used to paginate though multiple pages of gateway summaries.

listGatewaysResponse_httpStatus :: Lens' ListGatewaysResponse Int

The response's http status code.