Struct aws_sdk_devicefarm::Client

pub struct Client { /* private fields */ }

Client for AWS Device Farm

Client for invoking operations on AWS Device Farm. Each operation on AWS Device Farm is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_devicefarm::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The [Builder] struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_devicefarm::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the CreateDevicePool operation has a Client::create_device_pool, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.create_device_pool()
    .project_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn create_device_pool(&self) -> CreateDevicePoolFluentBuilder

Constructs a fluent builder for the CreateDevicePool operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The ARN of the project for the device pool.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The device pool’s name.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The device pool’s description.

    
    
  • rules(Rule) / set_rules(Option<Vec::<Rule>>):
    required: true
    

    The device pool’s rules.

    
    
  • max_devices(i32) / set_max_devices(Option<i32>):
    required: false
    

    The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

    By specifying the maximum number of devices, you can control the costs that you incur by running tests.

    
    
• On success, responds with CreateDevicePoolOutput with field(s):
  • device_pool(Option<DevicePool>):

    The newly created device pool.

• On failure, responds with SdkError<CreateDevicePoolError>

impl Client

pub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder

Constructs a fluent builder for the CreateInstanceProfile operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of your instance profile.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of your instance profile.

    
    
  • package_cleanup(bool) / set_package_cleanup(Option<bool>):
    required: false
    

    When set to true, Device Farm removes app packages after a test run. The default value is false for private devices.

    
    
  • exclude_app_packages_from_cleanup(impl Into<String>) / set_exclude_app_packages_from_cleanup(Option<Vec::<String>>):
    required: false
    

    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run.

    The list of packages is considered only if you set packageCleanup to true.

    
    
  • reboot_after_use(bool) / set_reboot_after_use(Option<bool>):
    required: false
    

    When set to true, Device Farm reboots the instance after a test run. The default value is true.

    
    
• On success, responds with CreateInstanceProfileOutput with field(s):
  • instance_profile(Option<InstanceProfile>):

    An object that contains information about your instance profile.

• On failure, responds with SdkError<CreateInstanceProfileError>

impl Client

pub fn create_network_profile(&self) -> CreateNetworkProfileFluentBuilder

Constructs a fluent builder for the CreateNetworkProfile operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the new network profile.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the network profile.

    
    
  • r#type(NetworkProfileType) / set_type(Option<NetworkProfileType>):
    required: false
    

    The type of network profile to create. Valid values are listed here.

    
    
  • uplink_bandwidth_bits(i64) / set_uplink_bandwidth_bits(Option<i64>):
    required: false
    

    The data throughput rate in bits per second, as an integer from 0 to 104857600.

    
    
  • downlink_bandwidth_bits(i64) / set_downlink_bandwidth_bits(Option<i64>):
    required: false
    

    The data throughput rate in bits per second, as an integer from 0 to 104857600.

    
    
  • uplink_delay_ms(i64) / set_uplink_delay_ms(Option<i64>):
    required: false
    

    Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

    
    
  • downlink_delay_ms(i64) / set_downlink_delay_ms(Option<i64>):
    required: false
    

    Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

    
    
  • uplink_jitter_ms(i64) / set_uplink_jitter_ms(Option<i64>):
    required: false
    

    Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

    
    
  • downlink_jitter_ms(i64) / set_downlink_jitter_ms(Option<i64>):
    required: false
    

    Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

    
    
  • uplink_loss_percent(i32) / set_uplink_loss_percent(Option<i32>):
    required: false
    

    Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

    
    
  • downlink_loss_percent(i32) / set_downlink_loss_percent(Option<i32>):
    required: false
    

    Proportion of received packets that fail to arrive from 0 to 100 percent.

    
    
• On success, responds with CreateNetworkProfileOutput with field(s):
  • network_profile(Option<NetworkProfile>):

    The network profile that is returned by the create network profile request.

• On failure, responds with SdkError<CreateNetworkProfileError>

impl Client

pub fn create_project(&self) -> CreateProjectFluentBuilder

Constructs a fluent builder for the CreateProject operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The project’s name.

    
    
  • default_job_timeout_minutes(i32) / set_default_job_timeout_minutes(Option<i32>):
    required: false
    

    Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

    The VPC security groups and subnets that are attached to a project.

    
    
• On success, responds with CreateProjectOutput with field(s):
  • project(Option<Project>):

    The newly created project.

• On failure, responds with SdkError<CreateProjectError>

impl Client

pub fn create_remote_access_session( &self, ) -> CreateRemoteAccessSessionFluentBuilder

Constructs a fluent builder for the CreateRemoteAccessSession operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

    
    
  • device_arn(impl Into<String>) / set_device_arn(Option<String>):
    required: true
    

    The ARN of the device for which you want to create a remote access session.

    
    
  • instance_arn(impl Into<String>) / set_instance_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

    
    
  • ssh_public_key(impl Into<String>) / set_ssh_public_key(Option<String>):
    required: false
    

    Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled is set to true.

    Remote debugging is no longer supported.

    
    
  • remote_debug_enabled(bool) / set_remote_debug_enabled(Option<bool>):
    required: false
    

    Set to true if you want to access devices remotely for debugging in your remote access session.

    Remote debugging is no longer supported.

    
    
  • remote_record_enabled(bool) / set_remote_record_enabled(Option<bool>):
    required: false
    

    Set to true to enable remote recording for the remote access session.

    
    
  • remote_record_app_arn(impl Into<String>) / set_remote_record_app_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the remote access session to create.

    
    
  • client_id(impl Into<String>) / set_client_id(Option<String>):
    required: false
    

    Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This identifier is required only if remoteDebugEnabled is set to true.

    Remote debugging is no longer supported.

    
    
  • configuration(CreateRemoteAccessSessionConfiguration) / set_configuration(Option<CreateRemoteAccessSessionConfiguration>):
    required: false
    

    The configuration information for the remote access session request.

    
    
  • interaction_mode(InteractionMode) / set_interaction_mode(Option<InteractionMode>):
    required: false
    

    The interaction mode of the remote access session. Valid values are:

    • INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.

    • NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.

    • VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

    
    
  • skip_app_resign(bool) / set_skip_app_resign(Option<bool>):
    required: false
    

    When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

    For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

    
    
