ListDeviceIdentifiers - AWS Private 5G


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.

Request Syntax

POST /v1/device-identifiers/list HTTP/1.1 Content-type: application/json { "filters": { "string" : [ "string" ] }, "maxResults": number, "networkArn": "string", "startToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


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.

Type: String to array of strings map


Required: No


The maximum number of results to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No


The Amazon Resource Name (ARN) of the network.

Type: String

Pattern: ^arn:aws:private-networks:[a-z0-9-]+:[^:]*:.*$

Required: Yes


The token for the next page of results.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "deviceIdentifiers": [ { "createdAt": "string", "deviceIdentifierArn": "string", "iccid": "string", "imsi": "string", "networkArn": "string", "orderArn": "string", "status": "string", "trafficGroupArn": "string", "vendor": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Information about the device identifiers.

Type: Array of DeviceIdentifier objects


The token for the next page of results.

Type: String


For information about the errors that are common to all actions, see Common Errors.


Information about an internal error.

HTTP Status Code: 500


The resource was not found.

HTTP Status Code: 404


The request failed validation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: