Interface AWSDeviceFarm

    • Method Detail

      • setEndpoint

        void setEndpoint​(String endpoint)
        Overrides the default endpoint for this client ("https://devicefarm.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

        Callers can pass in just the endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://devicefarm.us-west-2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

        For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

        This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

        Parameters:
        endpoint - The endpoint (ex: "devicefarm.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://devicefarm.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
      • deleteDevicePool

        DeleteDevicePoolResult deleteDevicePool​(DeleteDevicePoolRequest deleteDevicePoolRequest)

        Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

        Parameters:
        deleteDevicePoolRequest - Represents a request to the delete device pool operation.
        Returns:
        Result of the DeleteDevicePool operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • deleteProject

        DeleteProjectResult deleteProject​(DeleteProjectRequest deleteProjectRequest)

        Deletes an AWS Device Farm project, given the project ARN.

        Note Deleting this resource does not stop an in-progress run.

        Parameters:
        deleteProjectRequest - Represents a request to the delete project operation.
        Returns:
        Result of the DeleteProject operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • deleteRun

        DeleteRunResult deleteRun​(DeleteRunRequest deleteRunRequest)

        Deletes the run, given the run ARN.

        Note Deleting this resource does not stop an in-progress run.

        Parameters:
        deleteRunRequest - Represents a request to the delete run operation.
        Returns:
        Result of the DeleteRun operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • getAccountSettings

        GetAccountSettingsResult getAccountSettings​(GetAccountSettingsRequest getAccountSettingsRequest)

        Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.

        Parameters:
        getAccountSettingsRequest - Represents the request sent to retrieve the account settings.
        Returns:
        Result of the GetAccountSettings operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • getOfferingStatus

        GetOfferingStatusResult getOfferingStatus​(GetOfferingStatusRequest getOfferingStatusRequest)

        Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

        Parameters:
        getOfferingStatusRequest - Represents the request to retrieve the offering status for the specified customer or account.
        Returns:
        Result of the GetOfferingStatus operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • listOfferingTransactions

        ListOfferingTransactionsResult listOfferingTransactions​(ListOfferingTransactionsRequest listOfferingTransactionsRequest)

        Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

        Parameters:
        listOfferingTransactionsRequest - Represents the request to list the offering transaction history.
        Returns:
        Result of the ListOfferingTransactions operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • listOfferings

        ListOfferingsResult listOfferings​(ListOfferingsRequest listOfferingsRequest)

        Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

        Parameters:
        listOfferingsRequest - Represents the request to list all offerings.
        Returns:
        Result of the ListOfferings operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • purchaseOffering

        PurchaseOfferingResult purchaseOffering​(PurchaseOfferingRequest purchaseOfferingRequest)

        Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

        Parameters:
        purchaseOfferingRequest - Represents a request for a purchase offering.
        Returns:
        Result of the PurchaseOffering operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • renewOffering

        RenewOfferingResult renewOffering​(RenewOfferingRequest renewOfferingRequest)

        Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

        Parameters:
        renewOfferingRequest - A request representing an offering renewal.
        Returns:
        Result of the RenewOffering operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        NotEligibleException - Exception gets thrown when a user is not eligible to perform the specified transaction.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • stopRun

        StopRunResult stopRun​(StopRunRequest stopRunRequest)

        Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

        Parameters:
        stopRunRequest - Represents the request to stop a specific run.
        Returns:
        Result of the StopRun operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • updateDevicePool

        UpdateDevicePoolResult updateDevicePool​(UpdateDevicePoolRequest updateDevicePoolRequest)

        Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

        Parameters:
        updateDevicePoolRequest - Represents a request to the update device pool operation.
        Returns:
        Result of the UpdateDevicePool operation returned by the service.
        Throws:
        ArgumentException - An invalid argument was specified.
        NotFoundException - The specified entity was not found.
        LimitExceededException - A limit was exceeded.
        ServiceAccountException - There was a problem with the service account.
      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.