• On success, responds with CreateRemoteAccessSessionOutput with field(s):
  • remote_access_session(Option<RemoteAccessSession>):

    A container that describes the remote access session when the request to create a remote access session is sent.

• On failure, responds with SdkError<CreateRemoteAccessSessionError>

impl Client

pub fn create_test_grid_project(&self) -> CreateTestGridProjectFluentBuilder

Constructs a fluent builder for the CreateTestGridProject operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Human-readable name of the Selenium testing project.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Human-readable description of the project.

    
    
  • vpc_config(TestGridVpcConfig) / set_vpc_config(Option<TestGridVpcConfig>):
    required: false
    

    The VPC security groups and subnets that are attached to a project.

    
    
• On success, responds with CreateTestGridProjectOutput with field(s):
  • test_grid_project(Option<TestGridProject>):

    ARN of the Selenium testing project that was created.

• On failure, responds with SdkError<CreateTestGridProjectError>

impl Client

pub fn create_test_grid_url(&self) -> CreateTestGridUrlFluentBuilder

Constructs a fluent builder for the CreateTestGridUrl operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL.

    
    
  • expires_in_seconds(i32) / set_expires_in_seconds(Option<i32>):
    required: true
    

    Lifetime, in seconds, of the URL.

    
    
• On success, responds with CreateTestGridUrlOutput with field(s):
  • url(Option<String>):

    A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed to a RemoteWebDriver.

  • expires(Option<DateTime>):

    The number of seconds the URL from CreateTestGridUrlResult$url stays active.

• On failure, responds with SdkError<CreateTestGridUrlError>

impl Client

pub fn create_upload(&self) -> CreateUploadFluentBuilder

Constructs a fluent builder for the CreateUpload operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The ARN of the project for the upload.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The upload’s file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

    
    
  • r#type(UploadType) / set_type(Option<UploadType>):
    required: true
    

    The upload’s upload type.

    Must be one of the following values:

    • ANDROID_APP

    • IOS_APP

    • WEB_APP

    • EXTERNAL_DATA

    • APPIUM_JAVA_JUNIT_TEST_PACKAGE

    • APPIUM_JAVA_TESTNG_TEST_PACKAGE

    • APPIUM_PYTHON_TEST_PACKAGE

    • APPIUM_NODE_TEST_PACKAGE

    • APPIUM_RUBY_TEST_PACKAGE

    • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

    • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

    • APPIUM_WEB_PYTHON_TEST_PACKAGE

    • APPIUM_WEB_NODE_TEST_PACKAGE

    • APPIUM_WEB_RUBY_TEST_PACKAGE

    • CALABASH_TEST_PACKAGE

    • INSTRUMENTATION_TEST_PACKAGE

    • UIAUTOMATION_TEST_PACKAGE

    • UIAUTOMATOR_TEST_PACKAGE

    • XCTEST_TEST_PACKAGE

    • XCTEST_UI_TEST_PACKAGE

    • APPIUM_JAVA_JUNIT_TEST_SPEC

    • APPIUM_JAVA_TESTNG_TEST_SPEC

    • APPIUM_PYTHON_TEST_SPEC

    • APPIUM_NODE_TEST_SPEC

    • APPIUM_RUBY_TEST_SPEC

    • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

    • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

    • APPIUM_WEB_PYTHON_TEST_SPEC

    • APPIUM_WEB_NODE_TEST_SPEC

    • APPIUM_WEB_RUBY_TEST_SPEC

    • INSTRUMENTATION_TEST_SPEC

    • XCTEST_UI_TEST_SPEC

    If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The upload’s content type (for example, application/octet-stream).

    
    
• On success, responds with CreateUploadOutput with field(s):
  • upload(Option<Upload>):

    The newly created upload.

• On failure, responds with SdkError<CreateUploadError>

impl Client

pub fn create_vpce_configuration(&self) -> CreateVPCEConfigurationFluentBuilder

Constructs a fluent builder for the CreateVPCEConfiguration operation.

• The fluent builder is configurable:
  • vpce_configuration_name(impl Into<String>) / set_vpce_configuration_name(Option<String>):
    required: true
    

    The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

    
    
  • vpce_service_name(impl Into<String>) / set_vpce_service_name(Option<String>):
    required: true
    

    The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

    
    
  • service_dns_name(impl Into<String>) / set_service_dns_name(Option<String>):
    required: true
    

    The DNS name of the service running in your VPC that you want Device Farm to test.

    
    
  • vpce_configuration_description(impl Into<String>) / set_vpce_configuration_description(Option<String>):
    required: false
    

    An optional description that provides details about your VPC endpoint configuration.

    
    
• On success, responds with CreateVpceConfigurationOutput with field(s):
  • vpce_configuration(Option<VpceConfiguration>):

    An object that contains information about your VPC endpoint configuration.

• On failure, responds with SdkError<CreateVPCEConfigurationError>

impl Client

pub fn delete_device_pool(&self) -> DeleteDevicePoolFluentBuilder

Constructs a fluent builder for the DeleteDevicePool operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.

    
    
• On success, responds with DeleteDevicePoolOutput
• On failure, responds with SdkError<DeleteDevicePoolError>

impl Client

pub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder

Constructs a fluent builder for the DeleteInstanceProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.

    
    
• On success, responds with DeleteInstanceProfileOutput
• On failure, responds with SdkError<DeleteInstanceProfileError>

impl Client

pub fn delete_network_profile(&self) -> DeleteNetworkProfileFluentBuilder

Constructs a fluent builder for the DeleteNetworkProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the network profile to delete.

    
    
• On success, responds with DeleteNetworkProfileOutput
• On failure, responds with SdkError<DeleteNetworkProfileError>

impl Client

pub fn delete_project(&self) -> DeleteProjectFluentBuilder

Constructs a fluent builder for the DeleteProject operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.

    
    
• On success, responds with DeleteProjectOutput
• On failure, responds with SdkError<DeleteProjectError>

