/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace DeviceFarm { namespace Model { /** *

Represents the result of a list devices request.

See Also:

* AWS * API Reference

*/ class ListDevicesRequest : public DeviceFarmRequest { public: AWS_DEVICEFARM_API ListDevicesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "ListDevices"; } AWS_DEVICEFARM_API Aws::String SerializePayload() const override; AWS_DEVICEFARM_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The Amazon Resource Name (ARN) of the project.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The Amazon Resource Name (ARN) of the project.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the project.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The Amazon Resource Name (ARN) of the project.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the project.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The Amazon Resource Name (ARN) of the project.

*/ inline ListDevicesRequest& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the project.

*/ inline ListDevicesRequest& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the project.

*/ inline ListDevicesRequest& WithArn(const char* value) { SetArn(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline ListDevicesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline ListDevicesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline ListDevicesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

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.

*/ inline const Aws::Vector& GetFilters() const{ return m_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.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

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.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

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.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

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.

*/ inline ListDevicesRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

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.

*/ inline ListDevicesRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

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.

*/ inline ListDevicesRequest& AddFilters(const DeviceFilter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

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.

*/ inline ListDevicesRequest& AddFilters(DeviceFilter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } private: Aws::String m_arn; bool m_arnHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; }; } // namespace Model } // namespace DeviceFarm } // namespace Aws