| 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.BatchAssociateClientDeviceWithCoreDevice
Description
Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see Configure cloud discovery in the IoT Greengrass V2 Developer Guide.
Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see Interact with local IoT devices in the IoT Greengrass V2 Developer Guide.
Synopsis
- data BatchAssociateClientDeviceWithCoreDevice = BatchAssociateClientDeviceWithCoreDevice' {}
- newBatchAssociateClientDeviceWithCoreDevice :: Text -> BatchAssociateClientDeviceWithCoreDevice
- batchAssociateClientDeviceWithCoreDevice_entries :: Lens' BatchAssociateClientDeviceWithCoreDevice (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry))
- batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName :: Lens' BatchAssociateClientDeviceWithCoreDevice Text
- data BatchAssociateClientDeviceWithCoreDeviceResponse = BatchAssociateClientDeviceWithCoreDeviceResponse' {}
- newBatchAssociateClientDeviceWithCoreDeviceResponse :: Int -> BatchAssociateClientDeviceWithCoreDeviceResponse
- batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceErrorEntry))
- batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse Int
Creating a Request
data BatchAssociateClientDeviceWithCoreDevice Source #
See: newBatchAssociateClientDeviceWithCoreDevice smart constructor.
Constructors
| BatchAssociateClientDeviceWithCoreDevice' | |
Fields
| |
Instances
newBatchAssociateClientDeviceWithCoreDevice Source #
Arguments
| :: Text |
|
| -> BatchAssociateClientDeviceWithCoreDevice |
Create a value of BatchAssociateClientDeviceWithCoreDevice 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:entries:BatchAssociateClientDeviceWithCoreDevice', batchAssociateClientDeviceWithCoreDevice_entries - The list of client devices to associate.
$sel:coreDeviceThingName:BatchAssociateClientDeviceWithCoreDevice', batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName - The name of the core device. This is also the name of the IoT thing.
Request Lenses
batchAssociateClientDeviceWithCoreDevice_entries :: Lens' BatchAssociateClientDeviceWithCoreDevice (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceEntry)) Source #
The list of client devices to associate.
batchAssociateClientDeviceWithCoreDevice_coreDeviceThingName :: Lens' BatchAssociateClientDeviceWithCoreDevice Text Source #
The name of the core device. This is also the name of the IoT thing.
Destructuring the Response
data BatchAssociateClientDeviceWithCoreDeviceResponse Source #
See: newBatchAssociateClientDeviceWithCoreDeviceResponse smart constructor.
Constructors
| BatchAssociateClientDeviceWithCoreDeviceResponse' | |
Fields
| |
Instances
newBatchAssociateClientDeviceWithCoreDeviceResponse Source #
Arguments
| :: Int |
|
| -> BatchAssociateClientDeviceWithCoreDeviceResponse |
Create a value of BatchAssociateClientDeviceWithCoreDeviceResponse 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:errorEntries:BatchAssociateClientDeviceWithCoreDeviceResponse', batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries - The list of any errors for the entries in the request. Each error entry
contains the name of the IoT thing that failed to associate.
$sel:httpStatus:BatchAssociateClientDeviceWithCoreDeviceResponse', batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus - The response's http status code.
Response Lenses
batchAssociateClientDeviceWithCoreDeviceResponse_errorEntries :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse (Maybe (NonEmpty AssociateClientDeviceWithCoreDeviceErrorEntry)) Source #
The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to associate.
batchAssociateClientDeviceWithCoreDeviceResponse_httpStatus :: Lens' BatchAssociateClientDeviceWithCoreDeviceResponse Int Source #
The response's http status code.