impl Client

pub fn delete_remote_access_session( &self, ) -> DeleteRemoteAccessSessionFluentBuilder

Constructs a fluent builder for the DeleteRemoteAccessSession operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the session for which you want to delete remote access.

    
    
• On success, responds with DeleteRemoteAccessSessionOutput
• On failure, responds with SdkError<DeleteRemoteAccessSessionError>

impl Client

pub fn delete_run(&self) -> DeleteRunFluentBuilder

Constructs a fluent builder for the DeleteRun operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the run to delete.

    
    
• On success, responds with DeleteRunOutput
• On failure, responds with SdkError<DeleteRunError>

impl Client

pub fn delete_test_grid_project(&self) -> DeleteTestGridProjectFluentBuilder

Constructs a fluent builder for the DeleteTestGridProject operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects.

    
    
• On success, responds with DeleteTestGridProjectOutput
• On failure, responds with SdkError<DeleteTestGridProjectError>

impl Client

pub fn delete_upload(&self) -> DeleteUploadFluentBuilder

Constructs a fluent builder for the DeleteUpload operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.

    
    
• On success, responds with DeleteUploadOutput
• On failure, responds with SdkError<DeleteUploadError>

impl Client

pub fn delete_vpce_configuration(&self) -> DeleteVPCEConfigurationFluentBuilder

Constructs a fluent builder for the DeleteVPCEConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.

    
    
• On success, responds with DeleteVpceConfigurationOutput
• On failure, responds with SdkError<DeleteVPCEConfigurationError>

impl Client

pub fn get_account_settings(&self) -> GetAccountSettingsFluentBuilder

Constructs a fluent builder for the GetAccountSettings operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetAccountSettingsOutput with field(s):
  • account_settings(Option<AccountSettings>):

    The account settings.

• On failure, responds with SdkError<GetAccountSettingsError>

impl Client

pub fn get_device(&self) -> GetDeviceFluentBuilder

Constructs a fluent builder for the GetDevice operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The device type’s ARN.

    
    
• On success, responds with GetDeviceOutput with field(s):
  • device(Option<Device>):

    An object that contains information about the requested device.

• On failure, responds with SdkError<GetDeviceError>

impl Client

pub fn get_device_instance(&self) -> GetDeviceInstanceFluentBuilder

Constructs a fluent builder for the GetDeviceInstance operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the instance you’re requesting information about.

    
    
• On success, responds with GetDeviceInstanceOutput with field(s):
  • device_instance(Option<DeviceInstance>):

    An object that contains information about your device instance.

• On failure, responds with SdkError<GetDeviceInstanceError>

impl Client

pub fn get_device_pool(&self) -> GetDevicePoolFluentBuilder

Constructs a fluent builder for the GetDevicePool operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The device pool’s ARN.

    
    
• On success, responds with GetDevicePoolOutput with field(s):
  • device_pool(Option<DevicePool>):

    An object that contains information about the requested device pool.

• On failure, responds with SdkError<GetDevicePoolError>

impl Client

pub fn get_device_pool_compatibility( &self, ) -> GetDevicePoolCompatibilityFluentBuilder

Constructs a fluent builder for the GetDevicePoolCompatibility operation.

• The fluent builder is configurable:
  • device_pool_arn(impl Into<String>) / set_device_pool_arn(Option<String>):
    required: true
    

    The device pool’s ARN.

    
    
  • app_arn(impl Into<String>) / set_app_arn(Option<String>):
    required: false
    

    The ARN of the app that is associated with the specified device pool.

    
    
  • test_type(TestType) / set_test_type(Option<TestType>):
    required: false
    

    The test type for the specified device pool.

    Allowed values include the following:

    • BUILTIN_FUZZ.

    • BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the same time.

    • APPIUM_JAVA_JUNIT.

    • APPIUM_JAVA_TESTNG.

    • APPIUM_PYTHON.

    • APPIUM_NODE.

    • APPIUM_RUBY.

    • APPIUM_WEB_JAVA_JUNIT.

    • APPIUM_WEB_JAVA_TESTNG.

    • APPIUM_WEB_PYTHON.

    • APPIUM_WEB_NODE.

    • APPIUM_WEB_RUBY.

    • CALABASH.

    • INSTRUMENTATION.

    • UIAUTOMATION.

    • UIAUTOMATOR.

    • XCTEST.

    • XCTEST_UI.

    
    
  • test(ScheduleRunTest) / set_test(Option<ScheduleRunTest>):
    required: false
    

    Information about the uploaded test to be run against the device pool.

    
    
  • configuration(ScheduleRunConfiguration) / set_configuration(Option<ScheduleRunConfiguration>):
    required: false
    

    An object that contains information about the settings for a run.

    
    
• On success, responds with GetDevicePoolCompatibilityOutput with field(s):
  • compatible_devices(Option<Vec::<DevicePoolCompatibilityResult>>):

    Information about compatible devices.

  • incompatible_devices(Option<Vec::<DevicePoolCompatibilityResult>>):

    Information about incompatible devices.

• On failure, responds with SdkError<GetDevicePoolCompatibilityError>

impl Client

pub fn get_instance_profile(&self) -> GetInstanceProfileFluentBuilder

Constructs a fluent builder for the GetInstanceProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of an instance profile.

    
    
• On success, responds with GetInstanceProfileOutput with field(s):
  • instance_profile(Option<InstanceProfile>):

    An object that contains information about an instance profile.

• On failure, responds with SdkError<GetInstanceProfileError>

impl Client

pub fn get_job(&self) -> GetJobFluentBuilder

Constructs a fluent builder for the GetJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The job’s ARN.

    
    
• On success, responds with GetJobOutput with field(s):
  • job(Option<Job>):

    An object that contains information about the requested job.

• On failure, responds with SdkError<GetJobError>

impl Client

pub fn get_network_profile(&self) -> GetNetworkProfileFluentBuilder

Constructs a fluent builder for the GetNetworkProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The ARN of the network profile to return information about.

    
    
• On success, responds with GetNetworkProfileOutput with field(s):
  • network_profile(Option<NetworkProfile>):

    The network profile.

