aws-sdk-devicefarm 1.99.0

AWS SDK for AWS Device Farm
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Represents the result of a list devices request.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ListDevicesInput {
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <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>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <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>
    pub filters: ::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>>,
}
impl ListDevicesInput {
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <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>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <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>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.filters.is_none()`.
    pub fn filters(&self) -> &[crate::types::DeviceFilter] {
        self.filters.as_deref().unwrap_or_default()
    }
}
impl ListDevicesInput {
    /// Creates a new builder-style object to manufacture [`ListDevicesInput`](crate::operation::list_devices::ListDevicesInput).
    pub fn builder() -> crate::operation::list_devices::builders::ListDevicesInputBuilder {
        crate::operation::list_devices::builders::ListDevicesInputBuilder::default()
    }
}

/// A builder for [`ListDevicesInput`](crate::operation::list_devices::ListDevicesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListDevicesInputBuilder {
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) filters: ::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>>,
}
impl ListDevicesInputBuilder {
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the project.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <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>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <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>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <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>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// Appends an item to `filters`.
    ///
    /// To override the contents of this collection use [`set_filters`](Self::set_filters).
    ///
    /// <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>
    pub fn filters(mut self, input: crate::types::DeviceFilter) -> Self {
        let mut v = self.filters.unwrap_or_default();
        v.push(input);
        self.filters = ::std::option::Option::Some(v);
        self
    }
    /// <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>
    pub fn set_filters(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>>) -> Self {
        self.filters = input;
        self
    }
    /// <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>
    pub fn get_filters(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::DeviceFilter>> {
        &self.filters
    }
    /// Consumes the builder and constructs a [`ListDevicesInput`](crate::operation::list_devices::ListDevicesInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::list_devices::ListDevicesInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_devices::ListDevicesInput {
            arn: self.arn,
            next_token: self.next_token,
            filters: self.filters,
        })
    }
}