Skip to content

get_device_pool_compatibility

get_device_pool_compatibility(
    device_pool_arn: AmazonResourceName,
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
    app_arn: Optional[AmazonResourceName] = None,
    test_type: Optional[TestType] = None,
    test: Optional[ScheduleRunTest] = None,
    configuration: Optional[ScheduleRunConfiguration] = None,
    project_arn: Optional[AmazonResourceName] = None,
) -> GetDevicePoolCompatibilityResult

Gets information about compatibility with a device pool.

Parameters:

  • device_pool_arn (AmazonResourceName) –

    The device pool's ARN.

  • app_arn (Optional[AmazonResourceName], default: None ) –

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

  • test_type (Optional[TestType], default: None ) –

    The test type for the specified device pool.

    Allowed values include the following:

    • BUILTIN_FUZZ.

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

    • INSTRUMENTATION.

    • XCTEST.

    • XCTEST_UI.

  • test (Optional[ScheduleRunTest], default: None ) –

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

  • configuration (Optional[ScheduleRunConfiguration], default: None ) –

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

  • project_arn (Optional[AmazonResourceName], default: None ) –

    The ARN of the project for which you want to check device pool compatibility.

Raises:

Examples:

To get information about the compatibility of a device pool The following example returns information about the compatibility of a specific device pool, given its ARN.

>>> client.get_device_pool_compatibility(device_pool_arn='arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID', app_arn='arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID', test_type='APPIUM_PYTHON')
Source code in docs_src/capo_device_farm/_services/device_farm.py
def get_device_pool_compatibility(
    self,
    device_pool_arn: "capo_device_farm.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
    app_arn: Optional[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ] = None,
    test_type: Optional["capo_device_farm.types.test_type.TestType"] = None,
    test: Optional[
        "capo_device_farm.types.schedule_run_test.ScheduleRunTest"
    ] = None,
    configuration: Optional[
        "capo_device_farm.types.schedule_run_configuration.ScheduleRunConfiguration"
    ] = None,
    project_arn: Optional[
        "capo_device_farm.types.amazon_resource_name.AmazonResourceName"
    ] = None,
) -> "capo_device_farm.types.get_device_pool_compatibility_result.GetDevicePoolCompatibilityResult":
    """<p>Gets information about compatibility with a device pool.</p>

    Args:
        device_pool_arn: <p>The device pool's ARN.</p>
        app_arn: <p>The ARN of the app that is associated with the specified device pool.</p>
        test_type: <p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ.</p> </li> <li> <p>APPIUM_JAVA_JUNIT.</p> </li> <li> <p>APPIUM_JAVA_TESTNG.</p> </li> <li> <p>APPIUM_PYTHON.</p> </li> <li> <p>APPIUM_NODE.</p> </li> <li> <p>APPIUM_RUBY.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG.</p> </li> <li> <p>APPIUM_WEB_PYTHON.</p> </li> <li> <p>APPIUM_WEB_NODE.</p> </li> <li> <p>APPIUM_WEB_RUBY.</p> </li> <li> <p>INSTRUMENTATION.</p> </li> <li> <p>XCTEST.</p> </li> <li> <p>XCTEST_UI.</p> </li> </ul>
        test: <p>Information about the uploaded test to be run against the device pool.</p>
        configuration: <p>An object that contains information about the settings for a run.</p>
        project_arn: <p>The ARN of the project for which you want to check device pool compatibility.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.limit_exceeded_exception.LimitExceededException: <p>A limit was exceeded.</p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.service_account_exception.ServiceAccountException: <p>There was a problem with the service account.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get information about the compatibility of a device pool
        The following example returns information about the compatibility of a specific device pool, given its ARN.

        >>> client.get_device_pool_compatibility(device_pool_arn='arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID', app_arn='arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID', test_type='APPIUM_PYTHON')
    """

    def _handler(
        req: "OperationRequest[capo_device_farm.types.get_device_pool_compatibility_request.GetDevicePoolCompatibilityRequest]",
    ) -> OperationResponse[
        "capo_device_farm.types.get_device_pool_compatibility_result.GetDevicePoolCompatibilityResult"
    ]:
        import capo_device_farm._operations.device_farm_20150623.get_device_pool_compatibility

        output, http_response = (
            capo_device_farm._operations.device_farm_20150623.get_device_pool_compatibility.get_device_pool_compatibility(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDevicePoolCompatibility")
    )
    input_: capo_device_farm.types.get_device_pool_compatibility_request.GetDevicePoolCompatibilityRequest = {
        "device_pool_arn": device_pool_arn
    }
    if app_arn is not None:
        input_["app_arn"] = app_arn
    if test_type is not None:
        input_["test_type"] = test_type
    if test is not None:
        input_["test"] = test
    if configuration is not None:
        input_["configuration"] = configuration
    if project_arn is not None:
        input_["project_arn"] = project_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output