• On failure, responds with SdkError<GetNetworkProfileError>

impl Client

pub fn get_offering_status(&self) -> GetOfferingStatusFluentBuilder

Constructs a fluent builder for the GetOfferingStatus operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with GetOfferingStatusOutput with field(s):
  • current(Option<HashMap::<String, OfferingStatus>>):

    When specified, gets the offering status for the current period.

  • next_period(Option<HashMap::<String, OfferingStatus>>):

    When specified, gets the offering status for the next period.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<GetOfferingStatusError>

impl Client

pub fn get_project(&self) -> GetProjectFluentBuilder

Constructs a fluent builder for the GetProject operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The project’s ARN.

    
    
• On success, responds with GetProjectOutput with field(s):
  • project(Option<Project>):

    The project to get information about.

• On failure, responds with SdkError<GetProjectError>

impl Client

pub fn get_remote_access_session(&self) -> GetRemoteAccessSessionFluentBuilder

Constructs a fluent builder for the GetRemoteAccessSession operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

    
    
• On success, responds with GetRemoteAccessSessionOutput with field(s):
  • remote_access_session(Option<RemoteAccessSession>):

    A container that lists detailed information about the remote access session.

• On failure, responds with SdkError<GetRemoteAccessSessionError>

impl Client

pub fn get_run(&self) -> GetRunFluentBuilder

Constructs a fluent builder for the GetRun operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The run’s ARN.

    
    
• On success, responds with GetRunOutput with field(s):
  • run(Option<Run>):

    The run to get results from.

• On failure, responds with SdkError<GetRunError>

impl Client

pub fn get_suite(&self) -> GetSuiteFluentBuilder

Constructs a fluent builder for the GetSuite operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The suite’s ARN.

    
    
• On success, responds with GetSuiteOutput with field(s):
  • suite(Option<Suite>):

    A collection of one or more tests.

• On failure, responds with SdkError<GetSuiteError>

impl Client

pub fn get_test(&self) -> GetTestFluentBuilder

Constructs a fluent builder for the GetTest operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The test’s ARN.

    
    
• On success, responds with GetTestOutput with field(s):
  • test(Option<Test>):

    A test condition that is evaluated.

• On failure, responds with SdkError<GetTestError>

impl Client

pub fn get_test_grid_project(&self) -> GetTestGridProjectFluentBuilder

Constructs a fluent builder for the GetTestGridProject operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.

    
    
• On success, responds with GetTestGridProjectOutput with field(s):
  • test_grid_project(Option<TestGridProject>):

    A TestGridProject.

• On failure, responds with SdkError<GetTestGridProjectError>

impl Client

pub fn get_test_grid_session(&self) -> GetTestGridSessionFluentBuilder

Constructs a fluent builder for the GetTestGridSession operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: false
    

    The ARN for the project that this session belongs to. See CreateTestGridProject and ListTestGridProjects.

    
    
  • session_id(impl Into<String>) / set_session_id(Option<String>):
    required: false
    

    An ID associated with this session.

    
    
  • session_arn(impl Into<String>) / set_session_arn(Option<String>):
    required: false
    

    An ARN that uniquely identifies a TestGridSession.

    
    
• On success, responds with GetTestGridSessionOutput with field(s):
  • test_grid_session(Option<TestGridSession>):

    The TestGridSession that was requested.

• On failure, responds with SdkError<GetTestGridSessionError>

impl Client

pub fn get_upload(&self) -> GetUploadFluentBuilder

Constructs a fluent builder for the GetUpload operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The upload’s ARN.

    
    
• On success, responds with GetUploadOutput with field(s):
  • upload(Option<Upload>):

    An app or a set of one or more tests to upload or that have been uploaded.

• On failure, responds with SdkError<GetUploadError>

impl Client

pub fn get_vpce_configuration(&self) -> GetVPCEConfigurationFluentBuilder

Constructs a fluent builder for the GetVPCEConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.

    
    
• On success, responds with GetVpceConfigurationOutput with field(s):
  • vpce_configuration(Option<VpceConfiguration>):

    An object that contains information about your VPC endpoint configuration.

• On failure, responds with SdkError<GetVPCEConfigurationError>

impl Client

pub fn install_to_remote_access_session( &self, ) -> InstallToRemoteAccessSessionFluentBuilder

Constructs a fluent builder for the InstallToRemoteAccessSession operation.

• The fluent builder is configurable:
  • remote_access_session_arn(impl Into<String>) / set_remote_access_session_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

    
    
  • app_arn(impl Into<String>) / set_app_arn(Option<String>):
    required: true
    

    The ARN of the app about which you are requesting information.

    
    
• On success, responds with InstallToRemoteAccessSessionOutput with field(s):
  • app_upload(Option<Upload>):

    An app to upload or that has been uploaded.

• On failure, responds with SdkError<InstallToRemoteAccessSessionError>

impl Client

pub fn list_artifacts(&self) -> ListArtifactsFluentBuilder

Constructs a fluent builder for the ListArtifacts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The run, job, suite, or test ARN.

    
    
  • r#type(ArtifactCategory) / set_type(Option<ArtifactCategory>):
    required: true
    

    The artifacts’ type.

    Allowed values include:

    • FILE

    • LOG

    • SCREENSHOT

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListArtifactsOutput with field(s):
  • artifacts(Option<Vec::<Artifact>>):

    Information about the artifacts.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListArtifactsError>

impl Client

pub fn list_device_instances(&self) -> ListDeviceInstancesFluentBuilder

Constructs a fluent builder for the ListDeviceInstances operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An integer that specifies the maximum number of items you want to return in the API response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListDeviceInstancesOutput with field(s):
  • device_instances(Option<Vec::<DeviceInstance>>):

    An object that contains information about your device instances.

  • next_token(Option<String>):

    An identifier that can be used in the next call to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListDeviceInstancesError>

impl Client

pub fn list_device_pools(&self) -> ListDevicePoolsFluentBuilder

