libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DeviceFarm.ListDevices

Description

Gets information about unique device types.

This operation returns paginated results.

Synopsis

Creating a Request

data ListDevices Source #

Represents the result of a list devices request.

See: newListDevices smart constructor.

Constructors

ListDevices' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the project.

  • filters :: Maybe [DeviceFilter]

    Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

    • Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

      Allowed values include:

      • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
      • PLATFORM: The device platform. Valid values are ANDROID or IOS.
      • OS_VERSION: The operating system version (for example, 10.3.2).
      • MODEL: The device model (for example, iPad 5th Gen).
      • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
      • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
      • MANUFACTURER: The device manufacturer (for example, Apple).
      • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
      • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
      • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
      • INSTANCE_LABELS: The label of the device instance.
      • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

    • Operator: The filter operator.

      • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
      • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
      • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
      • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

    • Values: An array of one or more filter values.

      • The IN and NOT_IN operators take a values array that has one or more elements.
      • The other operators require an array with a single element.
      • In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
  • nextToken :: Maybe Text

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Instances

Instances details
Eq ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

(==) :: ListDevices -> ListDevices -> Bool #

(/=) :: ListDevices -> ListDevices -> Bool #

Read ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

readsPrec :: Int -> ReadS ListDevices #

readList :: ReadS [ListDevices] #

readPrec :: ReadPrec ListDevices #

readListPrec :: ReadPrec [ListDevices] #

Show ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

showsPrec :: Int -> ListDevices -> ShowS #

show :: ListDevices -> String #

showList :: [ListDevices] -> ShowS #

Generic ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Associated Types

type Rep ListDevices :: Type -> Type #

Methods

from :: ListDevices -> Rep ListDevices x #

to :: Rep ListDevices x -> ListDevices #

NFData ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

rnf :: ListDevices -> () #

Hashable ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

hashWithSalt :: Int -> ListDevices -> Int #

hash :: ListDevices -> Int #

ToJSON ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

toJSON :: ListDevices -> Value #

toEncoding :: ListDevices -> Encoding #

toJSONList :: [ListDevices] -> Value #

toEncodingList :: [ListDevices] -> Encoding #

AWSPager ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

page :: ListDevices -> AWSResponse ListDevices -> Maybe ListDevices #

AWSRequest ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Associated Types

type AWSResponse ListDevices #

Methods

request :: ListDevices -> Request ListDevices #

response :: MonadResource m => Logger -> Service -> Proxy ListDevices -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListDevices))) #

ToHeaders ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

toHeaders :: ListDevices -> [Header] #

ToPath ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

toPath :: ListDevices -> ByteString #

ToQuery ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

toQuery :: ListDevices -> QueryString #

type Rep ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

type Rep ListDevices = D1 ('MetaData "ListDevices" "Amazonka.DeviceFarm.ListDevices" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "ListDevices'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeviceFilter])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse ListDevices Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

type AWSResponse ListDevices = ListDevicesResponse

newListDevices :: ListDevices Source #

Create a value of ListDevices 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:arn:ListDevices', listDevices_arn - The Amazon Resource Name (ARN) of the project.

$sel:filters:ListDevices', listDevices_filters - Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

  • Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

    Allowed values include:

    • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
    • PLATFORM: The device platform. Valid values are ANDROID or IOS.
    • OS_VERSION: The operating system version (for example, 10.3.2).
    • MODEL: The device model (for example, iPad 5th Gen).
    • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
    • MANUFACTURER: The device manufacturer (for example, Apple).
    • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
    • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
    • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
    • INSTANCE_LABELS: The label of the device instance.
    • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

  • Operator: The filter operator.

    • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
    • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
    • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
    • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

  • Values: An array of one or more filter values.

    • The IN and NOT_IN operators take a values array that has one or more elements.
    • The other operators require an array with a single element.
    • In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

$sel:nextToken:ListDevices', listDevices_nextToken - An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Request Lenses

listDevices_arn :: Lens' ListDevices (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

listDevices_filters :: Lens' ListDevices (Maybe [DeviceFilter]) Source #

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

  • Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

    Allowed values include:

    • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).
    • PLATFORM: The device platform. Valid values are ANDROID or IOS.
    • OS_VERSION: The operating system version (for example, 10.3.2).
    • MODEL: The device model (for example, iPad 5th Gen).
    • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
    • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
    • MANUFACTURER: The device manufacturer (for example, Apple).
    • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
    • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.
    • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
    • INSTANCE_LABELS: The label of the device instance.
    • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

  • Operator: The filter operator.

    • The EQUALS operator is available for every attribute except INSTANCE_LABELS.
    • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
    • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.
    • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

  • Values: An array of one or more filter values.

    • The IN and NOT_IN operators take a values array that has one or more elements.
    • The other operators require an array with a single element.
    • In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Destructuring the Response

data ListDevicesResponse Source #

Represents the result of a list devices operation.

See: newListDevicesResponse smart constructor.

Constructors

ListDevicesResponse' 

Fields

  • nextToken :: Maybe Text

    If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

  • devices :: Maybe [Device]

    Information about the devices.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

(==) :: ListDevicesResponse -> ListDevicesResponse -> Bool #

(/=) :: ListDevicesResponse -> ListDevicesResponse -> Bool #

Read ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

readsPrec :: Int -> ReadS ListDevicesResponse #

readList :: ReadS [ListDevicesResponse] #

readPrec :: ReadPrec ListDevicesResponse #

readListPrec :: ReadPrec [ListDevicesResponse] #

Show ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

showsPrec :: Int -> ListDevicesResponse -> ShowS #

show :: ListDevicesResponse -> String #

showList :: [ListDevicesResponse] -> ShowS #

Generic ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Associated Types

type Rep ListDevicesResponse :: Type -> Type #

Methods

from :: ListDevicesResponse -> Rep ListDevicesResponse x #

to :: Rep ListDevicesResponse x -> ListDevicesResponse #

NFData ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

Methods

rnf :: ListDevicesResponse -> () #

type Rep ListDevicesResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.ListDevices

type Rep ListDevicesResponse = D1 ('MetaData "ListDevicesResponse" "Amazonka.DeviceFarm.ListDevices" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "ListDevicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Device])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListDevicesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListDevicesResponse'

-> ListDevicesResponse 

Create a value of ListDevicesResponse 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:nextToken:ListDevices', listDevicesResponse_nextToken - If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

$sel:devices:ListDevicesResponse', listDevicesResponse_devices - Information about the devices.

$sel:httpStatus:ListDevicesResponse', listDevicesResponse_httpStatus - The response's http status code.

Response Lenses

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

If the number of items that are returned is significantly large, this is an identifier that is also returned. It can be used in a subsequent call to this operation to return the next set of items in the list.

listDevicesResponse_devices :: Lens' ListDevicesResponse (Maybe [Device]) Source #

Information about the devices.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #

The response's http status code.