Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GreengrassV2.ListCoreDevices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a paginated list of Greengrass core devices.

This operation returns paginated results.

Synopsis

data ListCoreDevices = ListCoreDevices' {
- status :: Maybe CoreDeviceStatus
- thingGroupArn :: Maybe Text
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newListCoreDevices :: ListCoreDevices
listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus)
listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text)
listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text)
listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural)
data ListCoreDevicesResponse = ListCoreDevicesResponse' {
- nextToken :: Maybe Text
- coreDevices :: Maybe [CoreDevice]
- httpStatus :: Int
}
newListCoreDevicesResponse :: Int -> ListCoreDevicesResponse
listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text)
listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice])
listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int

Creating a Request

data ListCoreDevices Source #

See: newListCoreDevices smart constructor.

Constructors

ListCoreDevices'

Fields

status :: Maybe CoreDeviceStatus
The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
- HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
- UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
thingGroupArn :: Maybe Text
The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
maxResults :: Maybe Natural
The maximum number of results to be returned per paginated request.

Instances

Instances details

Eq ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods (==) :: ListCoreDevices -> ListCoreDevices -> Bool # (/=) :: ListCoreDevices -> ListCoreDevices -> Bool #
Read ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods readsPrec :: Int -> ReadS ListCoreDevices # readList :: ReadS [ListCoreDevices] # readPrec :: ReadPrec ListCoreDevices # readListPrec :: ReadPrec [ListCoreDevices] #
Show ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods showsPrec :: Int -> ListCoreDevices -> ShowS # show :: ListCoreDevices -> String # showList :: [ListCoreDevices] -> ShowS #
Generic ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Associated Types type Rep ListCoreDevices :: Type -> Type # Methods from :: ListCoreDevices -> Rep ListCoreDevices x # to :: Rep ListCoreDevices x -> ListCoreDevices #
NFData ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods rnf :: ListCoreDevices -> () #
Hashable ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods hashWithSalt :: Int -> ListCoreDevices -> Int # hash :: ListCoreDevices -> Int #
AWSPager ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods page :: ListCoreDevices -> AWSResponse ListCoreDevices -> Maybe ListCoreDevices #
AWSRequest ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Associated Types type AWSResponse ListCoreDevices # Methods request :: ListCoreDevices -> Request ListCoreDevices # response :: MonadResource m => Logger -> Service -> Proxy ListCoreDevices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCoreDevices))) #
ToHeaders ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods toHeaders :: ListCoreDevices -> [Header] #
ToPath ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods toPath :: ListCoreDevices -> ByteString #
ToQuery ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods toQuery :: ListCoreDevices -> QueryString #
type Rep ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices type Rep ListCoreDevices = D1 ('MetaData "ListCoreDevices" "Amazonka.GreengrassV2.ListCoreDevices" "libZSservicesZSamazonka-greengrassv2ZSamazonka-greengrassv2" 'False) (C1 ('MetaCons "ListCoreDevices'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CoreDeviceStatus)) :: S1 ('MetaSel ('Just "thingGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListCoreDevices Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices type AWSResponse ListCoreDevices = ListCoreDevicesResponse

newListCoreDevices :: ListCoreDevices Source #

Create a value of ListCoreDevices 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:status:ListCoreDevices', listCoreDevices_status - The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

$sel:thingGroupArn:ListCoreDevices', listCoreDevices_thingGroupArn - The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.

$sel:nextToken:ListCoreDevices', listCoreDevices_nextToken - The token to be used for the next set of paginated results.

$sel:maxResults:ListCoreDevices', listCoreDevices_maxResults - The maximum number of results to be returned per paginated request.

Request Lenses

listCoreDevices_status :: Lens' ListCoreDevices (Maybe CoreDeviceStatus) Source #

The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

listCoreDevices_thingGroupArn :: Lens' ListCoreDevices (Maybe Text) Source #

The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that are members of this thing group.

listCoreDevices_nextToken :: Lens' ListCoreDevices (Maybe Text) Source #

The token to be used for the next set of paginated results.

listCoreDevices_maxResults :: Lens' ListCoreDevices (Maybe Natural) Source #

The maximum number of results to be returned per paginated request.

Destructuring the Response

data ListCoreDevicesResponse Source #

See: newListCoreDevicesResponse smart constructor.

Constructors

ListCoreDevicesResponse'
Fields nextToken :: Maybe Text The token for the next set of results, or null if there are no additional results. coreDevices :: Maybe [CoreDevice] A list that summarizes each core device. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods (==) :: ListCoreDevicesResponse -> ListCoreDevicesResponse -> Bool # (/=) :: ListCoreDevicesResponse -> ListCoreDevicesResponse -> Bool #
Read ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods readsPrec :: Int -> ReadS ListCoreDevicesResponse # readList :: ReadS [ListCoreDevicesResponse] # readPrec :: ReadPrec ListCoreDevicesResponse # readListPrec :: ReadPrec [ListCoreDevicesResponse] #
Show ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods showsPrec :: Int -> ListCoreDevicesResponse -> ShowS # show :: ListCoreDevicesResponse -> String # showList :: [ListCoreDevicesResponse] -> ShowS #
Generic ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Associated Types type Rep ListCoreDevicesResponse :: Type -> Type # Methods from :: ListCoreDevicesResponse -> Rep ListCoreDevicesResponse x # to :: Rep ListCoreDevicesResponse x -> ListCoreDevicesResponse #
NFData ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices Methods rnf :: ListCoreDevicesResponse -> () #
type Rep ListCoreDevicesResponse Source #
Instance details Defined in Amazonka.GreengrassV2.ListCoreDevices type Rep ListCoreDevicesResponse = D1 ('MetaData "ListCoreDevicesResponse" "Amazonka.GreengrassV2.ListCoreDevices" "libZSservicesZSamazonka-greengrassv2ZSamazonka-greengrassv2" 'False) (C1 ('MetaCons "ListCoreDevicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "coreDevices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CoreDevice])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCoreDevicesResponse Source #

Arguments

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

Create a value of ListCoreDevicesResponse 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:nextToken:ListCoreDevices', listCoreDevicesResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:coreDevices:ListCoreDevicesResponse', listCoreDevicesResponse_coreDevices - A list that summarizes each core device.

$sel:httpStatus:ListCoreDevicesResponse', listCoreDevicesResponse_httpStatus - The response's http status code.

Response Lenses

listCoreDevicesResponse_nextToken :: Lens' ListCoreDevicesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

listCoreDevicesResponse_coreDevices :: Lens' ListCoreDevicesResponse (Maybe [CoreDevice]) Source #

A list that summarizes each core device.

listCoreDevicesResponse_httpStatus :: Lens' ListCoreDevicesResponse Int Source #

The response's http status code.