Private5G / Paginator / ListDeviceIdentifiers

ListDeviceIdentifiers#

class Private5G.Paginator.ListDeviceIdentifiers#
paginator = client.get_paginator('list_device_identifiers')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Private5G.Client.list_device_identifiers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters={
        'string': [
            'string',
        ]
    },
    networkArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • filters (dict) –

    The filters.

    • ORDER - The Amazon Resource Name (ARN) of the order.

    • STATUS - The status ( ACTIVE | INACTIVE).

    • TRAFFIC_GROUP - The Amazon Resource Name (ARN) of the traffic group.

    Filter values are case sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

    • (string) –

      • (list) –

        • (string) –

  • networkArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network.

  • 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

{
    'deviceIdentifiers': [
        {
            'createdAt': datetime(2015, 1, 1),
            'deviceIdentifierArn': 'string',
            'iccid': 'string',
            'imsi': 'string',
            'networkArn': 'string',
            'orderArn': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'trafficGroupArn': 'string',
            'vendor': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • deviceIdentifiers (list) –

      Information about the device identifiers.

      • (dict) –

        Information about a subscriber of a device that can use a network.

        • createdAt (datetime) –

          The creation time of this device identifier.

        • deviceIdentifierArn (string) –

          The Amazon Resource Name (ARN) of the device identifier.

        • iccid (string) –

          The Integrated Circuit Card Identifier of the device identifier.

        • imsi (string) –

          The International Mobile Subscriber Identity of the device identifier.

        • networkArn (string) –

          The Amazon Resource Name (ARN) of the network on which the device identifier appears.

        • orderArn (string) –

          The Amazon Resource Name (ARN) of the order used to purchase the device identifier.

        • status (string) –

          The status of the device identifier.

        • trafficGroupArn (string) –

          The Amazon Resource Name (ARN) of the traffic group to which the device identifier belongs.

        • vendor (string) –

          The vendor of the device identifier.

    • NextToken (string) –

      A token to resume pagination.