Documentation

RoboMakerClient extends AwsClient
in package

This client is used to interact with the **AWS RoboMaker** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchDeleteWorlds()  :
batchDeleteWorldsAsync()  :
batchDescribeSimulationJob()  :
batchDescribeSimulationJobAsync()  :
cancelDeploymentJob()  :
cancelDeploymentJobAsync()  :
cancelSimulationJob()  :
cancelSimulationJobAsync()  :
cancelSimulationJobBatch()  :
cancelSimulationJobBatchAsync()  :
cancelWorldExportJob()  :
cancelWorldExportJobAsync()  :
cancelWorldGenerationJob()  :
cancelWorldGenerationJobAsync()  :
createDeploymentJob()  :
createDeploymentJobAsync()  :
createFleet()  :
createFleetAsync()  :
createRobot()  :
createRobotApplication()  :
createRobotApplicationAsync()  :
createRobotApplicationVersion()  :
createRobotApplicationVersionAsync()  :
createRobotAsync()  :
createSimulationApplication()  :
createSimulationApplicationAsync()  :
createSimulationApplicationVersion()  :
createSimulationApplicationVersionAsync()  :
createSimulationJob()  :
createSimulationJobAsync()  :
createWorldExportJob()  :
createWorldExportJobAsync()  :
createWorldGenerationJob()  :
createWorldGenerationJobAsync()  :
createWorldTemplate()  :
createWorldTemplateAsync()  :
deleteFleet()  :
deleteFleetAsync()  :
deleteRobot()  :
deleteRobotApplication()  :
deleteRobotApplicationAsync()  :
deleteRobotAsync()  :
deleteSimulationApplication()  :
deleteSimulationApplicationAsync()  :
deleteWorldTemplate()  :
deleteWorldTemplateAsync()  :
deregisterRobot()  :
deregisterRobotAsync()  :
describeDeploymentJob()  :
describeDeploymentJobAsync()  :
describeFleet()  :
describeFleetAsync()  :
describeRobot()  :
describeRobotApplication()  :
describeRobotApplicationAsync()  :
describeRobotAsync()  :
describeSimulationApplication()  :
describeSimulationApplicationAsync()  :
describeSimulationJob()  :
describeSimulationJobAsync()  :
describeSimulationJobBatch()  :
describeSimulationJobBatchAsync()  :
describeWorld()  :
describeWorldAsync()  :
describeWorldExportJob()  :
describeWorldExportJobAsync()  :
describeWorldGenerationJob()  :
describeWorldGenerationJobAsync()  :
describeWorldTemplate()  :
describeWorldTemplateAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
getWorldTemplateBody()  :
getWorldTemplateBodyAsync()  :
listDeploymentJobs()  :
listDeploymentJobsAsync()  :
listFleets()  :
listFleetsAsync()  :
listRobotApplications()  :
listRobotApplicationsAsync()  :
listRobots()  :
listRobotsAsync()  :
listSimulationApplications()  :
listSimulationApplicationsAsync()  :
listSimulationJobBatches()  :
listSimulationJobBatchesAsync()  :
listSimulationJobs()  :
listSimulationJobsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
listWorldExportJobs()  :
listWorldExportJobsAsync()  :
listWorldGenerationJobs()  :
listWorldGenerationJobsAsync()  :
listWorlds()  :
listWorldsAsync()  :
listWorldTemplates()  :
listWorldTemplatesAsync()  :
registerRobot()  :
registerRobotAsync()  :
restartSimulationJob()  :
restartSimulationJobAsync()  :
startSimulationJobBatch()  :
startSimulationJobBatchAsync()  :
syncDeploymentJob()  :
syncDeploymentJobAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateRobotApplication()  :
updateRobotApplicationAsync()  :
updateSimulationApplication()  :
updateSimulationApplicationAsync()  :
updateWorldTemplate()  :
updateWorldTemplateAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
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.
  • 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).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

batchDeleteWorlds()