Constructs a fluent builder for the ListDevicePools operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The project ARN.

    
    
  • r#type(DevicePoolType) / set_type(Option<DevicePoolType>):
    required: false
    

    The device pools’ type.

    Allowed values include:

    • CURATED: A device pool that is created and managed by AWS Device Farm.

    • PRIVATE: A device pool that is created and managed by the device pool developer.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListDevicePoolsOutput with field(s):
  • device_pools(Option<Vec::<DevicePool>>):

    Information about the device pools.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListDevicePoolsError>

impl Client

pub fn list_devices(&self) -> ListDevicesFluentBuilder

Constructs a fluent builder for the ListDevices operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the project.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
  • filters(DeviceFilter) / set_filters(Option<Vec::<DeviceFilter>>):
    required: false
    

    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.

    
    
• On success, responds with ListDevicesOutput with field(s):
  • devices(Option<Vec::<Device>>):

    Information about the devices.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListDevicesError>

impl Client

pub fn list_instance_profiles(&self) -> ListInstanceProfilesFluentBuilder

Constructs a fluent builder for the ListInstanceProfiles operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An integer that specifies the maximum number of items you want to return in the API response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListInstanceProfilesOutput with field(s):
  • instance_profiles(Option<Vec::<InstanceProfile>>):

    An object that contains information about your instance profiles.

  • next_token(Option<String>):

    An identifier that can be used in the next call to this operation to return the next set of items in the list.

• On failure, responds with SdkError<ListInstanceProfilesError>

impl Client

pub fn list_jobs(&self) -> ListJobsFluentBuilder

Constructs a fluent builder for the ListJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The run’s Amazon Resource Name (ARN).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListJobsOutput with field(s):
  • jobs(Option<Vec::<Job>>):

    Information about the jobs.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListJobsError>

impl Client

pub fn list_network_profiles(&self) -> ListNetworkProfilesFluentBuilder

Constructs a fluent builder for the ListNetworkProfiles operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

    
    
  • r#type(NetworkProfileType) / set_type(Option<NetworkProfileType>):
    required: false
    

    The type of network profile to return information about. Valid values are listed here.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListNetworkProfilesOutput with field(s):
  • network_profiles(Option<Vec::<NetworkProfile>>):

    A list of the available network profiles.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListNetworkProfilesError>

impl Client

pub fn list_offering_promotions(&self) -> ListOfferingPromotionsFluentBuilder

Constructs a fluent builder for the ListOfferingPromotions operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListOfferingPromotionsOutput with field(s):
  • offering_promotions(Option<Vec::<OfferingPromotion>>):

    Information about the offering promotions.

  • next_token(Option<String>):

    An identifier to be used in the next call to this operation, to return the next set of items in the list.

• On failure, responds with SdkError<ListOfferingPromotionsError>

impl Client

pub fn list_offering_transactions( &self, ) -> ListOfferingTransactionsFluentBuilder

Constructs a fluent builder for the ListOfferingTransactions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListOfferingTransactionsOutput with field(s):
  • offering_transactions(Option<Vec::<OfferingTransaction>>):

    The audit log of subscriptions you have purchased and modified through AWS Device Farm.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListOfferingTransactionsError>

impl Client

pub fn list_offerings(&self) -> ListOfferingsFluentBuilder

Constructs a fluent builder for the ListOfferings operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListOfferingsOutput with field(s):
  • offerings(Option<Vec::<Offering>>):

    A value that represents the list offering results.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListOfferingsError>

impl Client

pub fn list_projects(&self) -> ListProjectsFluentBuilder

Constructs a fluent builder for the ListProjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: false
    

    Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListProjectsOutput with field(s):
  • projects(Option<Vec::<Project>>):

    Information about the projects.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListProjectsError>

impl Client

pub fn list_remote_access_sessions( &self, ) -> ListRemoteAccessSessionsFluentBuilder

Constructs a fluent builder for the ListRemoteAccessSessions operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project about which you are requesting information.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListRemoteAccessSessionsOutput with field(s):
  • remote_access_sessions(Option<Vec::<RemoteAccessSession>>):

    A container that represents the metadata from the service about each remote access session you are requesting.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListRemoteAccessSessionsError>

impl Client

pub fn list_runs(&self) -> ListRunsFluentBuilder

Constructs a fluent builder for the ListRuns operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to list runs.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListRunsOutput with field(s):
  • runs(Option<Vec::<Run>>):

    Information about the runs.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListRunsError>

impl Client

pub fn list_samples(&self) -> ListSamplesFluentBuilder

Constructs a fluent builder for the ListSamples operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the job used to list samples.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListSamplesOutput with field(s):
  • samples(Option<Vec::<Sample>>):

    Information about the samples.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListSamplesError>

impl Client

pub fn list_suites(&self) -> ListSuitesFluentBuilder

Constructs a fluent builder for the ListSuites operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The job’s Amazon Resource Name (ARN).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListSuitesOutput with field(s):
  • suites(Option<Vec::<Suite>>):

    Information about the suites.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListSuitesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_test_grid_projects(&self) -> ListTestGridProjectsFluentBuilder

Constructs a fluent builder for the ListTestGridProjects operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_result(i32) / set_max_result(Option<i32>):
    required: false
    

    Return no more than this number of results.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    From a response, used to continue a paginated listing.

    
    
• On success, responds with ListTestGridProjectsOutput with field(s):
  • test_grid_projects(Option<Vec::<TestGridProject>>):

    The list of TestGridProjects, based on a ListTestGridProjectsRequest.

  • next_token(Option<String>):

    Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.

• On failure, responds with SdkError<ListTestGridProjectsError>

impl Client

pub fn list_test_grid_session_actions( &self, ) -> ListTestGridSessionActionsFluentBuilder

Constructs a fluent builder for the ListTestGridSessionActions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • session_arn(impl Into<String>) / set_session_arn(Option<String>):
    required: true
    

    The ARN of the session to retrieve.

    
    
  • max_result(i32) / set_max_result(Option<i32>):
    required: false
    

    The maximum number of sessions to return per response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
