DeviceFarmClient
extends AwsClient
in package
This client is used to interact with the Amazon DeviceFarm service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version
option given when constructing the
client. The version
option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */)
, or using the
$client->getCommand
method of the client.
- CreateDevicePool
- CreateInstanceProfile
- CreateNetworkProfile
- CreateProject
- CreateRemoteAccessSession
- CreateTestGridProject
- CreateTestGridUrl
- CreateUpload
- CreateVPCEConfiguration
- DeleteDevicePool
- DeleteInstanceProfile
- DeleteNetworkProfile
- DeleteProject
- DeleteRemoteAccessSession
- DeleteRun
- DeleteTestGridProject
- DeleteUpload
- DeleteVPCEConfiguration
- GetAccountSettings
- GetDevice
- GetDeviceInstance
- GetDevicePool
- GetDevicePoolCompatibility
- GetInstanceProfile
- GetJob
- GetNetworkProfile
- GetOfferingStatus
- GetProject
- GetRemoteAccessSession
- GetRun
- GetSuite
- GetTest
- GetTestGridProject
- GetTestGridSession
- GetUpload
- GetVPCEConfiguration
- InstallToRemoteAccessSession
- ListArtifacts
- ListDeviceInstances
- ListDevicePools
- ListDevices
- ListInstanceProfiles
- ListJobs
- ListNetworkProfiles
- ListOfferingPromotions
- ListOfferingTransactions
- ListOfferings
- ListProjects
- ListRemoteAccessSessions
- ListRuns
- ListSamples
- ListSuites
- ListTagsForResource
- ListTestGridProjects
- ListTestGridSessionActions
- ListTestGridSessionArtifacts
- ListTestGridSessions
- ListTests
- ListUniqueProblems
- ListUploads
- ListVPCEConfigurations
- PurchaseOffering
- RenewOffering
- ScheduleRun
- StopJob
- StopRemoteAccessSession
- StopRun
- TagResource
- UntagResource
- UpdateDeviceInstance
- UpdateDevicePool
- UpdateInstanceProfile
- UpdateNetworkProfile
- UpdateProject
- UpdateTestGridProject
- UpdateUpload
- UpdateVPCEConfiguration
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- createDevicePool() : Result
- createDevicePoolAsync() : Promise
- createInstanceProfile() : Result
- createInstanceProfileAsync() : Promise
- createNetworkProfile() : Result
- createNetworkProfileAsync() : Promise
- createProject() : Result
- createProjectAsync() : Promise
- createRemoteAccessSession() : Result
- createRemoteAccessSessionAsync() : Promise
- createTestGridProject() : Result
- createTestGridProjectAsync() : Promise
- createTestGridUrl() : Result
- createTestGridUrlAsync() : Promise
- createUpload() : Result
- createUploadAsync() : Promise
- createVPCEConfiguration() : Result
- createVPCEConfigurationAsync() : Promise
- deleteDevicePool() : Result
- deleteDevicePoolAsync() : Promise
- deleteInstanceProfile() : Result
- deleteInstanceProfileAsync() : Promise
- deleteNetworkProfile() : Result
- deleteNetworkProfileAsync() : Promise
- deleteProject() : Result
- deleteProjectAsync() : Promise
- deleteRemoteAccessSession() : Result
- deleteRemoteAccessSessionAsync() : Promise
- deleteRun() : Result
- deleteRunAsync() : Promise
- deleteTestGridProject() : Result
- deleteTestGridProjectAsync() : Promise
- deleteUpload() : Result
- deleteUploadAsync() : Promise
- deleteVPCEConfiguration() : Result
- deleteVPCEConfigurationAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getAccountSettings() : Result
- getAccountSettingsAsync() : Promise
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDevice() : Result
- getDeviceAsync() : Promise
- getDeviceInstance() : Result
- getDeviceInstanceAsync() : Promise
- getDevicePool() : Result
- getDevicePoolAsync() : Promise
- getDevicePoolCompatibility() : Result
- getDevicePoolCompatibilityAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getInstanceProfile() : Result
- getInstanceProfileAsync() : Promise
- getIterator() : mixed
- getJob() : Result
- getJobAsync() : Promise
- getNetworkProfile() : Result
- getNetworkProfileAsync() : Promise
- getOfferingStatus() : Result
- getOfferingStatusAsync() : Promise
- getPaginator() : mixed
- getProject() : Result
- getProjectAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getRemoteAccessSession() : Result
- getRemoteAccessSessionAsync() : Promise
- getRun() : Result
- getRunAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getSuite() : Result
- getSuiteAsync() : Promise
- getTest() : Result
- getTestAsync() : Promise
- getTestGridProject() : Result
- getTestGridProjectAsync() : Promise
- getTestGridSession() : Result
- getTestGridSessionAsync() : Promise
- getUpload() : Result
- getUploadAsync() : Promise
- getVPCEConfiguration() : Result
- getVPCEConfigurationAsync() : Promise
- getWaiter() : mixed
- installToRemoteAccessSession() : Result
- installToRemoteAccessSessionAsync() : Promise
- listArtifacts() : Result
- listArtifactsAsync() : Promise
- listDeviceInstances() : Result
- listDeviceInstancesAsync() : Promise
- listDevicePools() : Result
- listDevicePoolsAsync() : Promise
- listDevices() : Result
- listDevicesAsync() : Promise
- listInstanceProfiles() : Result
- listInstanceProfilesAsync() : Promise
- listJobs() : Result
- listJobsAsync() : Promise
- listNetworkProfiles() : Result
- listNetworkProfilesAsync() : Promise
- listOfferingPromotions() : Result
- listOfferingPromotionsAsync() : Promise
- listOfferings() : Result
- listOfferingsAsync() : Promise
- listOfferingTransactions() : Result
- listOfferingTransactionsAsync() : Promise
- listProjects() : Result
- listProjectsAsync() : Promise
- listRemoteAccessSessions() : Result
- listRemoteAccessSessionsAsync() : Promise
- listRuns() : Result
- listRunsAsync() : Promise
- listSamples() : Result
- listSamplesAsync() : Promise
- listSuites() : Result
- listSuitesAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listTestGridProjects() : Result
- listTestGridProjectsAsync() : Promise
- listTestGridSessionActions() : Result
- listTestGridSessionActionsAsync() : Promise
- listTestGridSessionArtifacts() : Result
- listTestGridSessionArtifactsAsync() : Promise
- listTestGridSessions() : Result
- listTestGridSessionsAsync() : Promise
- listTests() : Result
- listTestsAsync() : Promise
- listUniqueProblems() : Result
- listUniqueProblemsAsync() : Promise
- listUploads() : Result
- listUploadsAsync() : Promise
- listVPCEConfigurations() : Result
- listVPCEConfigurationsAsync() : Promise
- purchaseOffering() : Result
- purchaseOfferingAsync() : Promise
- renewOffering() : Result
- renewOfferingAsync() : Promise
- scheduleRun() : Result
- scheduleRunAsync() : Promise
- stopJob() : Result
- stopJobAsync() : Promise
- stopRemoteAccessSession() : Result
- stopRemoteAccessSessionAsync() : Promise
- stopRun() : Result
- stopRunAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateDeviceInstance() : Result
- updateDeviceInstanceAsync() : Promise
- updateDevicePool() : Result
- updateDevicePoolAsync() : Promise
- updateInstanceProfile() : Result
- updateInstanceProfileAsync() : Promise
- updateNetworkProfile() : Result
- updateNetworkProfileAsync() : Promise
- updateProject() : Result
- updateProjectAsync() : Promise
- updateTestGridProject() : Result
- updateTestGridProjectAsync() : Promise
- updateUpload() : Result
- updateUploadAsync() : Promise
- updateVPCEConfiguration() : Result
- updateVPCEConfigurationAsync() : Promise
- waitUntil() : mixed
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
false
to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - token:
(Aws\Token\TokenInterface|array|bool|callable) Specifies
the token used to authorize requests. Provide an
Aws\Token\TokenInterface object, an associative array of
"token" and an optional "expires" key,
false
to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
false
to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project - debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
- stats: (bool|array) Set to true to gather transfer statistics on
requests sent. Alternatively, you can provide an associative array with
the following keys: retries: (bool) Set to false to disable reporting
on retries attempted; http: (bool) Set to true to enable collecting
statistics from lower level HTTP adapters (e.g., values returned in
GuzzleHttp\TransferStats). HTTP handlers must support an
http_stats_receiver
option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds. - disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
- endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
- endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
- endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
- handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
- http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
- http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
- idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
- profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
- region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
- retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
- scheme: (string, default=string(5) "https") URI scheme to use when
connecting connect. The SDK will utilize "https" endpoints (i.e.,
utilize SSL/TLS connections) by default. You can attempt to connect to
a service over an unencrypted "http" endpoint by setting
scheme
to "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
- ua_append: (string, array) To pass custom user agent parameters.
- app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
__sleep()
public
__sleep() : mixed
createDevicePool()
public
createDevicePool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDevicePoolAsync()
public
createDevicePoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateInstanceProfile()
public
createInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInstanceProfileAsync()
public
createInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateNetworkProfile()
public
createNetworkProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateNetworkProfileAsync()
public
createNetworkProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateProject()
public
createProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateProjectAsync()
public
createProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRemoteAccessSession()
public
createRemoteAccessSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRemoteAccessSessionAsync()
public
createRemoteAccessSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTestGridProject()
public
createTestGridProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTestGridProjectAsync()
public
createTestGridProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTestGridUrl()
public
createTestGridUrl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTestGridUrlAsync()
public
createTestGridUrlAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUpload()
public
createUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUploadAsync()
public
createUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateVPCEConfiguration()
public
createVPCEConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateVPCEConfigurationAsync()
public
createVPCEConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDevicePool()
public
deleteDevicePool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDevicePoolAsync()
public
deleteDevicePoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInstanceProfile()
public
deleteInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInstanceProfileAsync()
public
deleteInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteNetworkProfile()
public
deleteNetworkProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteNetworkProfileAsync()
public
deleteNetworkProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteProject()
public
deleteProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteProjectAsync()
public
deleteProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRemoteAccessSession()
public
deleteRemoteAccessSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRemoteAccessSessionAsync()
public
deleteRemoteAccessSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRun()
public
deleteRun(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRunAsync()
public
deleteRunAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTestGridProject()
public
deleteTestGridProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTestGridProjectAsync()
public
deleteTestGridProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUpload()
public
deleteUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUploadAsync()
public
deleteUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVPCEConfiguration()
public
deleteVPCEConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVPCEConfigurationAsync()
public
deleteVPCEConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetAccountSettings()
public
getAccountSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountSettingsAsync()
public
getAccountSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|nullgetCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterfacegetDevice()
public
getDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDeviceAsync()
public
getDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDeviceInstance()
public
getDeviceInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDeviceInstanceAsync()
public
getDeviceInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDevicePool()
public
getDevicePool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDevicePoolAsync()
public
getDevicePoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDevicePoolCompatibility()
public
getDevicePoolCompatibility(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDevicePoolCompatibilityAsync()
public
getDevicePoolCompatibilityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerListgetInstanceProfile()
public
getInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInstanceProfileAsync()
public
getInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getJob()
public
getJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJobAsync()
public
getJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetNetworkProfile()
public
getNetworkProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetNetworkProfileAsync()
public
getNetworkProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOfferingStatus()
public
getOfferingStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOfferingStatusAsync()
public
getOfferingStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getProject()
public
getProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetProjectAsync()
public
getProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetRemoteAccessSession()
public
getRemoteAccessSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRemoteAccessSessionAsync()
public
getRemoteAccessSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRun()
public
getRun(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRunAsync()
public
getRunAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSuite()
public
getSuite(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSuiteAsync()
public
getSuiteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetTest()
public
getTest(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTestAsync()
public
getTestAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetTestGridProject()
public
getTestGridProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTestGridProjectAsync()
public
getTestGridProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetTestGridSession()
public
getTestGridSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTestGridSessionAsync()
public
getTestGridSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUpload()
public
getUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUploadAsync()
public
getUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetVPCEConfiguration()
public
getVPCEConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetVPCEConfigurationAsync()
public
getVPCEConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
installToRemoteAccessSession()
public
installToRemoteAccessSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultinstallToRemoteAccessSessionAsync()
public
installToRemoteAccessSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistArtifacts()
public
listArtifacts(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistArtifactsAsync()
public
listArtifactsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDeviceInstances()
public
listDeviceInstances(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDeviceInstancesAsync()
public
listDeviceInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDevicePools()
public
listDevicePools(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDevicePoolsAsync()
public
listDevicePoolsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDevices()
public
listDevices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDevicesAsync()
public
listDevicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInstanceProfiles()
public
listInstanceProfiles(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInstanceProfilesAsync()
public
listInstanceProfilesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistJobs()
public
listJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistJobsAsync()
public
listJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistNetworkProfiles()
public
listNetworkProfiles(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistNetworkProfilesAsync()
public
listNetworkProfilesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOfferingPromotions()
public
listOfferingPromotions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOfferingPromotionsAsync()
public
listOfferingPromotionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOfferings()
public
listOfferings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOfferingsAsync()
public
listOfferingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOfferingTransactions()
public
listOfferingTransactions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOfferingTransactionsAsync()
public
listOfferingTransactionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistProjects()
public
listProjects(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistProjectsAsync()
public
listProjectsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRemoteAccessSessions()
public
listRemoteAccessSessions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRemoteAccessSessionsAsync()
public
listRemoteAccessSessionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRuns()
public
listRuns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRunsAsync()
public
listRunsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSamples()
public
listSamples(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSamplesAsync()
public
listSamplesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSuites()
public
listSuites(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSuitesAsync()
public
listSuitesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTestGridProjects()
public
listTestGridProjects(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTestGridProjectsAsync()
public
listTestGridProjectsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTestGridSessionActions()
public
listTestGridSessionActions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTestGridSessionActionsAsync()
public
listTestGridSessionActionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTestGridSessionArtifacts()
public
listTestGridSessionArtifacts(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTestGridSessionArtifactsAsync()
public
listTestGridSessionArtifactsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTestGridSessions()
public
listTestGridSessions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTestGridSessionsAsync()
public
listTestGridSessionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTests()
public
listTests(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTestsAsync()
public
listTestsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUniqueProblems()
public
listUniqueProblems(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUniqueProblemsAsync()
public
listUniqueProblemsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUploads()
public
listUploads(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUploadsAsync()
public
listUploadsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistVPCEConfigurations()
public
listVPCEConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistVPCEConfigurationsAsync()
public
listVPCEConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisepurchaseOffering()
public
purchaseOffering(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultpurchaseOfferingAsync()
public
purchaseOfferingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserenewOffering()
public
renewOffering(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrenewOfferingAsync()
public
renewOfferingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisescheduleRun()
public
scheduleRun(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultscheduleRunAsync()
public
scheduleRunAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopJob()
public
stopJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopJobAsync()
public
stopJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopRemoteAccessSession()
public
stopRemoteAccessSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopRemoteAccessSessionAsync()
public
stopRemoteAccessSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopRun()
public
stopRun(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopRunAsync()
public
stopRunAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDeviceInstance()
public
updateDeviceInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDeviceInstanceAsync()
public
updateDeviceInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDevicePool()
public
updateDevicePool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDevicePoolAsync()
public
updateDevicePoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateInstanceProfile()
public
updateInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateInstanceProfileAsync()
public
updateInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateNetworkProfile()
public
updateNetworkProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateNetworkProfileAsync()
public
updateNetworkProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateProject()
public
updateProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateProjectAsync()
public
updateProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTestGridProject()
public
updateTestGridProject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTestGridProjectAsync()
public
updateTestGridProjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUpload()
public
updateUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUploadAsync()
public
updateUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateVPCEConfiguration()
public
updateVPCEConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateVPCEConfigurationAsync()
public
updateVPCEConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []