devicefarm

package module
v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 30, 2020 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source
const ServiceAPIVersion = "2015-06-23"
View Source
const ServiceID = "Device Farm"

Variables

This section is empty.

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Welcome to the AWS Device Farm API documentation, which contains APIs for:

* Testing on desktop browsers Device Farm makes it possible for you to test your web applications on desktop browsers using Selenium. The APIs for desktop browser testing contain TestGrid in their names. For more information, see Testing Web Applications on Selenium with Device Farm (https://docs.aws.amazon.com/devicefarm/latest/testgrid/).

  • Testing on

real mobile devices Device Farm makes it possible for you to test apps on physical phones, tablets, and other devices in the cloud. For more information, see the Device Farm Developer Guide (https://docs.aws.amazon.com/devicefarm/latest/developerguide/).

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) CreateDevicePool

func (c *Client) CreateDevicePool(ctx context.Context, params *CreateDevicePoolInput, optFns ...func(*Options)) (*CreateDevicePoolOutput, error)

Creates a device pool.

func (*Client) CreateInstanceProfile

func (c *Client) CreateInstanceProfile(ctx context.Context, params *CreateInstanceProfileInput, optFns ...func(*Options)) (*CreateInstanceProfileOutput, error)

Creates a profile that can be applied to one or more private fleet device instances.

func (*Client) CreateNetworkProfile

func (c *Client) CreateNetworkProfile(ctx context.Context, params *CreateNetworkProfileInput, optFns ...func(*Options)) (*CreateNetworkProfileOutput, error)

Creates a network profile.

func (*Client) CreateProject

func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

Creates a project.

func (*Client) CreateRemoteAccessSession

func (c *Client) CreateRemoteAccessSession(ctx context.Context, params *CreateRemoteAccessSessionInput, optFns ...func(*Options)) (*CreateRemoteAccessSessionOutput, error)

Specifies and starts a remote access session.

func (*Client) CreateTestGridProject

func (c *Client) CreateTestGridProject(ctx context.Context, params *CreateTestGridProjectInput, optFns ...func(*Options)) (*CreateTestGridProjectOutput, error)

Creates a Selenium testing project. Projects are used to track TestGridSession () instances.

func (*Client) CreateTestGridUrl

func (c *Client) CreateTestGridUrl(ctx context.Context, params *CreateTestGridUrlInput, optFns ...func(*Options)) (*CreateTestGridUrlOutput, error)

Creates a signed, short-term URL that can be passed to a Selenium RemoteWebDriver constructor.

func (*Client) CreateUpload

func (c *Client) CreateUpload(ctx context.Context, params *CreateUploadInput, optFns ...func(*Options)) (*CreateUploadOutput, error)

Uploads an app or test scripts.

func (*Client) CreateVPCEConfiguration

func (c *Client) CreateVPCEConfiguration(ctx context.Context, params *CreateVPCEConfigurationInput, optFns ...func(*Options)) (*CreateVPCEConfigurationOutput, error)

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

func (*Client) DeleteDevicePool

func (c *Client) DeleteDevicePool(ctx context.Context, params *DeleteDevicePoolInput, optFns ...func(*Options)) (*DeleteDevicePoolOutput, error)

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

func (*Client) DeleteInstanceProfile

func (c *Client) DeleteInstanceProfile(ctx context.Context, params *DeleteInstanceProfileInput, optFns ...func(*Options)) (*DeleteInstanceProfileOutput, error)

Deletes a profile that can be applied to one or more private device instances.

func (*Client) DeleteNetworkProfile

func (c *Client) DeleteNetworkProfile(ctx context.Context, params *DeleteNetworkProfileInput, optFns ...func(*Options)) (*DeleteNetworkProfileOutput, error)

Deletes a network profile.

func (*Client) DeleteProject

func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

Deletes an AWS Device Farm project, given the project ARN. Deleting this resource does not stop an in-progress run.

func (*Client) DeleteRemoteAccessSession

func (c *Client) DeleteRemoteAccessSession(ctx context.Context, params *DeleteRemoteAccessSessionInput, optFns ...func(*Options)) (*DeleteRemoteAccessSessionOutput, error)

Deletes a completed remote access session and its results.

func (*Client) DeleteRun

func (c *Client) DeleteRun(ctx context.Context, params *DeleteRunInput, optFns ...func(*Options)) (*DeleteRunOutput, error)

Deletes the run, given the run ARN. Deleting this resource does not stop an in-progress run.

func (*Client) DeleteTestGridProject

func (c *Client) DeleteTestGridProject(ctx context.Context, params *DeleteTestGridProjectInput, optFns ...func(*Options)) (*DeleteTestGridProjectOutput, error)

Deletes a Selenium testing project and all content generated under it. You cannot undo this operation. You cannot delete a project if it has active sessions.

func (*Client) DeleteUpload

func (c *Client) DeleteUpload(ctx context.Context, params *DeleteUploadInput, optFns ...func(*Options)) (*DeleteUploadOutput, error)

Deletes an upload given the upload ARN.

func (*Client) DeleteVPCEConfiguration

func (c *Client) DeleteVPCEConfiguration(ctx context.Context, params *DeleteVPCEConfigurationInput, optFns ...func(*Options)) (*DeleteVPCEConfigurationOutput, error)

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

func (*Client) GetAccountSettings

func (c *Client) GetAccountSettings(ctx context.Context, params *GetAccountSettingsInput, optFns ...func(*Options)) (*GetAccountSettingsOutput, error)

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

func (*Client) GetDevice

func (c *Client) GetDevice(ctx context.Context, params *GetDeviceInput, optFns ...func(*Options)) (*GetDeviceOutput, error)

Gets information about a unique device type.

func (*Client) GetDeviceInstance

func (c *Client) GetDeviceInstance(ctx context.Context, params *GetDeviceInstanceInput, optFns ...func(*Options)) (*GetDeviceInstanceOutput, error)

Returns information about a device instance that belongs to a private device fleet.

func (*Client) GetDevicePool

func (c *Client) GetDevicePool(ctx context.Context, params *GetDevicePoolInput, optFns ...func(*Options)) (*GetDevicePoolOutput, error)

Gets information about a device pool.

func (*Client) GetDevicePoolCompatibility

func (c *Client) GetDevicePoolCompatibility(ctx context.Context, params *GetDevicePoolCompatibilityInput, optFns ...func(*Options)) (*GetDevicePoolCompatibilityOutput, error)

Gets information about compatibility with a device pool.

func (*Client) GetInstanceProfile

func (c *Client) GetInstanceProfile(ctx context.Context, params *GetInstanceProfileInput, optFns ...func(*Options)) (*GetInstanceProfileOutput, error)

Returns information about the specified instance profile.

func (*Client) GetJob

func (c *Client) GetJob(ctx context.Context, params *GetJobInput, optFns ...func(*Options)) (*GetJobOutput, error)

Gets information about a job.

func (*Client) GetNetworkProfile

func (c *Client) GetNetworkProfile(ctx context.Context, params *GetNetworkProfileInput, optFns ...func(*Options)) (*GetNetworkProfileOutput, error)

Returns information about a network profile.

func (*Client) GetOfferingStatus

func (c *Client) GetOfferingStatus(ctx context.Context, params *GetOfferingStatusInput, optFns ...func(*Options)) (*GetOfferingStatusOutput, error)

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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com).

