Private5G / Client / list_device_identifiers

list_device_identifiers#

Private5G.Client.list_device_identifiers(**kwargs)#

Lists device identifiers. Add filters to your request to return a more specific list of results. Use filters to match the Amazon Resource Name (ARN) of an order, the status of device identifiers, or the ARN of the traffic group.

If you specify multiple filters, filters are joined with an OR, and the request returns results that match all of the specified filters.

See also: AWS API Documentation

Request Syntax

response = client.list_device_identifiers(
    filters={
        'string': [
            'string',
        ]
    },
    maxResults=123,
    networkArn='string',
    startToken='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) –

  • maxResults (integer) – The maximum number of results to return.

  • networkArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the network.

  • startToken (string) – The token for the next page of results.

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) –

      The token for the next page of results.

Exceptions