| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.PrivateNetworks.ListDeviceIdentifiers
Description
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.
<p>If you specify multiple filters, filters are joined with an OR, and the request
returns results that match all of the specified filters.
This operation returns paginated results.
Synopsis
- data ListDeviceIdentifiers = ListDeviceIdentifiers' {}
- newListDeviceIdentifiers :: Text -> ListDeviceIdentifiers
- listDeviceIdentifiers_filters :: Lens' ListDeviceIdentifiers (Maybe (HashMap DeviceIdentifierFilterKeys [Text]))
- listDeviceIdentifiers_maxResults :: Lens' ListDeviceIdentifiers (Maybe Natural)
- listDeviceIdentifiers_startToken :: Lens' ListDeviceIdentifiers (Maybe Text)
- listDeviceIdentifiers_networkArn :: Lens' ListDeviceIdentifiers Text
- data ListDeviceIdentifiersResponse = ListDeviceIdentifiersResponse' {}
- newListDeviceIdentifiersResponse :: Int -> ListDeviceIdentifiersResponse
- listDeviceIdentifiersResponse_deviceIdentifiers :: Lens' ListDeviceIdentifiersResponse (Maybe [DeviceIdentifier])
- listDeviceIdentifiersResponse_nextToken :: Lens' ListDeviceIdentifiersResponse (Maybe Text)
- listDeviceIdentifiersResponse_httpStatus :: Lens' ListDeviceIdentifiersResponse Int
Creating a Request
data ListDeviceIdentifiers Source #
See: newListDeviceIdentifiers smart constructor.
Constructors
| ListDeviceIdentifiers' | |
Fields
| |
Instances
newListDeviceIdentifiers Source #
Arguments
| :: Text | |
| -> ListDeviceIdentifiers |
Create a value of ListDeviceIdentifiers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListDeviceIdentifiers', listDeviceIdentifiers_filters - 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.
$sel:maxResults:ListDeviceIdentifiers', listDeviceIdentifiers_maxResults - The maximum number of results to return.
$sel:startToken:ListDeviceIdentifiers', listDeviceIdentifiers_startToken - The token for the next page of results.
ListDeviceIdentifiers, listDeviceIdentifiers_networkArn - The Amazon Resource Name (ARN) of the network.
Request Lenses
listDeviceIdentifiers_filters :: Lens' ListDeviceIdentifiers (Maybe (HashMap DeviceIdentifierFilterKeys [Text])) Source #
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.
listDeviceIdentifiers_maxResults :: Lens' ListDeviceIdentifiers (Maybe Natural) Source #
The maximum number of results to return.
listDeviceIdentifiers_startToken :: Lens' ListDeviceIdentifiers (Maybe Text) Source #
The token for the next page of results.
listDeviceIdentifiers_networkArn :: Lens' ListDeviceIdentifiers Text Source #
The Amazon Resource Name (ARN) of the network.
Destructuring the Response
data ListDeviceIdentifiersResponse Source #
See: newListDeviceIdentifiersResponse smart constructor.
Constructors
| ListDeviceIdentifiersResponse' | |
Fields
| |
Instances
newListDeviceIdentifiersResponse Source #
Create a value of ListDeviceIdentifiersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceIdentifiers:ListDeviceIdentifiersResponse', listDeviceIdentifiersResponse_deviceIdentifiers - Information about the device identifiers.
$sel:nextToken:ListDeviceIdentifiersResponse', listDeviceIdentifiersResponse_nextToken - The token for the next page of results.
$sel:httpStatus:ListDeviceIdentifiersResponse', listDeviceIdentifiersResponse_httpStatus - The response's http status code.
Response Lenses
listDeviceIdentifiersResponse_deviceIdentifiers :: Lens' ListDeviceIdentifiersResponse (Maybe [DeviceIdentifier]) Source #
Information about the device identifiers.
listDeviceIdentifiersResponse_nextToken :: Lens' ListDeviceIdentifiersResponse (Maybe Text) Source #
The token for the next page of results.
listDeviceIdentifiersResponse_httpStatus :: Lens' ListDeviceIdentifiersResponse Int Source #
The response's http status code.