func (*Client) GetProject

func (c *Client) GetProject(ctx context.Context, params *GetProjectInput, optFns ...func(*Options)) (*GetProjectOutput, error)

Gets information about a project.

func (*Client) GetRemoteAccessSession

func (c *Client) GetRemoteAccessSession(ctx context.Context, params *GetRemoteAccessSessionInput, optFns ...func(*Options)) (*GetRemoteAccessSessionOutput, error)

Returns a link to a currently running remote access session.

func (*Client) GetRun

func (c *Client) GetRun(ctx context.Context, params *GetRunInput, optFns ...func(*Options)) (*GetRunOutput, error)

Gets information about a run.

func (*Client) GetSuite

func (c *Client) GetSuite(ctx context.Context, params *GetSuiteInput, optFns ...func(*Options)) (*GetSuiteOutput, error)

Gets information about a suite.

func (*Client) GetTest

func (c *Client) GetTest(ctx context.Context, params *GetTestInput, optFns ...func(*Options)) (*GetTestOutput, error)

Gets information about a test.

func (*Client) GetTestGridProject

func (c *Client) GetTestGridProject(ctx context.Context, params *GetTestGridProjectInput, optFns ...func(*Options)) (*GetTestGridProjectOutput, error)

Retrieves information about a Selenium testing project.

func (*Client) GetTestGridSession

func (c *Client) GetTestGridSession(ctx context.Context, params *GetTestGridSessionInput, optFns ...func(*Options)) (*GetTestGridSessionOutput, error)

A session is an instance of a browser created through a RemoteWebDriver with the URL from CreateTestGridUrlResult$url (). You can use the following to look up sessions:

  • The session ARN (GetTestGridSessionRequest$sessionArn ()).

* The project ARN and a session ID (GetTestGridSessionRequest$projectArn () and GetTestGridSessionRequest$sessionId ()).

func (*Client) GetUpload

func (c *Client) GetUpload(ctx context.Context, params *GetUploadInput, optFns ...func(*Options)) (*GetUploadOutput, error)

Gets information about an upload.

func (*Client) GetVPCEConfiguration

func (c *Client) GetVPCEConfiguration(ctx context.Context, params *GetVPCEConfigurationInput, optFns ...func(*Options)) (*GetVPCEConfigurationOutput, error)

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

func (*Client) InstallToRemoteAccessSession

func (c *Client) InstallToRemoteAccessSession(ctx context.Context, params *InstallToRemoteAccessSessionInput, optFns ...func(*Options)) (*InstallToRemoteAccessSessionOutput, error)

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

func (*Client) ListArtifacts

func (c *Client) ListArtifacts(ctx context.Context, params *ListArtifactsInput, optFns ...func(*Options)) (*ListArtifactsOutput, error)

Gets information about artifacts.

func (*Client) ListDeviceInstances

func (c *Client) ListDeviceInstances(ctx context.Context, params *ListDeviceInstancesInput, optFns ...func(*Options)) (*ListDeviceInstancesOutput, error)

Returns information about the private device instances associated with one or more AWS accounts.

func (*Client) ListDevicePools

func (c *Client) ListDevicePools(ctx context.Context, params *ListDevicePoolsInput, optFns ...func(*Options)) (*ListDevicePoolsOutput, error)

Gets information about device pools.

func (*Client) ListDevices

func (c *Client) ListDevices(ctx context.Context, params *ListDevicesInput, optFns ...func(*Options)) (*ListDevicesOutput, error)

Gets information about unique device types.

func (*Client) ListInstanceProfiles

func (c *Client) ListInstanceProfiles(ctx context.Context, params *ListInstanceProfilesInput, optFns ...func(*Options)) (*ListInstanceProfilesOutput, error)

Returns information about all the instance profiles in an AWS account.

func (*Client) ListJobs

func (c *Client) ListJobs(ctx context.Context, params *ListJobsInput, optFns ...func(*Options)) (*ListJobsOutput, error)

Gets information about jobs for a given test run.

func (*Client) ListNetworkProfiles

func (c *Client) ListNetworkProfiles(ctx context.Context, params *ListNetworkProfilesInput, optFns ...func(*Options)) (*ListNetworkProfilesOutput, error)

Returns the list of available network profiles.

func (*Client) ListOfferingPromotions

func (c *Client) ListOfferingPromotions(ctx context.Context, params *ListOfferingPromotionsInput, optFns ...func(*Options)) (*ListOfferingPromotionsOutput, error)

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com) if you must be able to invoke this operation.

func (*Client) ListOfferingTransactions

func (c *Client) ListOfferingTransactions(ctx context.Context, params *ListOfferingTransactionsInput, optFns ...func(*Options)) (*ListOfferingTransactionsOutput, error)

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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com).

func (*Client) ListOfferings

func (c *Client) ListOfferings(ctx context.Context, params *ListOfferingsInput, optFns ...func(*Options)) (*ListOfferingsOutput, error)

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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com).

func (*Client) ListProjects

func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

Gets information about projects.

func (*Client) ListRemoteAccessSessions

func (c *Client) ListRemoteAccessSessions(ctx context.Context, params *ListRemoteAccessSessionsInput, optFns ...func(*Options)) (*ListRemoteAccessSessionsOutput, error)

Returns a list of all currently running remote access sessions.

func (*Client) ListRuns

func (c *Client) ListRuns(ctx context.Context, params *ListRunsInput, optFns ...func(*Options)) (*ListRunsOutput, error)

Gets information about runs, given an AWS Device Farm project ARN.

func (*Client) ListSamples

func (c *Client) ListSamples(ctx context.Context, params *ListSamplesInput, optFns ...func(*Options)) (*ListSamplesOutput, error)

Gets information about samples, given an AWS Device Farm job ARN.

func (*Client) ListSuites

func (c *Client) ListSuites(ctx context.Context, params *ListSuitesInput, optFns ...func(*Options)) (*ListSuitesOutput, error)

Gets information about test suites for a given job.

func (*Client) ListTagsForResource

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List the tags for an AWS Device Farm resource.

func (*Client) ListTestGridProjects

func (c *Client) ListTestGridProjects(ctx context.Context, params *ListTestGridProjectsInput, optFns ...func(*Options)) (*ListTestGridProjectsOutput, error)

