Amazonka.PrivateNetworks.ListDeviceIdentifiers

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.

Creating a Request

data ListDeviceIdentifiers

See: newListDeviceIdentifiers smart constructor.

Constructors

ListDeviceIdentifiers'

Fields

• filters :: Maybe (HashMap DeviceIdentifierFilterKeys [Text])

  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.

• maxResults :: Maybe Natural

  The maximum number of results to return.

• startToken :: Maybe Text

  The token for the next page of results.

• networkArn :: Text

  The Amazon Resource Name (ARN) of the network.

Instances

ToJSON ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

toJSON :: ListDeviceIdentifiers -> Value

toEncoding :: ListDeviceIdentifiers -> Encoding

toJSONList :: [ListDeviceIdentifiers] -> Value

toEncodingList :: [ListDeviceIdentifiers] -> Encoding

ToHeaders ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

toHeaders :: ListDeviceIdentifiers -> [Header]

ToPath ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

toPath :: ListDeviceIdentifiers -> ByteString

ToQuery ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

toQuery :: ListDeviceIdentifiers -> QueryString

AWSPager ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

page :: ListDeviceIdentifiers -> AWSResponse ListDeviceIdentifiers -> Maybe ListDeviceIdentifiers

AWSRequest ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Associated Types

type AWSResponse ListDeviceIdentifiers

Methods

request :: (Service -> Service) -> ListDeviceIdentifiers -> Request ListDeviceIdentifiers

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListDeviceIdentifiers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDeviceIdentifiers)))

Generic ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Associated Types

type Rep ListDeviceIdentifiers :: Type -> Type

Methods

from :: ListDeviceIdentifiers -> Rep ListDeviceIdentifiers x

to :: Rep ListDeviceIdentifiers x -> ListDeviceIdentifiers

Read ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

readsPrec :: Int -> ReadS ListDeviceIdentifiers

readList :: ReadS [ListDeviceIdentifiers]

readPrec :: ReadPrec ListDeviceIdentifiers

readListPrec :: ReadPrec [ListDeviceIdentifiers]

Show ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

showsPrec :: Int -> ListDeviceIdentifiers -> ShowS

show :: ListDeviceIdentifiers -> String

showList :: [ListDeviceIdentifiers] -> ShowS

NFData ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

rnf :: ListDeviceIdentifiers -> ()

Eq ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

(==) :: ListDeviceIdentifiers -> ListDeviceIdentifiers -> Bool

(/=) :: ListDeviceIdentifiers -> ListDeviceIdentifiers -> Bool

Hashable ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

hashWithSalt :: Int -> ListDeviceIdentifiers -> Int

hash :: ListDeviceIdentifiers -> Int

type AWSResponse ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

type AWSResponse ListDeviceIdentifiers = ListDeviceIdentifiersResponse

type Rep ListDeviceIdentifiers

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

type Rep ListDeviceIdentifiers = D1 ('MetaData "ListDeviceIdentifiers" "Amazonka.PrivateNetworks.ListDeviceIdentifiers" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListDeviceIdentifiers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap DeviceIdentifierFilterKeys [Text]))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "startToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "networkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListDeviceIdentifiers

Arguments

:: Text

ListDeviceIdentifiers

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

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)

The maximum number of results to return.

listDeviceIdentifiers_startToken :: Lens' ListDeviceIdentifiers (Maybe Text)

The token for the next page of results.

listDeviceIdentifiers_networkArn :: Lens' ListDeviceIdentifiers Text

The Amazon Resource Name (ARN) of the network.

Destructuring the Response

data ListDeviceIdentifiersResponse

See: newListDeviceIdentifiersResponse smart constructor.

Constructors

ListDeviceIdentifiersResponse'

Fields

• deviceIdentifiers :: Maybe [DeviceIdentifier]

  Information about the device identifiers.

• nextToken :: Maybe Text

  The token for the next page of results.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListDeviceIdentifiersResponse

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Associated Types

type Rep ListDeviceIdentifiersResponse :: Type -> Type

Methods

from :: ListDeviceIdentifiersResponse -> Rep ListDeviceIdentifiersResponse x

to :: Rep ListDeviceIdentifiersResponse x -> ListDeviceIdentifiersResponse

Show ListDeviceIdentifiersResponse

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

showsPrec :: Int -> ListDeviceIdentifiersResponse -> ShowS

show :: ListDeviceIdentifiersResponse -> String

showList :: [ListDeviceIdentifiersResponse] -> ShowS

NFData ListDeviceIdentifiersResponse

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

rnf :: ListDeviceIdentifiersResponse -> ()

Eq ListDeviceIdentifiersResponse

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

Methods

(==) :: ListDeviceIdentifiersResponse -> ListDeviceIdentifiersResponse -> Bool

(/=) :: ListDeviceIdentifiersResponse -> ListDeviceIdentifiersResponse -> Bool

type Rep ListDeviceIdentifiersResponse

Defined in Amazonka.PrivateNetworks.ListDeviceIdentifiers

type Rep ListDeviceIdentifiersResponse = D1 ('MetaData "ListDeviceIdentifiersResponse" "Amazonka.PrivateNetworks.ListDeviceIdentifiers" "amazonka-privatenetworks-2.0-6kTUHQMy1b1JCa08Y5Egzo" 'False) (C1 ('MetaCons "ListDeviceIdentifiersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deviceIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceIdentifier])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDeviceIdentifiersResponse

Arguments

:: Int

$sel:httpStatus:ListDeviceIdentifiersResponse'

-> ListDeviceIdentifiersResponse

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

Information about the device identifiers.

listDeviceIdentifiersResponse_nextToken :: Lens' ListDeviceIdentifiersResponse (Maybe Text)

The token for the next page of results.

listDeviceIdentifiersResponse_httpStatus :: Lens' ListDeviceIdentifiersResponse Int

The response's http status code.