• On success, responds with ListTestGridSessionActionsOutput with field(s):
  • actions(Option<Vec::<TestGridSessionAction>>):

    The action taken by the session.

  • next_token(Option<String>):

    Pagination token.

• On failure, responds with SdkError<ListTestGridSessionActionsError>

impl Client

pub fn list_test_grid_session_artifacts( &self, ) -> ListTestGridSessionArtifactsFluentBuilder

Constructs a fluent builder for the ListTestGridSessionArtifacts operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • session_arn(impl Into<String>) / set_session_arn(Option<String>):
    required: true
    

    The ARN of a TestGridSession.

    
    
  • r#type(TestGridSessionArtifactCategory) / set_type(Option<TestGridSessionArtifactCategory>):
    required: false
    

    Limit results to a specified type of artifact.

    
    
  • max_result(i32) / set_max_result(Option<i32>):
    required: false
    

    The maximum number of results to be returned by a request.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
• On success, responds with ListTestGridSessionArtifactsOutput with field(s):
  • artifacts(Option<Vec::<TestGridSessionArtifact>>):

    A list of test grid session artifacts for a TestGridSession.

  • next_token(Option<String>):

    Pagination token.

• On failure, responds with SdkError<ListTestGridSessionArtifactsError>

impl Client

pub fn list_test_grid_sessions(&self) -> ListTestGridSessionsFluentBuilder

Constructs a fluent builder for the ListTestGridSessions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    ARN of a TestGridProject.

    
    
  • status(TestGridSessionStatus) / set_status(Option<TestGridSessionStatus>):
    required: false
    

    Return only sessions in this state.

    
    
  • creation_time_after(DateTime) / set_creation_time_after(Option<DateTime>):
    required: false
    

    Return only sessions created after this time.

    
    
  • creation_time_before(DateTime) / set_creation_time_before(Option<DateTime>):
    required: false
    

    Return only sessions created before this time.

    
    
  • end_time_after(DateTime) / set_end_time_after(Option<DateTime>):
    required: false
    

    Return only sessions that ended after this time.

    
    
  • end_time_before(DateTime) / set_end_time_before(Option<DateTime>):
    required: false
    

    Return only sessions that ended before this time.

    
    
  • max_result(i32) / set_max_result(Option<i32>):
    required: false
    

    Return only this many results at a time.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    Pagination token.

    
    
• On success, responds with ListTestGridSessionsOutput with field(s):
  • test_grid_sessions(Option<Vec::<TestGridSession>>):

    The sessions that match the criteria in a ListTestGridSessionsRequest.

  • next_token(Option<String>):

    Pagination token.

• On failure, responds with SdkError<ListTestGridSessionsError>

impl Client

pub fn list_tests(&self) -> ListTestsFluentBuilder

Constructs a fluent builder for the ListTests operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The test suite’s Amazon Resource Name (ARN).

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListTestsOutput with field(s):
  • tests(Option<Vec::<Test>>):

    Information about the tests.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListTestsError>

impl Client

pub fn list_unique_problems(&self) -> ListUniqueProblemsFluentBuilder

Constructs a fluent builder for the ListUniqueProblems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The unique problems’ ARNs.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListUniqueProblemsOutput with field(s):
  • unique_problems(Option<HashMap::<ExecutionResult, Vec::<UniqueProblem>>>):

    Information about the unique problems.

    Allowed values include:

    • PENDING

    • PASSED

    • WARNED

    • FAILED

    • SKIPPED

    • ERRORED

    • STOPPED

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListUniqueProblemsError>

impl Client

pub fn list_uploads(&self) -> ListUploadsFluentBuilder

Constructs a fluent builder for the ListUploads operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to list uploads.

    
    
  • r#type(UploadType) / set_type(Option<UploadType>):
    required: false
    

    The type of upload.

    Must be one of the following values:

    • ANDROID_APP

    • IOS_APP

    • WEB_APP

    • EXTERNAL_DATA

    • APPIUM_JAVA_JUNIT_TEST_PACKAGE

    • APPIUM_JAVA_TESTNG_TEST_PACKAGE

    • APPIUM_PYTHON_TEST_PACKAGE

    • APPIUM_NODE_TEST_PACKAGE

    • APPIUM_RUBY_TEST_PACKAGE

    • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

    • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

    • APPIUM_WEB_PYTHON_TEST_PACKAGE

    • APPIUM_WEB_NODE_TEST_PACKAGE

    • APPIUM_WEB_RUBY_TEST_PACKAGE

    • CALABASH_TEST_PACKAGE

    • INSTRUMENTATION_TEST_PACKAGE

    • UIAUTOMATION_TEST_PACKAGE

    • UIAUTOMATOR_TEST_PACKAGE

    • XCTEST_TEST_PACKAGE

    • XCTEST_UI_TEST_PACKAGE

    • APPIUM_JAVA_JUNIT_TEST_SPEC

    • APPIUM_JAVA_TESTNG_TEST_SPEC

    • APPIUM_PYTHON_TEST_SPEC

    • APPIUM_NODE_TEST_SPEC

    • APPIUM_RUBY_TEST_SPEC

    • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

    • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

    • APPIUM_WEB_PYTHON_TEST_SPEC

    • APPIUM_WEB_NODE_TEST_SPEC

    • APPIUM_WEB_RUBY_TEST_SPEC

    • INSTRUMENTATION_TEST_SPEC

    • XCTEST_UI_TEST_SPEC

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListUploadsOutput with field(s):
  • uploads(Option<Vec::<Upload>>):

    Information about the uploads.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListUploadsError>

impl Client

pub fn list_vpce_configurations(&self) -> ListVPCEConfigurationsFluentBuilder

Constructs a fluent builder for the ListVPCEConfigurations operation.

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    An integer that specifies the maximum number of items you want to return in the API response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListVpceConfigurationsOutput with field(s):
  • vpce_configurations(Option<Vec::<VpceConfiguration>>):

    An array of VPCEConfiguration objects that contain information about your VPC endpoint configuration.

  • next_token(Option<String>):

    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.