public batchDeleteWorlds(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchDeleteWorldsAsync()

public batchDeleteWorldsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchDescribeSimulationJob()

public batchDescribeSimulationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchDescribeSimulationJobAsync()

public batchDescribeSimulationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelDeploymentJob()

public cancelDeploymentJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelDeploymentJobAsync()

public cancelDeploymentJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelSimulationJob()

public cancelSimulationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelSimulationJobAsync()

public cancelSimulationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelSimulationJobBatch()

public cancelSimulationJobBatch(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelSimulationJobBatchAsync()

public cancelSimulationJobBatchAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelWorldExportJob()

public cancelWorldExportJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelWorldExportJobAsync()

public cancelWorldExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelWorldGenerationJob()

public cancelWorldGenerationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

cancelWorldGenerationJobAsync()

public cancelWorldGenerationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDeploymentJob()

public createDeploymentJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createDeploymentJobAsync()

public createDeploymentJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createFleet()

public createFleet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createFleetAsync()

public createFleetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobot()

public createRobot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobotApplication()

public createRobotApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobotApplicationAsync()

public createRobotApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobotApplicationVersion()

public createRobotApplicationVersion(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobotApplicationVersionAsync()

public createRobotApplicationVersionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createRobotAsync()

public createRobotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationApplication()

public createSimulationApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationApplicationAsync()

public createSimulationApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationApplicationVersion()

public createSimulationApplicationVersion(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationApplicationVersionAsync()

public createSimulationApplicationVersionAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationJob()

public createSimulationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createSimulationJobAsync()

public createSimulationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldExportJob()

public createWorldExportJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldExportJobAsync()

public createWorldExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldGenerationJob()

public createWorldGenerationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldGenerationJobAsync()

public createWorldGenerationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldTemplate()

public createWorldTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createWorldTemplateAsync()

public createWorldTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteFleet()

public deleteFleet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteFleetAsync()

public deleteFleetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRobot()

public deleteRobot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRobotApplication()

public deleteRobotApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRobotApplicationAsync()

public deleteRobotApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteRobotAsync()

public deleteRobotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSimulationApplication()

public deleteSimulationApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteSimulationApplicationAsync()

public deleteSimulationApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteWorldTemplate()

public deleteWorldTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteWorldTemplateAsync()

public deleteWorldTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deregisterRobot()

public deregisterRobot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deregisterRobotAsync()

public deregisterRobotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeploymentJob()

public describeDeploymentJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeDeploymentJobAsync()

public describeDeploymentJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleet()

public describeFleet(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeFleetAsync()

public describeFleetAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRobot()

public describeRobot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRobotApplication()

public describeRobotApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRobotApplicationAsync()

public describeRobotApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeRobotAsync()

public describeRobotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationApplication()

public describeSimulationApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationApplicationAsync()

public describeSimulationApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationJob()

public describeSimulationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationJobAsync()

public describeSimulationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationJobBatch()

public describeSimulationJobBatch(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeSimulationJobBatchAsync()

public describeSimulationJobBatchAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorld()

public describeWorld(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldAsync()

public describeWorldAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldExportJob()

public describeWorldExportJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldExportJobAsync()

public describeWorldExportJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldGenerationJob()

public describeWorldGenerationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldGenerationJobAsync()

public describeWorldGenerationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldTemplate()

public describeWorldTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeWorldTemplateAsync()

public describeWorldTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

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|null —

getCredentials()

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
PromiseInterface —

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
HandlerList —

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getWorldTemplateBody()

public getWorldTemplateBody(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getWorldTemplateBodyAsync()

public getWorldTemplateBodyAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDeploymentJobs()

public listDeploymentJobs(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listDeploymentJobsAsync()

public listDeploymentJobsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listFleets()

public listFleets(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listFleetsAsync()

public listFleetsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listRobotApplications()

public listRobotApplications(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listRobotApplicationsAsync()

public listRobotApplicationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listRobots()

public listRobots(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listRobotsAsync()

public listRobotsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationApplications()

public listSimulationApplications(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationApplicationsAsync()

public listSimulationApplicationsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationJobBatches()

public listSimulationJobBatches(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationJobBatchesAsync()

public listSimulationJobBatchesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationJobs()

public listSimulationJobs(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listSimulationJobsAsync()

public listSimulationJobsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldExportJobs()

public listWorldExportJobs(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldExportJobsAsync()

public listWorldExportJobsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldGenerationJobs()

public listWorldGenerationJobs(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldGenerationJobsAsync()

public listWorldGenerationJobsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorlds()

public listWorlds(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldsAsync()

public listWorldsAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldTemplates()

public listWorldTemplates(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listWorldTemplatesAsync()

public listWorldTemplatesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

registerRobot()

public registerRobot(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

registerRobotAsync()

public registerRobotAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

restartSimulationJob()

public restartSimulationJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

restartSimulationJobAsync()

public restartSimulationJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startSimulationJobBatch()

public startSimulationJobBatch(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

startSimulationJobBatchAsync()

public startSimulationJobBatchAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

syncDeploymentJob()

public syncDeploymentJob(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

syncDeploymentJobAsync()

public syncDeploymentJobAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateRobotApplication()

public updateRobotApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateRobotApplicationAsync()

public updateRobotApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateSimulationApplication()

public updateSimulationApplication(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateSimulationApplicationAsync()

public updateSimulationApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateWorldTemplate()

public updateWorldTemplate(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateWorldTemplateAsync()

public updateWorldTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results