GreengrassV2 / Client / batch_disassociate_client_device_from_core_device

batch_disassociate_client_device_from_core_device#

GreengrassV2.Client.batch_disassociate_client_device_from_core_device(**kwargs)#

Disassociates a list of client devices from a core device. After you disassociate a client device from a core device, the client device won’t be able to use cloud discovery to retrieve the core device’s connectivity information and certificates.

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_client_device_from_core_device(
    entries=[
        {
            'thingName': 'string'
        },
    ],
    coreDeviceThingName='string'
)
Parameters:
  • entries (list) –

    The list of client devices to disassociate.

    • (dict) –

      Contains a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation consumes a list of these requests.

      • thingName (string) – [REQUIRED]

        The name of the IoT thing that represents the client device to disassociate.

  • coreDeviceThingName (string) –

    [REQUIRED]

    The name of the core device. This is also the name of the IoT thing.

Return type:

dict

Returns:

Response Syntax

{
    'errorEntries': [
        {
            'thingName': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • errorEntries (list) –

      The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to disassociate.

      • (dict) –

        Contains an error that occurs from a request to disassociate a client device from a core device. The BatchDisassociateClientDeviceWithCoreDevice operation returns a list of these errors.

        • thingName (string) –

          The name of the IoT thing whose disassociate request failed.

        • code (string) –

          The error code for the request.

        • message (string) –

          A message that provides additional information about the error.

Exceptions