• On failure, responds with SdkError<ListVPCEConfigurationsError>

impl Client

pub fn purchase_offering(&self) -> PurchaseOfferingFluentBuilder

Constructs a fluent builder for the PurchaseOffering operation.

• The fluent builder is configurable:
  • offering_id(impl Into<String>) / set_offering_id(Option<String>):
    required: true
    

    The ID of the offering.

    
    
  • quantity(i32) / set_quantity(Option<i32>):
    required: true
    

    The number of device slots to purchase in an offering request.

    
    
  • offering_promotion_id(impl Into<String>) / set_offering_promotion_id(Option<String>):
    required: false
    

    The ID of the offering promotion to be applied to the purchase.

    
    
• On success, responds with PurchaseOfferingOutput with field(s):
  • offering_transaction(Option<OfferingTransaction>):

    Represents the offering transaction for the purchase result.

• On failure, responds with SdkError<PurchaseOfferingError>

impl Client

pub fn renew_offering(&self) -> RenewOfferingFluentBuilder

Constructs a fluent builder for the RenewOffering operation.

• The fluent builder is configurable:
  • offering_id(impl Into<String>) / set_offering_id(Option<String>):
    required: true
    

    The ID of a request to renew an offering.

    
    
  • quantity(i32) / set_quantity(Option<i32>):
    required: true
    

    The quantity requested in an offering renewal.

    
    
• On success, responds with RenewOfferingOutput with field(s):
  • offering_transaction(Option<OfferingTransaction>):

    Represents the status of the offering transaction for the renewal.

• On failure, responds with SdkError<RenewOfferingError>

impl Client

pub fn schedule_run(&self) -> ScheduleRunFluentBuilder

Constructs a fluent builder for the ScheduleRun operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    The ARN of the project for the run to be scheduled.

    
    
  • app_arn(impl Into<String>) / set_app_arn(Option<String>):
    required: false
    

    The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.

    
    
  • device_pool_arn(impl Into<String>) / set_device_pool_arn(Option<String>):
    required: false
    

    The ARN of the device pool for the run to be scheduled.

    
    
  • device_selection_configuration(DeviceSelectionConfiguration) / set_device_selection_configuration(Option<DeviceSelectionConfiguration>):
    required: false
    

    The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices to be included in the run.

    Either devicePoolArn or deviceSelectionConfiguration is required in a request.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name for the run to be scheduled.

    
    
  • test(ScheduleRunTest) / set_test(Option<ScheduleRunTest>):
    required: true
    

    Information about the test for the run to be scheduled.

    
    
  • configuration(ScheduleRunConfiguration) / set_configuration(Option<ScheduleRunConfiguration>):
    required: false
    

    Information about the settings for the run to be scheduled.

    
    
  • execution_configuration(ExecutionConfiguration) / set_execution_configuration(Option<ExecutionConfiguration>):
    required: false
    

    Specifies configuration information about a test run, such as the execution timeout (in minutes).

    
    
• On success, responds with ScheduleRunOutput with field(s):
  • run(Option<Run>):

    Information about the scheduled run.

• On failure, responds with SdkError<ScheduleRunError>

impl Client

pub fn stop_job(&self) -> StopJobFluentBuilder

Constructs a fluent builder for the StopJob operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

    
    
• On success, responds with StopJobOutput with field(s):
  • job(Option<Job>):

    The job that was stopped.

• On failure, responds with SdkError<StopJobError>

impl Client

pub fn stop_remote_access_session(&self) -> StopRemoteAccessSessionFluentBuilder

Constructs a fluent builder for the StopRemoteAccessSession operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the remote access session to stop.

    
    
• On success, responds with StopRemoteAccessSessionOutput with field(s):
  • remote_access_session(Option<RemoteAccessSession>):

    A container that represents the metadata from the service about the remote access session you are stopping.

• On failure, responds with SdkError<StopRemoteAccessSessionError>

impl Client

pub fn stop_run(&self) -> StopRunFluentBuilder

Constructs a fluent builder for the StopRun operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.

    
    
• On success, responds with StopRunOutput with field(s):
  • run(Option<Run>):

    The run that was stopped.

• On failure, responds with SdkError<StopRunError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters. Tag values can have a maximum length of 256 characters.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to be removed.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_device_instance(&self) -> UpdateDeviceInstanceFluentBuilder

Constructs a fluent builder for the UpdateDeviceInstance operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the device instance.

    
    
  • profile_arn(impl Into<String>) / set_profile_arn(Option<String>):
    required: false
    

    The ARN of the profile that you want to associate with the device instance.

    
    
  • labels(impl Into<String>) / set_labels(Option<Vec::<String>>):
    required: false
    

    An array of strings that you want to associate with the device instance.

    
    
• On success, responds with UpdateDeviceInstanceOutput with field(s):
  • device_instance(Option<DeviceInstance>):

    An object that contains information about your device instance.

• On failure, responds with SdkError<UpdateDeviceInstanceError>

impl Client

pub fn update_device_pool(&self) -> UpdateDevicePoolFluentBuilder

Constructs a fluent builder for the UpdateDevicePool operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the Device Farm device pool to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A string that represents the name of the device pool to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the device pool to update.

    
    
  • rules(Rule) / set_rules(Option<Vec::<Rule>>):
    required: false
    

    Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your request, the update replaces the existing rules.

    
    
  • max_devices(i32) / set_max_devices(Option<i32>):
    required: false
    

    The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

    By specifying the maximum number of devices, you can control the costs that you incur by running tests.

    If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

    
    
  • clear_max_devices(bool) / set_clear_max_devices(Option<bool>):
    required: false
    

    Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria specified in the rules parameter.

    If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

    
    
• On success, responds with UpdateDevicePoolOutput with field(s):
  • device_pool(Option<DevicePool>):

    The device pool you just updated.

• On failure, responds with SdkError<UpdateDevicePoolError>

impl Client

pub fn update_instance_profile(&self) -> UpdateInstanceProfileFluentBuilder

