ManagedintegrationsforIoTDeviceManagement / Paginator / ListManagedThings

ListManagedThings

class ManagedintegrationsforIoTDeviceManagement.Paginator.ListManagedThings

paginator = client.get_paginator('list_managed_things')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ManagedintegrationsforIoTDeviceManagement.Client.list_managed_things().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OwnerFilter='string',
    CredentialLockerFilter='string',
    RoleFilter='CONTROLLER'|'DEVICE',
    ParentControllerIdentifierFilter='string',
    ConnectorPolicyIdFilter='string',
    SerialNumberFilter='string',
    ProvisioningStatusFilter='UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OwnerFilter (string) – Filter on device owners when listing managed things.

• CredentialLockerFilter (string) – Filter on a credential locker for a managed thing.

• RoleFilter (string) – Filter on the type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

• ParentControllerIdentifierFilter (string) – Filter on a parent controller id for a managed thing.

• ConnectorPolicyIdFilter (string) – Filter on a connector policy id for a managed thing.

• SerialNumberFilter (string) – Filter on the serial number of the device.

• ProvisioningStatusFilter (string) – Filter on the status of the device.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'Id': 'string',
            'Arn': 'string',
            'AdvertisedProductId': 'string',
            'Brand': 'string',
            'Classification': 'string',
            'ConnectorDeviceId': 'string',
            'ConnectorPolicyId': 'string',
            'Model': 'string',
            'Name': 'string',
            'Owner': 'string',
            'CredentialLockerId': 'string',
            'ParentControllerId': 'string',
            'ProvisioningStatus': 'UNASSOCIATED'|'PRE_ASSOCIATED'|'DISCOVERED'|'ACTIVATED'|'DELETION_FAILED'|'DELETE_IN_PROGRESS'|'ISOLATED'|'DELETED',
            'Role': 'CONTROLLER'|'DEVICE',
            'SerialNumber': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'ActivatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Items (list) –

    The list of managed things.

    • (dict) –

      Structure representing one managed thing.

      • Id (string) –

        The id of the device.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the managed thing.

      • AdvertisedProductId (string) –

        The id of the advertised product.

      • Brand (string) –

        The brand of the device.

      • Classification (string) –

        The classification of the managed thing such as light bulb or thermostat.

      • ConnectorDeviceId (string) –

        The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

        Note

        This parameter is used for cloud-to-cloud devices only.

      • ConnectorPolicyId (string) –

        The id of the connector policy.

        Note

        This parameter is used for cloud-to-cloud devices only.

      • Model (string) –

        The model of the device.

      • Name (string) –

        The name of the managed thing representing the physical device.

      • Owner (string) –

        Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

      • CredentialLockerId (string) –

        The identifier of the credential locker for the managed thing.

      • ParentControllerId (string) –

        Id of the controller device used for the discovery job.

      • ProvisioningStatus (string) –

        The provisioning status of the device in the provisioning workflow for onboarding to IoT managed integrations.

      • Role (string) –

        The type of device used. This will be the Amazon Web Services hub controller, cloud device, or IoT device.

      • SerialNumber (string) –

        The serial number of the device.

      • CreatedAt (datetime) –

        The timestamp value of when the device creation request occurred.

      • UpdatedAt (datetime) –

        The timestamp value of when the managed thing was last updated at.

      • ActivatedAt (datetime) –

        The timestampe value of when the managed thing was activated at.