pub struct Client { /* private fields */ }
Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_devicefarm::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_devicefarm::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_devicefarm::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the CreateDevicePool operation.

Constructs a fluent builder for the CreateInstanceProfile operation.

Constructs a fluent builder for the CreateNetworkProfile operation.

Constructs a fluent builder for the CreateProject operation.

Constructs a fluent builder for the CreateRemoteAccessSession operation.

Constructs a fluent builder for the CreateTestGridProject operation.

Constructs a fluent builder for the CreateTestGridUrl operation.

Constructs a fluent builder for the CreateUpload operation.

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

      The ARN of the project for the upload.

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

      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>):

      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>):

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

  • On success, responds with CreateUploadOutput with field(s):
  • On failure, responds with SdkError<CreateUploadError>

Constructs a fluent builder for the CreateVPCEConfiguration operation.

Constructs a fluent builder for the DeleteDevicePool operation.

Constructs a fluent builder for the DeleteInstanceProfile operation.

Constructs a fluent builder for the DeleteNetworkProfile operation.

Constructs a fluent builder for the DeleteProject operation.

Constructs a fluent builder for the DeleteRemoteAccessSession operation.

Constructs a fluent builder for the DeleteRun operation.

Constructs a fluent builder for the DeleteTestGridProject operation.

Constructs a fluent builder for the DeleteUpload operation.

Constructs a fluent builder for the DeleteVPCEConfiguration operation.

Constructs a fluent builder for the GetAccountSettings operation.

Constructs a fluent builder for the GetDevice operation.

Constructs a fluent builder for the GetDeviceInstance operation.

Constructs a fluent builder for the GetDevicePool operation.

Constructs a fluent builder for the GetDevicePoolCompatibility operation.

Constructs a fluent builder for the GetInstanceProfile operation.

Constructs a fluent builder for the GetJob operation.

Constructs a fluent builder for the GetNetworkProfile operation.

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

Constructs a fluent builder for the GetProject operation.

Constructs a fluent builder for the GetRemoteAccessSession operation.

Constructs a fluent builder for the GetRun operation.

Constructs a fluent builder for the GetSuite operation.

Constructs a fluent builder for the GetTest operation.

Constructs a fluent builder for the GetTestGridProject operation.

Constructs a fluent builder for the GetTestGridSession operation.

Constructs a fluent builder for the GetUpload operation.

Constructs a fluent builder for the GetVPCEConfiguration operation.

Constructs a fluent builder for the InstallToRemoteAccessSession operation.

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

Constructs a fluent builder for the ListDeviceInstances operation.

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

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>):

      The Amazon Resource Name (ARN) of the project.

    • next_token(impl Into<String>) / set_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.

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

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

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

        Allowed values include:

        • ARN: The Amazon Resource Name (ARN) of the device (for example, arn:aws:devicefarm:us-west-2::device:12345Example).

        • PLATFORM: The device platform. Valid values are ANDROID or IOS.

        • OS_VERSION: The operating system version (for example, 10.3.2).

        • MODEL: The device model (for example, iPad 5th Gen).

        • AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

        • FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.

        • MANUFACTURER: The device manufacturer (for example, Apple).

        • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.

        • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because remote debugging is no longer supported, this attribute is ignored.

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

        • INSTANCE_LABELS: The label of the device instance.

        • FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.

      • Operator: The filter operator.

        • The EQUALS operator is available for every attribute except INSTANCE_LABELS.

        • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

        • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.

        • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

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

        • The IN and NOT_IN operators take a values array that has one or more elements.

        • The other operators require an array with a single element.

        • In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.

  • 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>

Constructs a fluent builder for the ListInstanceProfiles operation.

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

Constructs a fluent builder for the ListNetworkProfiles operation.

Constructs a fluent builder for the ListOfferingPromotions operation.

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

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

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

Constructs a fluent builder for the ListRemoteAccessSessions operation.

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

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

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

Constructs a fluent builder for the ListTagsForResource operation.

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

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

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

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

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

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

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>):

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

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

      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>):

      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>

Constructs a fluent builder for the ListVPCEConfigurations operation.

Constructs a fluent builder for the PurchaseOffering operation.

Constructs a fluent builder for the RenewOffering operation.

Constructs a fluent builder for the ScheduleRun operation.

Constructs a fluent builder for the StopJob operation.

Constructs a fluent builder for the StopRemoteAccessSession operation.

Constructs a fluent builder for the StopRun operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateDeviceInstance operation.

Constructs a fluent builder for the UpdateDevicePool operation.

Constructs a fluent builder for the UpdateInstanceProfile operation.

Constructs a fluent builder for the UpdateNetworkProfile operation.

Constructs a fluent builder for the UpdateProject operation.

Constructs a fluent builder for the UpdateTestGridProject operation.

Constructs a fluent builder for the UpdateUpload operation.

Constructs a fluent builder for the UpdateVPCEConfiguration operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more