Constructs a fluent builder for the UpdateInstanceProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the instance profile.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The updated name for your instance profile.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The updated description for your instance profile.

    
    
  • package_cleanup(bool) / set_package_cleanup(Option<bool>):
    required: false
    

    The updated choice for whether you want to specify package cleanup. The default value is false for private devices.

    
    
  • exclude_app_packages_from_cleanup(impl Into<String>) / set_exclude_app_packages_from_cleanup(Option<Vec::<String>>):
    required: false
    

    An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run is over.

    The list of packages is only considered if you set packageCleanup to true.

    
    
  • reboot_after_use(bool) / set_reboot_after_use(Option<bool>):
    required: false
    

    The updated choice for whether you want to reboot the device after use. The default value is true.

    
    
• On success, responds with UpdateInstanceProfileOutput with field(s):
  • instance_profile(Option<InstanceProfile>):

    An object that contains information about your instance profile.

• On failure, responds with SdkError<UpdateInstanceProfileError>

impl Client

pub fn update_network_profile(&self) -> UpdateNetworkProfileFluentBuilder

Constructs a fluent builder for the UpdateNetworkProfile operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the network profile about which you are returning information.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description of the network profile about which you are returning information.

    
    
  • r#type(NetworkProfileType) / set_type(Option<NetworkProfileType>):
    required: false
    

    The type of network profile to return information about. Valid values are listed here.

    
    
  • uplink_bandwidth_bits(i64) / set_uplink_bandwidth_bits(Option<i64>):
    required: false
    

    The data throughput rate in bits per second, as an integer from 0 to 104857600.

    
    
  • downlink_bandwidth_bits(i64) / set_downlink_bandwidth_bits(Option<i64>):
    required: false
    

    The data throughput rate in bits per second, as an integer from 0 to 104857600.

    
    
  • uplink_delay_ms(i64) / set_uplink_delay_ms(Option<i64>):
    required: false
    

    Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

    
    
  • downlink_delay_ms(i64) / set_downlink_delay_ms(Option<i64>):
    required: false
    

    Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

    
    
  • uplink_jitter_ms(i64) / set_uplink_jitter_ms(Option<i64>):
    required: false
    

    Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

    
    
  • downlink_jitter_ms(i64) / set_downlink_jitter_ms(Option<i64>):
    required: false
    

    Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

    
    
  • uplink_loss_percent(i32) / set_uplink_loss_percent(Option<i32>):
    required: false
    

    Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

    
    
  • downlink_loss_percent(i32) / set_downlink_loss_percent(Option<i32>):
    required: false
    

    Proportion of received packets that fail to arrive from 0 to 100 percent.

    
    
• On success, responds with UpdateNetworkProfileOutput with field(s):
  • network_profile(Option<NetworkProfile>):

    A list of the available network profiles.

• On failure, responds with SdkError<UpdateNetworkProfileError>

impl Client

pub fn update_project(&self) -> UpdateProjectFluentBuilder

Constructs a fluent builder for the UpdateProject operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the project whose name to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A string that represents the new name of the project that you are updating.

    
    
  • default_job_timeout_minutes(i32) / set_default_job_timeout_minutes(Option<i32>):
    required: false
    

    The number of minutes a test run in the project executes before it times out.

    
    
  • vpc_config(VpcConfig) / set_vpc_config(Option<VpcConfig>):
    required: false
    

    The VPC security groups and subnets that are attached to a project.

    
    
• On success, responds with UpdateProjectOutput with field(s):
  • project(Option<Project>):

    The project to update.

• On failure, responds with SdkError<UpdateProjectError>

impl Client

pub fn update_test_grid_project(&self) -> UpdateTestGridProjectFluentBuilder

Constructs a fluent builder for the UpdateTestGridProject operation.

• The fluent builder is configurable:
  • project_arn(impl Into<String>) / set_project_arn(Option<String>):
    required: true
    

    ARN of the project to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    Human-readable name for the project.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    Human-readable description for the project.

    
    
  • vpc_config(TestGridVpcConfig) / set_vpc_config(Option<TestGridVpcConfig>):
    required: false
    

    The VPC security groups and subnets that are attached to a project.

    
    
• On success, responds with UpdateTestGridProjectOutput with field(s):
  • test_grid_project(Option<TestGridProject>):

    The project, including updated information.

• On failure, responds with SdkError<UpdateTestGridProjectError>

impl Client

pub fn update_upload(&self) -> UpdateUploadFluentBuilder

Constructs a fluent builder for the UpdateUpload operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the uploaded test spec.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The upload’s test spec file name. The name must not contain any forward slashes (/). The test spec file name must end with the .yaml or .yml file extension.

    
    
  • content_type(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The upload’s content type (for example, application/x-yaml).

    
    
  • edit_content(bool) / set_edit_content(Option<bool>):
    required: false
    

    Set to true if the YAML file has changed and must be updated. Otherwise, set to false.

    
    
• On success, responds with UpdateUploadOutput with field(s):
  • upload(Option<Upload>):

    A test spec uploaded to Device Farm.

• On failure, responds with SdkError<UpdateUploadError>

impl Client

pub fn update_vpce_configuration(&self) -> UpdateVPCEConfigurationFluentBuilder

Constructs a fluent builder for the UpdateVPCEConfiguration operation.

• The fluent builder is configurable:
  • arn(impl Into<String>) / set_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.

    
    
  • vpce_configuration_name(impl Into<String>) / set_vpce_configuration_name(Option<String>):
    required: false
    

    The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.

    
    
  • vpce_service_name(impl Into<String>) / set_vpce_service_name(Option<String>):
    required: false
    

    The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.

    
    
  • service_dns_name(impl Into<String>) / set_service_dns_name(Option<String>):
    required: false
    

    The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in use on the internet.

    
    
  • vpce_configuration_description(impl Into<String>) / set_vpce_configuration_description(Option<String>):
    required: false
    

    An optional description that provides details about your VPC endpoint configuration.

    
    
• On success, responds with UpdateVpceConfigurationOutput with field(s):
  • vpce_configuration(Option<VpceConfiguration>):

    An object that contains information about your VPC endpoint configuration.

• On failure, responds with SdkError<UpdateVPCEConfigurationError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.