Gets a list of all Selenium testing projects in your account.

func (*Client) ListTestGridSessionActions

func (c *Client) ListTestGridSessionActions(ctx context.Context, params *ListTestGridSessionActionsInput, optFns ...func(*Options)) (*ListTestGridSessionActionsOutput, error)

Returns a list of the actions taken in a TestGridSession ().

func (*Client) ListTestGridSessionArtifacts

func (c *Client) ListTestGridSessionArtifacts(ctx context.Context, params *ListTestGridSessionArtifactsInput, optFns ...func(*Options)) (*ListTestGridSessionArtifactsOutput, error)

Retrieves a list of artifacts created during the session.

func (*Client) ListTestGridSessions

func (c *Client) ListTestGridSessions(ctx context.Context, params *ListTestGridSessionsInput, optFns ...func(*Options)) (*ListTestGridSessionsOutput, error)

Retrieves a list of sessions for a TestGridProject ().

func (*Client) ListTests

func (c *Client) ListTests(ctx context.Context, params *ListTestsInput, optFns ...func(*Options)) (*ListTestsOutput, error)

Gets information about tests in a given test suite.

func (*Client) ListUniqueProblems

func (c *Client) ListUniqueProblems(ctx context.Context, params *ListUniqueProblemsInput, optFns ...func(*Options)) (*ListUniqueProblemsOutput, error)

Gets information about unique problems, such as exceptions or crashes. Unique problems are defined as a single instance of an error across a run, job, or suite. For example, if a call in your application consistently raises an exception (OutOfBoundsException in MyActivity.java:386), ListUniqueProblems returns a single entry instead of many individual entries for that exception.

func (*Client) ListUploads

func (c *Client) ListUploads(ctx context.Context, params *ListUploadsInput, optFns ...func(*Options)) (*ListUploadsOutput, error)

Gets information about uploads, given an AWS Device Farm project ARN.

func (*Client) ListVPCEConfigurations

func (c *Client) ListVPCEConfigurations(ctx context.Context, params *ListVPCEConfigurationsInput, optFns ...func(*Options)) (*ListVPCEConfigurationsOutput, error)

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

func (*Client) PurchaseOffering

func (c *Client) PurchaseOffering(ctx context.Context, params *PurchaseOfferingInput, optFns ...func(*Options)) (*PurchaseOfferingOutput, error)

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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com).

func (*Client) RenewOffering

func (c *Client) RenewOffering(ctx context.Context, params *RenewOfferingInput, optFns ...func(*Options)) (*RenewOfferingOutput, error)

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. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com (mailto:aws-devicefarm-support@amazon.com).

func (*Client) ScheduleRun

func (c *Client) ScheduleRun(ctx context.Context, params *ScheduleRunInput, optFns ...func(*Options)) (*ScheduleRunOutput, error)

Schedules a run.

func (*Client) StopJob

func (c *Client) StopJob(ctx context.Context, params *StopJobInput, optFns ...func(*Options)) (*StopJobOutput, error)

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

func (*Client) StopRemoteAccessSession

func (c *Client) StopRemoteAccessSession(ctx context.Context, params *StopRemoteAccessSessionInput, optFns ...func(*Options)) (*StopRemoteAccessSessionOutput, error)

Ends a specified remote access session.

func (*Client) StopRun

func (c *Client) StopRun(ctx context.Context, params *StopRunInput, optFns ...func(*Options)) (*StopRunOutput, error)

Initiates a stop request for the current test run. AWS Device Farm immediately stops the run on devices where tests have not started. You are not billed for these devices. On devices where tests have started executing, setup suite and teardown suite tests run to completion on those devices. You are billed for setup, teardown, and any tests that were in progress or already completed.

func (*Client) TagResource

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

func (*Client) UntagResource

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes the specified tags from a resource.

func (*Client) UpdateDeviceInstance

func (c *Client) UpdateDeviceInstance(ctx context.Context, params *UpdateDeviceInstanceInput, optFns ...func(*Options)) (*UpdateDeviceInstanceOutput, error)

Updates information about a private device instance.

func (*Client) UpdateDevicePool

func (c *Client) UpdateDevicePool(ctx context.Context, params *UpdateDevicePoolInput, optFns ...func(*Options)) (*UpdateDevicePoolOutput, error)

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

func (*Client) UpdateInstanceProfile

func (c *Client) UpdateInstanceProfile(ctx context.Context, params *UpdateInstanceProfileInput, optFns ...func(*Options)) (*UpdateInstanceProfileOutput, error)

Updates information about an existing private device instance profile.

func (*Client) UpdateNetworkProfile

func (c *Client) UpdateNetworkProfile(ctx context.Context, params *UpdateNetworkProfileInput, optFns ...func(*Options)) (*UpdateNetworkProfileOutput, error)

Updates the network profile.

func (*Client) UpdateProject

func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

Modifies the specified project name, given the project ARN and a new name.

func (*Client) UpdateTestGridProject

func (c *Client) UpdateTestGridProject(ctx context.Context, params *UpdateTestGridProjectInput, optFns ...func(*Options)) (*UpdateTestGridProjectOutput, error)

Change details of a project.

func (*Client) UpdateUpload

func (c *Client) UpdateUpload(ctx context.Context, params *UpdateUploadInput, optFns ...func(*Options)) (*UpdateUploadOutput, error)

Updates an uploaded test spec.

func (*Client) UpdateVPCEConfiguration

func (c *Client) UpdateVPCEConfiguration(ctx context.Context, params *UpdateVPCEConfigurationInput, optFns ...func(*Options)) (*UpdateVPCEConfigurationOutput, error)

Updates information about an Amazon Virtual Private Cloud (VPC) endpoint configuration.

type CreateDevicePoolInput

type CreateDevicePoolInput struct {
	// The device pool's name.
	Name *string
	// 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.
	MaxDevices *int32
	// The ARN of the project for the device pool.
	ProjectArn *string
	// The device pool's description.
	Description *string
	// The device pool's rules.
	Rules []*types.Rule
}

Represents a request to the create device pool operation.

type CreateDevicePoolOutput

