aws_sdk_devicefarm/client/
list_devices.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListDevices`](crate::operation::list_devices::builders::ListDevicesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`arn(impl Into<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::arn) / [`set_arn(Option<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the project.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    ///   - [`filters(DeviceFilter)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::filters) / [`set_filters(Option<Vec::<DeviceFilter>>)`](crate::operation::list_devices::builders::ListDevicesFluentBuilder::set_filters):<br>required: **false**<br><p>Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.</p> <ul>  <li>   <p>Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.</p>   <p>Allowed values include:</p>   <ul>    <li>     <p>ARN: The Amazon Resource Name (ARN) of the device (for example, <code>arn:aws:devicefarm:us-west-2::device:12345Example</code>).</p></li>    <li>     <p>PLATFORM: The device platform. Valid values are ANDROID or IOS.</p></li>    <li>     <p>OS_VERSION: The operating system version (for example, 10.3.2).</p></li>    <li>     <p>MODEL: The device model (for example, iPad 5th Gen).</p></li>    <li>     <p>AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>    <li>     <p>FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.</p></li>    <li>     <p>MANUFACTURER: The device manufacturer (for example, Apple).</p></li>    <li>     <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.</p></li>    <li>     <p>REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is <a href="https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html">no longer supported</a>, this attribute is ignored.</p></li>    <li>     <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p></li>    <li>     <p>INSTANCE_LABELS: The label of the device instance.</p></li>    <li>     <p>FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.</p></li>   </ul></li>  <li>   <p>Operator: The filter operator.</p>   <ul>    <li>     <p>The EQUALS operator is available for every attribute except INSTANCE_LABELS.</p></li>    <li>     <p>The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.</p></li>    <li>     <p>The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.</p></li>    <li>     <p>The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.</p></li>   </ul></li>  <li>   <p>Values: An array of one or more filter values.</p>   <ul>    <li>     <p>The IN and NOT_IN operators take a values array that has one or more elements.</p></li>    <li>     <p>The other operators require an array with a single element.</p></li>    <li>     <p>In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.</p></li>   </ul></li> </ul><br>
    /// - On success, responds with [`ListDevicesOutput`](crate::operation::list_devices::ListDevicesOutput) with field(s):
    ///   - [`devices(Option<Vec::<Device>>)`](crate::operation::list_devices::ListDevicesOutput::devices): <p>Information about the devices.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_devices::ListDevicesOutput::next_token): <p>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.</p>
    /// - On failure, responds with [`SdkError<ListDevicesError>`](crate::operation::list_devices::ListDevicesError)
    pub fn list_devices(&self) -> crate::operation::list_devices::builders::ListDevicesFluentBuilder {
        crate::operation::list_devices::builders::ListDevicesFluentBuilder::new(self.handle.clone())
    }
}