type CreateDevicePoolOutput struct {
	// The newly created device pool.
	DevicePool *types.DevicePool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a create device pool request.

type CreateInstanceProfileInput

type CreateInstanceProfileInput struct {
	// When set to true, Device Farm reboots the instance after a test run. The default
	// value is true.
	RebootAfterUse *bool
	// The description of your instance profile.
	Description *string
	// When set to true, Device Farm removes app packages after a test run. The default
	// value is false for private devices.
	PackageCleanup *bool
	// The name of your instance profile.
	Name *string
	// 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.
	ExcludeAppPackagesFromCleanup []*string
}

type CreateInstanceProfileOutput

type CreateInstanceProfileOutput struct {
	// An object that contains information about your instance profile.
	InstanceProfile *types.InstanceProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateNetworkProfileInput

type CreateNetworkProfileInput struct {
	// Proportion of received packets that fail to arrive from 0 to 100 percent.
	DownlinkLossPercent *int32
	// Delay time for all packets to destination in milliseconds as an integer from 0
	// to 2000.
	UplinkDelayMs *int64
	// The name for the new network profile.
	Name *string
	// The data throughput rate in bits per second, as an integer from 0 to 104857600.
	UplinkBandwidthBits *int64
	// Time variation in the delay of received packets in milliseconds as an integer
	// from 0 to 2000.
	UplinkJitterMs *int64
	// Delay time for all packets to destination in milliseconds as an integer from 0
	// to 2000.
	DownlinkDelayMs *int64
	// The data throughput rate in bits per second, as an integer from 0 to 104857600.
	DownlinkBandwidthBits *int64
	// The type of network profile to create. Valid values are listed here.
	Type types.NetworkProfileType
	// Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
	UplinkLossPercent *int32
	// The Amazon Resource Name (ARN) of the project for which you want to create a
	// network profile.
	ProjectArn *string
	// The description of the network profile.
	Description *string
	// Time variation in the delay of received packets in milliseconds as an integer
	// from 0 to 2000.
	DownlinkJitterMs *int64
}

type CreateNetworkProfileOutput

type CreateNetworkProfileOutput struct {
	// The network profile that is returned by the create network profile request.
	NetworkProfile *types.NetworkProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateProjectInput

type CreateProjectInput struct {
	// 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.
	DefaultJobTimeoutMinutes *int32
	// The project's name.
	Name *string
}

Represents a request to the create project operation.

type CreateProjectOutput

type CreateProjectOutput struct {
	// The newly created project.
	Project *types.Project

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a create project request.

type CreateRemoteAccessSessionInput

type CreateRemoteAccessSessionInput struct {
	// The Amazon Resource Name (ARN) of the project for which you want to create a
	// remote access session.
	ProjectArn *string
	// 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.
	InteractionMode types.InteractionMode
	// Set to true to enable remote recording for the remote access session.
	RemoteRecordEnabled *bool
	// 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
	// (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html).
	SshPublicKey *string
	// 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
	// (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html).
	ClientId *string
	// The configuration information for the remote access session request.
	Configuration *types.CreateRemoteAccessSessionConfiguration
	// The ARN of the device for which you want to create a remote access session.
	DeviceArn *string
	// 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? (https://aws.amazon.com/device-farm/faq/)
	SkipAppResign *bool
	// The name of the remote access session to create.
	Name *string
	// The Amazon Resource Name (ARN) of the device instance for which you want to
	// create a remote access session.
	InstanceArn *string
	// The Amazon Resource Name (ARN) for the app to be recorded in the remote access
	// session.
	RemoteRecordAppArn *string
	// Set to true if you want to access devices remotely for debugging in your remote
	// access session. Remote debugging is no longer supported
	// (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html).
	RemoteDebugEnabled *bool
}

Creates and submits a request to start a remote access session.

type CreateRemoteAccessSessionOutput

type CreateRemoteAccessSessionOutput struct {
	// A container that describes the remote access session when the request to create
	// a remote access session is sent.
	RemoteAccessSession *types.RemoteAccessSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the server response from a request to create a remote access session.

type CreateTestGridProjectInput

type CreateTestGridProjectInput struct {
	// Human-readable name of the Selenium testing project.
	Name *string
	// Human-readable description of the project.
	Description *string
}

type CreateTestGridProjectOutput

type CreateTestGridProjectOutput struct {
	// ARN of the Selenium testing project that was created.
	TestGridProject *types.TestGridProject

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateTestGridUrlInput

type CreateTestGridUrlInput struct {
	// ARN (from CreateTestGridProject () or ListTestGridProjects ()) to associate with
	// the short-term URL.
	ProjectArn *string
	// Lifetime, in seconds, of the URL.
	ExpiresInSeconds *int32
}

type CreateTestGridUrlOutput

type CreateTestGridUrlOutput struct {
	// The number of seconds the URL from CreateTestGridUrlResult$url () stays active.
	Expires *time.Time
	// A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds () seconds,
	// to be passed to a RemoteWebDriver.
	Url *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type CreateUploadInput

type CreateUploadInput struct {
	// The ARN of the project for the upload.
	ProjectArn *string
	// 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.
	Type types.UploadType
	// The upload's content type (for example, application/octet-stream).
	ContentType *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.
	Name *string
}

Represents a request to the create upload operation.

type CreateUploadOutput

type CreateUploadOutput struct {
	// The newly created upload.
	Upload *types.Upload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a create upload request.

type CreateVPCEConfigurationInput

type CreateVPCEConfigurationInput struct {
	// An optional description that provides details about your VPC endpoint
	// configuration.
	VpceConfigurationDescription *string
	// The name of the VPC endpoint service running in your AWS account that you want
	// Device Farm to test.
	VpceServiceName *string
	// The DNS name of the service running in your VPC that you want Device Farm to
	// test.
	ServiceDnsName *string
	// The friendly name you give to your VPC endpoint configuration, to manage your
	// configurations more easily.
	VpceConfigurationName *string
}

type CreateVPCEConfigurationOutput

type CreateVPCEConfigurationOutput struct {
	// An object that contains information about your VPC endpoint configuration.
	VpceConfiguration *types.VPCEConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteDevicePoolInput

type DeleteDevicePoolInput struct {
	// Represents the Amazon Resource Name (ARN) of the Device Farm device pool to
	// delete.
	Arn *string
}

Represents a request to the delete device pool operation.

type DeleteDevicePoolOutput

type DeleteDevicePoolOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a delete device pool request.

type DeleteInstanceProfileInput

type DeleteInstanceProfileInput struct {
	// The Amazon Resource Name (ARN) of the instance profile you are requesting to
	// delete.
	Arn *string
}

type DeleteInstanceProfileOutput

type DeleteInstanceProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteNetworkProfileInput

type DeleteNetworkProfileInput struct {
	// The ARN of the network profile to delete.
	Arn *string
}

type DeleteNetworkProfileOutput

type DeleteNetworkProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteProjectInput

type DeleteProjectInput struct {
	// Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.
	Arn *string
}

Represents a request to the delete project operation.

type DeleteProjectOutput

type DeleteProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a delete project request.

type DeleteRemoteAccessSessionInput

type DeleteRemoteAccessSessionInput struct {
	// The Amazon Resource Name (ARN) of the session for which you want to delete
	// remote access.
	Arn *string
}

Represents the request to delete the specified remote access session.

type DeleteRemoteAccessSessionOutput

type DeleteRemoteAccessSessionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The response from the server when a request is made to delete the remote access session.

type DeleteRunInput

type DeleteRunInput struct {
	// The Amazon Resource Name (ARN) for the run to delete.
	Arn *string
}

Represents a request to the delete run operation.

type DeleteRunOutput

type DeleteRunOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a delete run request.

type DeleteTestGridProjectInput

type DeleteTestGridProjectInput struct {
	// The ARN of the project to delete, from CreateTestGridProject () or
	// ListTestGridProjects ().
	ProjectArn *string
}

type DeleteTestGridProjectOutput

type DeleteTestGridProjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DeleteUploadInput

type DeleteUploadInput struct {
	// Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.
	Arn *string
}

Represents a request to the delete upload operation.

type DeleteUploadOutput

type DeleteUploadOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a delete upload request.

type DeleteVPCEConfigurationInput

type DeleteVPCEConfigurationInput struct {
	// The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
	// delete.
	Arn *string
}

type DeleteVPCEConfigurationOutput

type DeleteVPCEConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type GetAccountSettingsInput

type GetAccountSettingsInput struct {
}

Represents the request sent to retrieve the account settings.

type GetAccountSettingsOutput

type GetAccountSettingsOutput struct {
	// The account settings.
	AccountSettings *types.AccountSettings

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the account settings return values from the GetAccountSettings request.

type GetDeviceInput

type GetDeviceInput struct {
	// The device type's ARN.
	Arn *string
}

Represents a request to the get device request.

type GetDeviceInstanceInput

type GetDeviceInstanceInput struct {
	// The Amazon Resource Name (ARN) of the instance you're requesting information
	// about.
	Arn *string
}

type GetDeviceInstanceOutput

type GetDeviceInstanceOutput struct {
	// An object that contains information about your device instance.
	DeviceInstance *types.DeviceInstance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetDeviceOutput

type GetDeviceOutput struct {
	// An object that contains information about the requested device.
	Device *types.Device

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get device request.

type GetDevicePoolCompatibilityInput

type GetDevicePoolCompatibilityInput struct {
	// Information about the uploaded test to be run against the device pool.
	Test *types.ScheduleRunTest
	// The device pool's ARN.
	DevicePoolArn *string
	// An object that contains information about the settings for a run.
	Configuration *types.ScheduleRunConfiguration
	// The ARN of the app that is associated with the specified device pool.
	AppArn *string
	// 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.
	TestType types.TestType
}

Represents a request to the get device pool compatibility operation.

type GetDevicePoolCompatibilityOutput

type GetDevicePoolCompatibilityOutput struct {
	// Information about incompatible devices.
	IncompatibleDevices []*types.DevicePoolCompatibilityResult
	// Information about compatible devices.
	CompatibleDevices []*types.DevicePoolCompatibilityResult

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of describe device pool compatibility request.

type GetDevicePoolInput

type GetDevicePoolInput struct {
	// The device pool's ARN.
	Arn *string
}

Represents a request to the get device pool operation.

type GetDevicePoolOutput

type GetDevicePoolOutput struct {
	// An object that contains information about the requested device pool.
	DevicePool *types.DevicePool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get device pool request.

type GetInstanceProfileInput

type GetInstanceProfileInput struct {
	// The Amazon Resource Name (ARN) of an instance profile.
	Arn *string
}

type GetInstanceProfileOutput

type GetInstanceProfileOutput struct {
	// An object that contains information about an instance profile.
	InstanceProfile *types.InstanceProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetJobInput

type GetJobInput struct {
	// The job's ARN.
	Arn *string
}

Represents a request to the get job operation.

type GetJobOutput

type GetJobOutput struct {
	// An object that contains information about the requested job.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get job request.

type GetNetworkProfileInput

type GetNetworkProfileInput struct {
	// The ARN of the network profile to return information about.
	Arn *string
}

type GetNetworkProfileOutput

type GetNetworkProfileOutput struct {
	// The network profile.
	NetworkProfile *types.NetworkProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetOfferingStatusInput

type GetOfferingStatusInput struct {
	// 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.
	NextToken *string
}

Represents the request to retrieve the offering status for the specified customer or account.

type GetOfferingStatusOutput

type GetOfferingStatusOutput struct {
	// When specified, gets the offering status for the current period.
	Current map[string]*types.OfferingStatus
	// 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.
	NextToken *string
	// When specified, gets the offering status for the next period.
	NextPeriod map[string]*types.OfferingStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Returns the status result for a device offering.

type GetProjectInput

type GetProjectInput struct {
	// The project's ARN.
	Arn *string
}

Represents a request to the get project operation.

type GetProjectOutput

type GetProjectOutput struct {
	// The project to get information about.
	Project *types.Project

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get project request.

type GetRemoteAccessSessionInput

type GetRemoteAccessSessionInput struct {
	// The Amazon Resource Name (ARN) of the remote access session about which you want
	// to get session information.
	Arn *string
}

Represents the request to get information about the specified remote access session.

type GetRemoteAccessSessionOutput

type GetRemoteAccessSessionOutput struct {
	// A container that lists detailed information about the remote access session.
	RemoteAccessSession *types.RemoteAccessSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server that lists detailed information about the remote access session.

type GetRunInput

type GetRunInput struct {
	// The run's ARN.
	Arn *string
}

Represents a request to the get run operation.

type GetRunOutput

type GetRunOutput struct {
	// The run to get results from.
	Run *types.Run

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get run request.

type GetSuiteInput

type GetSuiteInput struct {
	// The suite's ARN.
	Arn *string
}

Represents a request to the get suite operation.

type GetSuiteOutput

type GetSuiteOutput struct {
	// A collection of one or more tests.
	Suite *types.Suite

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get suite request.

type GetTestGridProjectInput

type GetTestGridProjectInput struct {
	// The ARN of the Selenium testing project, from either CreateTestGridProject () or
	// ListTestGridProjects ().
	ProjectArn *string
}

type GetTestGridProjectOutput

type GetTestGridProjectOutput struct {
	// A TestGridProject ().
	TestGridProject *types.TestGridProject

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetTestGridSessionInput

type GetTestGridSessionInput struct {
	// An ARN that uniquely identifies a TestGridSession ().
	SessionArn *string
	// The ARN for the project that this session belongs to. See CreateTestGridProject
	// () and ListTestGridProjects ().
	ProjectArn *string
	// An ID associated with this session.
	SessionId *string
}

type GetTestGridSessionOutput

type GetTestGridSessionOutput struct {
	// The TestGridSession () that was requested.
	TestGridSession *types.TestGridSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type GetTestInput

type GetTestInput struct {
	// The test's ARN.
	Arn *string
}

Represents a request to the get test operation.

type GetTestOutput

type GetTestOutput struct {
	// A test condition that is evaluated.
	Test *types.Test

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get test request.

type GetUploadInput

type GetUploadInput struct {
	// The upload's ARN.
	Arn *string
}

Represents a request to the get upload operation.

type GetUploadOutput

type GetUploadOutput struct {
	// An app or a set of one or more tests to upload or that have been uploaded.
	Upload *types.Upload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a get upload request.

type GetVPCEConfigurationInput

type GetVPCEConfigurationInput struct {
	// The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
	// describe.
	Arn *string
}

type GetVPCEConfigurationOutput

type GetVPCEConfigurationOutput struct {
	// An object that contains information about your VPC endpoint configuration.
	VpceConfiguration *types.VPCEConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type InstallToRemoteAccessSessionInput

type InstallToRemoteAccessSessionInput struct {
	// The ARN of the app about which you are requesting information.
	AppArn *string
	// The Amazon Resource Name (ARN) of the remote access session about which you are
	// requesting information.
	RemoteAccessSessionArn *string
}

Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.

type InstallToRemoteAccessSessionOutput

type InstallToRemoteAccessSessionOutput struct {
	// An app to upload or that has been uploaded.
	AppUpload *types.Upload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.

type ListArtifactsInput

type ListArtifactsInput struct {
	// The run, job, suite, or test ARN.
	Arn *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.
	NextToken *string
	// The artifacts' type. Allowed values include:
	//
	//     * FILE
	//
	//     * LOG
	//
	//     *
	// SCREENSHOT
	Type types.ArtifactCategory
}

Represents a request to the list artifacts operation.

type ListArtifactsOutput

type ListArtifactsOutput struct {
	// Information about the artifacts.
	Artifacts []*types.Artifact
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list artifacts operation.

type ListDeviceInstancesInput

type ListDeviceInstancesInput struct {
	// 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.
	NextToken *string
	// An integer that specifies the maximum number of items you want to return in the
	// API response.
	MaxResults *int32
}

type ListDeviceInstancesOutput

type ListDeviceInstancesOutput struct {
	// An object that contains information about your device instances.
	DeviceInstances []*types.DeviceInstance
	// An identifier that can be used in the next call to this operation to return the
	// next set of items in the list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListDevicePoolsInput

type ListDevicePoolsInput struct {
	// 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.
	Type types.DevicePoolType
	// The project ARN.
	Arn *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.
	NextToken *string
}

Represents the result of a list device pools request.

type ListDevicePoolsOutput

type ListDevicePoolsOutput struct {
	// Information about the device pools.
	DevicePools []*types.DevicePool
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list device pools request.

type ListDevicesInput

type ListDevicesInput struct {
	// 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.
	NextToken *string
	// The Amazon Resource Name (ARN) of the project.
	Arn *string
	// 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
	// (https://docs.aws.amazon.com/devicefarm/latest/developerguide/history.html),
	// 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.
	Filters []*types.DeviceFilter
}

Represents the result of a list devices request.

type ListDevicesOutput

type ListDevicesOutput struct {
	// 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.
	NextToken *string
	// Information about the devices.
	Devices []*types.Device

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list devices operation.

type ListInstanceProfilesInput

type ListInstanceProfilesInput struct {
	// An integer that specifies the maximum number of items you want to return in the
	// API response.
	MaxResults *int32
	// 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.
	NextToken *string
}

type ListInstanceProfilesOutput

type ListInstanceProfilesOutput struct {
	// An object that contains information about your instance profiles.
	InstanceProfiles []*types.InstanceProfile
	// An identifier that can be used in the next call to this operation to return the
	// next set of items in the list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListJobsInput

type ListJobsInput struct {
	// 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.
	NextToken *string
	// The run's Amazon Resource Name (ARN).
	Arn *string
}

Represents a request to the list jobs operation.

type ListJobsOutput

type ListJobsOutput struct {
	// 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.
	NextToken *string
	// Information about the jobs.
	Jobs []*types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list jobs request.

type ListNetworkProfilesInput

type ListNetworkProfilesInput struct {
	// The type of network profile to return information about. Valid values are listed
	// here.
	Type types.NetworkProfileType
	// 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.
	NextToken *string
	// The Amazon Resource Name (ARN) of the project for which you want to list network
	// profiles.
	Arn *string
}

type ListNetworkProfilesOutput

type ListNetworkProfilesOutput struct {
	// A list of the available network profiles.
	NetworkProfiles []*types.NetworkProfile
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListOfferingPromotionsInput

type ListOfferingPromotionsInput struct {
	// 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.
	NextToken *string
}

type ListOfferingPromotionsOutput

type ListOfferingPromotionsOutput struct {
	// Information about the offering promotions.
	OfferingPromotions []*types.OfferingPromotion
	// An identifier to be used in the next call to this operation, to return the next
	// set of items in the list.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListOfferingTransactionsInput

type ListOfferingTransactionsInput struct {
	// 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.
	NextToken *string
}

Represents the request to list the offering transaction history.

type ListOfferingTransactionsOutput

type ListOfferingTransactionsOutput struct {
	// 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.
	NextToken *string
	// The audit log of subscriptions you have purchased and modified through AWS
	// Device Farm.
	OfferingTransactions []*types.OfferingTransaction

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Returns the transaction log of the specified offerings.

type ListOfferingsInput

type ListOfferingsInput struct {
	// 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.
	NextToken *string
}

Represents the request to list all offerings.

type ListOfferingsOutput

type ListOfferingsOutput struct {
	// A value that represents the list offering results.
	Offerings []*types.Offering
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the return values of the list of offerings.

type ListProjectsInput

type ListProjectsInput struct {
	// 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.
	NextToken *string
	// 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.
	Arn *string
}

Represents a request to the list projects operation.

type ListProjectsOutput

type ListProjectsOutput struct {
	// Information about the projects.
	Projects []*types.Project
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list projects request.

type ListRemoteAccessSessionsInput

type ListRemoteAccessSessionsInput struct {
	// 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.
	NextToken *string
	// The Amazon Resource Name (ARN) of the project about which you are requesting
	// information.
	Arn *string
}

Represents the request to return information about the remote access session.

type ListRemoteAccessSessionsOutput

type ListRemoteAccessSessionsOutput struct {
	// A container that represents the metadata from the service about each remote
	// access session you are requesting.
	RemoteAccessSessions []*types.RemoteAccessSession
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.

type ListRunsInput

type ListRunsInput struct {
	// The Amazon Resource Name (ARN) of the project for which you want to list runs.
	Arn *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.
	NextToken *string
}

Represents a request to the list runs operation.

type ListRunsOutput

type ListRunsOutput struct {
	// 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.
	NextToken *string
	// Information about the runs.
	Runs []*types.Run

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list runs request.

type ListSamplesInput

type ListSamplesInput struct {
	// 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.
	NextToken *string
	// The Amazon Resource Name (ARN) of the job used to list samples.
	Arn *string
}

Represents a request to the list samples operation.

type ListSamplesOutput

type ListSamplesOutput struct {
	// 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.
	NextToken *string
	// Information about the samples.
	Samples []*types.Sample

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list samples request.

type ListSuitesInput

type ListSuitesInput struct {
	// The job's Amazon Resource Name (ARN).
	Arn *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.
	NextToken *string
}

Represents a request to the list suites operation.

type ListSuitesOutput

type ListSuitesOutput struct {
	// 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.
	NextToken *string
	// Information about the suites.
	Suites []*types.Suite

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list suites request.

type ListTagsForResourceInput

type ListTagsForResourceInput struct {
	// 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.
	ResourceARN *string
}

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {
	// 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.
	Tags []*types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTestGridProjectsInput

type ListTestGridProjectsInput struct {
	// From a response, used to continue a paginated listing.
	NextToken *string
	// Return no more than this number of results.
	MaxResult *int32
}

type ListTestGridProjectsOutput

type ListTestGridProjectsOutput struct {
	// The list of TestGridProjects, based on a ListTestGridProjectsRequest ().
	TestGridProjects []*types.TestGridProject
	// Used for pagination. Pass into ListTestGridProjects () to get more results in a
	// paginated request.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTestGridSessionActionsInput

type ListTestGridSessionActionsInput struct {
	// The maximum number of sessions to return per response.
	MaxResult *int32
	// The ARN of the session to retrieve.
	SessionArn *string
	// Pagination token.
	NextToken *string
}

type ListTestGridSessionActionsOutput

type ListTestGridSessionActionsOutput struct {
	// The action taken by the session.
	Actions []*types.TestGridSessionAction
	// Pagination token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTestGridSessionArtifactsInput

type ListTestGridSessionArtifactsInput struct {
	// The ARN of a TestGridSession ().
	SessionArn *string
	// Pagination token.
	NextToken *string
	// Limit results to a specified type of artifact.
	Type types.TestGridSessionArtifactCategory
	// The maximum number of results to be returned by a request.
	MaxResult *int32
}

type ListTestGridSessionArtifactsOutput

type ListTestGridSessionArtifactsOutput struct {
	// Pagination token.
	NextToken *string
	// A list of test grid session artifacts for a TestGridSession ().
	Artifacts []*types.TestGridSessionArtifact

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTestGridSessionsInput

type ListTestGridSessionsInput struct {
	// Return only sessions created before this time.
	CreationTimeBefore *time.Time
	// Return only sessions that ended after this time.
	EndTimeAfter *time.Time
	// Return only sessions in this state.
	Status types.TestGridSessionStatus
	// Pagination token.
	NextToken *string
	// Return only sessions created after this time.
	CreationTimeAfter *time.Time
	// ARN of a TestGridProject ().
	ProjectArn *string
	// Return only sessions that ended before this time.
	EndTimeBefore *time.Time
	// Return only this many results at a time.
	MaxResult *int32
}

type ListTestGridSessionsOutput

type ListTestGridSessionsOutput struct {
	// Pagination token.
	NextToken *string
	// The sessions that match the criteria in a ListTestGridSessionsRequest ().
	TestGridSessions []*types.TestGridSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type ListTestsInput

type ListTestsInput struct {
	// 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.
	NextToken *string
	// The test suite's Amazon Resource Name (ARN).
	Arn *string
}

Represents a request to the list tests operation.

type ListTestsOutput

type ListTestsOutput struct {
	// 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.
	NextToken *string
	// Information about the tests.
	Tests []*types.Test

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list tests request.

type ListUniqueProblemsInput

type ListUniqueProblemsInput struct {
	// 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.
	NextToken *string
	// The unique problems' ARNs.
	Arn *string
}

Represents a request to the list unique problems operation.

type ListUniqueProblemsOutput

type ListUniqueProblemsOutput struct {
	// Information about the unique problems. Allowed values include:
	//
	//     * PENDING
	//
	//
	// * PASSED
	//
	//     * WARNED
	//
	//     * FAILED
	//
	//     * SKIPPED
	//
	//     * ERRORED
	//
	//     *
	// STOPPED
	UniqueProblems map[string][]*types.UniqueProblem
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list unique problems request.

type ListUploadsInput

type ListUploadsInput struct {
	// 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.
	NextToken *string
	// 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
	Type types.UploadType
	// The Amazon Resource Name (ARN) of the project for which you want to list
	// uploads.
	Arn *string
}

Represents a request to the list uploads operation.

type ListUploadsOutput

type ListUploadsOutput struct {
	// Information about the uploads.
	Uploads []*types.Upload
	// 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.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a list uploads request.

type ListVPCEConfigurationsInput

type ListVPCEConfigurationsInput struct {
	// 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.
	NextToken *string
	// An integer that specifies the maximum number of items you want to return in the
	// API response.
	MaxResults *int32
}

type ListVPCEConfigurationsOutput

type ListVPCEConfigurationsOutput struct {
	// 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.
	NextToken *string
	// An array of VPCEConfiguration objects that contain information about your VPC
	// endpoint configuration.
	VpceConfigurations []*types.VPCEConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PurchaseOfferingInput

type PurchaseOfferingInput struct {
	// The number of device slots to purchase in an offering request.
	Quantity *int32
	// The ID of the offering.
	OfferingId *string
	// The ID of the offering promotion to be applied to the purchase.
	OfferingPromotionId *string
}

Represents a request for a purchase offering.

type PurchaseOfferingOutput

type PurchaseOfferingOutput struct {
	// Represents the offering transaction for the purchase result.
	OfferingTransaction *types.OfferingTransaction

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of the purchase offering (for example, success or failure).

type RenewOfferingInput

type RenewOfferingInput struct {
	// The ID of a request to renew an offering.
	OfferingId *string
	// The quantity requested in an offering renewal.
	Quantity *int32
}

A request that represents an offering renewal.

type RenewOfferingOutput

type RenewOfferingOutput struct {
	// Represents the status of the offering transaction for the renewal.
	OfferingTransaction *types.OfferingTransaction

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The result of a renewal offering.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options

type ScheduleRunInput

type ScheduleRunInput struct {
	// The ARN of the project for the run to be scheduled.
	ProjectArn *string
	// Information about the settings for the run to be scheduled.
	Configuration *types.ScheduleRunConfiguration
	// The ARN of the device pool for the run to be scheduled.
	DevicePoolArn *string
	// The name for the run to be scheduled.
	Name *string
	// Specifies configuration information about a test run, such as the execution
	// timeout (in minutes).
	ExecutionConfiguration *types.ExecutionConfiguration
	// 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.
	DeviceSelectionConfiguration *types.DeviceSelectionConfiguration
	// The ARN of an application package to run tests against, created with
	// CreateUpload (). See ListUploads ().
	AppArn *string
	// Information about the test for the run to be scheduled.
	Test *types.ScheduleRunTest
}

Represents a request to the schedule run operation.

type ScheduleRunOutput

type ScheduleRunOutput struct {
	// Information about the scheduled run.
	Run *types.Run

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of a schedule run request.

type StopJobInput

type StopJobInput struct {
	// Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.
	Arn *string
}

type StopJobOutput

type StopJobOutput struct {
	// The job that was stopped.
	Job *types.Job

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type StopRemoteAccessSessionInput

type StopRemoteAccessSessionInput struct {
	// The Amazon Resource Name (ARN) of the remote access session to stop.
	Arn *string
}

Represents the request to stop the remote access session.

type StopRemoteAccessSessionOutput

type StopRemoteAccessSessionOutput struct {
	// A container that represents the metadata from the service about the remote
	// access session you are stopping.
	RemoteAccessSession *types.RemoteAccessSession

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.

type StopRunInput

type StopRunInput struct {
	// Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.
	Arn *string
}

Represents the request to stop a specific run.

type StopRunOutput

type StopRunOutput struct {
	// The run that was stopped.
	Run *types.Run

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the results of your stop run attempt.

type TagResourceInput

type TagResourceInput struct {
	// 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.
	Tags []*types.Tag
	// 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.
	ResourceARN *string
}

type TagResourceOutput

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput

type UntagResourceInput struct {
	// 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.
	ResourceARN *string
	// The keys of the tags to be removed.
	TagKeys []*string
}

type UntagResourceOutput

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDeviceInstanceInput

type UpdateDeviceInstanceInput struct {
	// The ARN of the profile that you want to associate with the device instance.
	ProfileArn *string
	// An array of strings that you want to associate with the device instance.
	Labels []*string
	// The Amazon Resource Name (ARN) of the device instance.
	Arn *string
}

type UpdateDeviceInstanceOutput

type UpdateDeviceInstanceOutput struct {
	// An object that contains information about your device instance.
	DeviceInstance *types.DeviceInstance

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateDevicePoolInput

type UpdateDevicePoolInput struct {
	// 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.
	MaxDevices *int32
	// The Amazon Resource Name (ARN) of the Device Farm device pool to update.
	Arn *string
	// 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.
	Rules []*types.Rule
	// 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.
	ClearMaxDevices *bool
	// A string that represents the name of the device pool to update.
	Name *string
	// A description of the device pool to update.
	Description *string
}

Represents a request to the update device pool operation.

type UpdateDevicePoolOutput

type UpdateDevicePoolOutput struct {
	// The device pool you just updated.
	DevicePool *types.DevicePool

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of an update device pool request.

type UpdateInstanceProfileInput

type UpdateInstanceProfileInput struct {
	// 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.
	ExcludeAppPackagesFromCleanup []*string
	// The updated choice for whether you want to reboot the device after use. The
	// default value is true.
	RebootAfterUse *bool
	// The Amazon Resource Name (ARN) of the instance profile.
	Arn *string
	// The updated name for your instance profile.
	Name *string
	// The updated choice for whether you want to specify package cleanup. The default
	// value is false for private devices.
	PackageCleanup *bool
	// The updated description for your instance profile.
	Description *string
}

type UpdateInstanceProfileOutput

type UpdateInstanceProfileOutput struct {
	// An object that contains information about your instance profile.
	InstanceProfile *types.InstanceProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateNetworkProfileInput

type UpdateNetworkProfileInput struct {
	// Proportion of received packets that fail to arrive from 0 to 100 percent.
	DownlinkLossPercent *int32
	// The Amazon Resource Name (ARN) of the project for which you want to update
	// network profile settings.
	Arn *string
	// Delay time for all packets to destination in milliseconds as an integer from 0
	// to 2000.
	UplinkDelayMs *int64
	// The description of the network profile about which you are returning
	// information.
	Description *string
	// Time variation in the delay of received packets in milliseconds as an integer
	// from 0 to 2000.
	DownlinkJitterMs *int64
	// The data throughput rate in bits per second, as an integer from 0 to 104857600.
	DownlinkBandwidthBits *int64
	// Time variation in the delay of received packets in milliseconds as an integer
	// from 0 to 2000.
	UplinkJitterMs *int64
	// Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
	UplinkLossPercent *int32
	// The type of network profile to return information about. Valid values are listed
	// here.
	Type types.NetworkProfileType
	// Delay time for all packets to destination in milliseconds as an integer from 0
	// to 2000.
	DownlinkDelayMs *int64
	// The name of the network profile about which you are returning information.
	Name *string
	// The data throughput rate in bits per second, as an integer from 0 to 104857600.
	UplinkBandwidthBits *int64
}

type UpdateNetworkProfileOutput

type UpdateNetworkProfileOutput struct {
	// A list of the available network profiles.
	NetworkProfile *types.NetworkProfile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProjectInput

type UpdateProjectInput struct {
	// The number of minutes a test run in the project executes before it times out.
	DefaultJobTimeoutMinutes *int32
	// A string that represents the new name of the project that you are updating.
	Name *string
	// The Amazon Resource Name (ARN) of the project whose name to update.
	Arn *string
}

Represents a request to the update project operation.

type UpdateProjectOutput

type UpdateProjectOutput struct {
	// The project to update.
	Project *types.Project

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Represents the result of an update project request.

type UpdateTestGridProjectInput

type UpdateTestGridProjectInput struct {
	// ARN of the project to update.
	ProjectArn *string
	// Human-readable description for the project.
	Description *string
	// Human-readable name for the project.
	Name *string
}

type UpdateTestGridProjectOutput

type UpdateTestGridProjectOutput struct {
	// The project, including updated information.
	TestGridProject *types.TestGridProject

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateUploadInput

type UpdateUploadInput struct {
	// Set to true if the YAML file has changed and must be updated. Otherwise, set to
	// false.
	EditContent *bool
	// 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.
	Name *string
	// The Amazon Resource Name (ARN) of the uploaded test spec.
	Arn *string
	// The upload's content type (for example, application/x-yaml).
	ContentType *string
}

type UpdateUploadOutput

type UpdateUploadOutput struct {
	// A test spec uploaded to Device Farm.
	Upload *types.Upload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateVPCEConfigurationInput

type UpdateVPCEConfigurationInput struct {
	// The friendly name you give to your VPC endpoint configuration to manage your
	// configurations more easily.
	VpceConfigurationName *string
	// The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to
	// update.
	Arn *string
	// The name of the VPC endpoint service running in your AWS account that you want
	// Device Farm to test.
	VpceServiceName *string
	// 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.
	ServiceDnsName *string
	// An optional description that provides details about your VPC endpoint
	// configuration.
	VpceConfigurationDescription *string
}

type UpdateVPCEConfigurationOutput

type UpdateVPCEConfigurationOutput struct {
	// An object that contains information about your VPC endpoint configuration.
	VpceConfiguration *types.VPCEConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL