SDK for PHP 3.x

IoTSiteWiseClient extends AwsClient
in package

This client is used to interact with the AWS IoT SiteWise 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.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
associateAssets()  : Result
associateAssetsAsync()  : Promise
associateTimeSeriesToAssetProperty()  : Result
associateTimeSeriesToAssetPropertyAsync()  : Promise
batchAssociateProjectAssets()  : Result
batchAssociateProjectAssetsAsync()  : Promise
batchDisassociateProjectAssets()  : Result
batchDisassociateProjectAssetsAsync()  : Promise
batchGetAssetPropertyAggregates()  : Result
batchGetAssetPropertyAggregatesAsync()  : Promise
batchGetAssetPropertyValue()  : Result
batchGetAssetPropertyValueAsync()  : Promise
batchGetAssetPropertyValueHistory()  : Result
batchGetAssetPropertyValueHistoryAsync()  : Promise
batchPutAssetPropertyValue()  : Result
batchPutAssetPropertyValueAsync()  : Promise
createAccessPolicy()  : Result
createAccessPolicyAsync()  : Promise
createAsset()  : Result
createAssetAsync()  : Promise
createAssetModel()  : Result
createAssetModelAsync()  : Promise
createAssetModelCompositeModel()  : Result
createAssetModelCompositeModelAsync()  : Promise
createBulkImportJob()  : Result
createBulkImportJobAsync()  : Promise
createDashboard()  : Result
createDashboardAsync()  : Promise
createGateway()  : Result
createGatewayAsync()  : Promise
createPortal()  : Result
createPortalAsync()  : Promise
createProject()  : Result
createProjectAsync()  : Promise
deleteAccessPolicy()  : Result
deleteAccessPolicyAsync()  : Promise
deleteAsset()  : Result
deleteAssetAsync()  : Promise
deleteAssetModel()  : Result
deleteAssetModelAsync()  : Promise
deleteAssetModelCompositeModel()  : Result
deleteAssetModelCompositeModelAsync()  : Promise
deleteDashboard()  : Result
deleteDashboardAsync()  : Promise
deleteGateway()  : Result
deleteGatewayAsync()  : Promise
deletePortal()  : Result
deletePortalAsync()  : Promise
deleteProject()  : Result
deleteProjectAsync()  : Promise
deleteTimeSeries()  : Result
deleteTimeSeriesAsync()  : Promise
describeAccessPolicy()  : Result
describeAccessPolicyAsync()  : Promise
describeAction()  : Result
describeActionAsync()  : Promise
describeAsset()  : Result
describeAssetAsync()  : Promise
describeAssetCompositeModel()  : Result
describeAssetCompositeModelAsync()  : Promise
describeAssetModel()  : Result
describeAssetModelAsync()  : Promise
describeAssetModelCompositeModel()  : Result
describeAssetModelCompositeModelAsync()  : Promise
describeAssetProperty()  : Result
describeAssetPropertyAsync()  : Promise
describeBulkImportJob()  : Result
describeBulkImportJobAsync()  : Promise
describeDashboard()  : Result
describeDashboardAsync()  : Promise
describeDefaultEncryptionConfiguration()  : Result
describeDefaultEncryptionConfigurationAsync()  : Promise
describeGateway()  : Result
describeGatewayAsync()  : Promise
describeGatewayCapabilityConfiguration()  : Result
describeGatewayCapabilityConfigurationAsync()  : Promise
describeLoggingOptions()  : Result
describeLoggingOptionsAsync()  : Promise
describePortal()  : Result
describePortalAsync()  : Promise
describeProject()  : Result
describeProjectAsync()  : Promise
describeStorageConfiguration()  : Result
describeStorageConfigurationAsync()  : Promise
describeTimeSeries()  : Result
describeTimeSeriesAsync()  : Promise
disassociateAssets()  : Result
disassociateAssetsAsync()  : Promise
disassociateTimeSeriesFromAssetProperty()  : Result
disassociateTimeSeriesFromAssetPropertyAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAction()  : Result
executeActionAsync()  : Promise
executeAsync()  : mixed
executeQuery()  : Result
executeQueryAsync()  : Promise
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getAssetPropertyAggregates()  : Result
getAssetPropertyAggregatesAsync()  : Promise
getAssetPropertyValue()  : Result
getAssetPropertyValueAsync()  : Promise
getAssetPropertyValueHistory()  : Result
getAssetPropertyValueHistoryAsync()  : Promise
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.
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.
getInterpolatedAssetPropertyValues()  : Result
getInterpolatedAssetPropertyValuesAsync()  : Promise
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
listAccessPolicies()  : Result
listAccessPoliciesAsync()  : Promise
listActions()  : Result
listActionsAsync()  : Promise
listAssetModelCompositeModels()  : Result
listAssetModelCompositeModelsAsync()  : Promise
listAssetModelProperties()  : Result
listAssetModelPropertiesAsync()  : Promise
listAssetModels()  : Result
listAssetModelsAsync()  : Promise
listAssetProperties()  : Result
listAssetPropertiesAsync()  : Promise
listAssetRelationships()  : Result
listAssetRelationshipsAsync()  : Promise
listAssets()  : Result
listAssetsAsync()  : Promise
listAssociatedAssets()  : Result
listAssociatedAssetsAsync()  : Promise
listBulkImportJobs()  : Result
listBulkImportJobsAsync()  : Promise
listCompositionRelationships()  : Result
listCompositionRelationshipsAsync()  : Promise
listDashboards()  : Result
listDashboardsAsync()  : Promise
listGateways()  : Result
listGatewaysAsync()  : Promise
listPortals()  : Result
listPortalsAsync()  : Promise
listProjectAssets()  : Result
listProjectAssetsAsync()  : Promise
listProjects()  : Result
listProjectsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listTimeSeries()  : Result
listTimeSeriesAsync()  : Promise
putDefaultEncryptionConfiguration()  : Result
putDefaultEncryptionConfigurationAsync()  : Promise
putLoggingOptions()  : Result
putLoggingOptionsAsync()  : Promise
putStorageConfiguration()  : Result
putStorageConfigurationAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAccessPolicy()  : Result
updateAccessPolicyAsync()  : Promise
updateAsset()  : Result
updateAssetAsync()  : Promise
updateAssetModel()  : Result
updateAssetModelAsync()  : Promise
updateAssetModelCompositeModel()  : Result
updateAssetModelCompositeModelAsync()  : Promise
updateAssetProperty()  : Result
updateAssetPropertyAsync()  : Promise
updateDashboard()  : Result
updateDashboardAsync()  : Promise
updateGateway()  : Result
updateGatewayAsync()  : Promise
updateGatewayCapabilityConfiguration()  : Result
updateGatewayCapabilityConfigurationAsync()  : Promise
updatePortal()  : Result
updatePortalAsync()  : Promise
updateProject()  : Result
updateProjectAsync()  : 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
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

associateAssets()

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

associateAssetsAsync()

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

associateTimeSeriesToAssetProperty()

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

associateTimeSeriesToAssetPropertyAsync()

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

batchAssociateProjectAssets()

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

batchAssociateProjectAssetsAsync()

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

batchDisassociateProjectAssets()

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

batchDisassociateProjectAssetsAsync()

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

batchGetAssetPropertyAggregates()

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

batchGetAssetPropertyAggregatesAsync()

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

batchGetAssetPropertyValue()

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

batchGetAssetPropertyValueAsync()

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

batchGetAssetPropertyValueHistory()

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

batchGetAssetPropertyValueHistoryAsync()

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

batchPutAssetPropertyValue()

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

batchPutAssetPropertyValueAsync()

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

createAccessPolicy()

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

createAccessPolicyAsync()

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

createAsset()

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

createAssetAsync()

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

createAssetModel()

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

createAssetModelAsync()

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

createAssetModelCompositeModel()

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

createAssetModelCompositeModelAsync()

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

createBulkImportJob()

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

createBulkImportJobAsync()

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

createDashboard()

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

createDashboardAsync()

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

createGateway()

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

createGatewayAsync()

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

createPortal()

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

createPortalAsync()

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

createProject()

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

createProjectAsync()

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

deleteAccessPolicy()

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

deleteAccessPolicyAsync()

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

deleteAsset()

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

deleteAssetAsync()

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

deleteAssetModel()

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

deleteAssetModelAsync()

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

deleteAssetModelCompositeModel()

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

deleteAssetModelCompositeModelAsync()

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

deleteDashboard()

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

deleteDashboardAsync()

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

deleteGateway()

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

deleteGatewayAsync()

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

deletePortal()

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

deletePortalAsync()

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

deleteProject()

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

deleteProjectAsync()

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

deleteTimeSeries()

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

deleteTimeSeriesAsync()

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

describeAccessPolicy()

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

describeAccessPolicyAsync()

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

describeAction()

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

describeActionAsync()

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

describeAsset()

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

describeAssetAsync()

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

describeAssetCompositeModel()

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

describeAssetCompositeModelAsync()

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

describeAssetModel()

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

describeAssetModelAsync()

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

describeAssetModelCompositeModel()

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

describeAssetModelCompositeModelAsync()

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

describeAssetProperty()

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

describeAssetPropertyAsync()

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

describeBulkImportJob()

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

describeBulkImportJobAsync()

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

describeDashboard()

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

describeDashboardAsync()

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

describeDefaultEncryptionConfiguration()

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

describeDefaultEncryptionConfigurationAsync()

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

describeGateway()

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

describeGatewayAsync()

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

describeGatewayCapabilityConfiguration()

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

describeGatewayCapabilityConfigurationAsync()

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

describeLoggingOptions()

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

describeLoggingOptionsAsync()

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

describePortal()

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

describePortalAsync()

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

describeProject()

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

describeProjectAsync()

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

describeStorageConfiguration()

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

describeStorageConfigurationAsync()

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

describeTimeSeries()

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

describeTimeSeriesAsync()

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

disassociateAssets()

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

disassociateAssetsAsync()

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

disassociateTimeSeriesFromAssetProperty()

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

disassociateTimeSeriesFromAssetPropertyAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

executeAction()

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

executeActionAsync()

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

executeQuery()

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

executeQueryAsync()

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

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>

getAssetPropertyAggregates()

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

getAssetPropertyAggregatesAsync()

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

getAssetPropertyValue()

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

getAssetPropertyValueAsync()

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

getAssetPropertyValueHistory()

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

getAssetPropertyValueHistoryAsync()

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

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
CommandInterface

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

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
HandlerList

getInterpolatedAssetPropertyValues()

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

getInterpolatedAssetPropertyValuesAsync()

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

getIterator()

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

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, 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> = []

listAccessPolicies()

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

listAccessPoliciesAsync()

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

listActions()

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

listActionsAsync()

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

listAssetModelCompositeModels()

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

listAssetModelCompositeModelsAsync()

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

listAssetModelProperties()

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

listAssetModelPropertiesAsync()

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

listAssetModels()

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

listAssetModelsAsync()

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

listAssetProperties()

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

listAssetPropertiesAsync()

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

listAssetRelationships()

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

listAssetRelationshipsAsync()

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

listAssets()

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

listAssetsAsync()

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

listAssociatedAssets()

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

listAssociatedAssetsAsync()

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

listBulkImportJobs()

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

listBulkImportJobsAsync()

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

listCompositionRelationships()

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

listCompositionRelationshipsAsync()

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

listDashboards()

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

listDashboardsAsync()

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

listGateways()

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

listGatewaysAsync()

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

listPortals()

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

listPortalsAsync()

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

listProjectAssets()

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

listProjectAssetsAsync()

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

listProjects()

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

listProjectsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTimeSeries()

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

listTimeSeriesAsync()

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

putDefaultEncryptionConfiguration()

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

putDefaultEncryptionConfigurationAsync()

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

putLoggingOptions()

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

putLoggingOptionsAsync()

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

putStorageConfiguration()

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

putStorageConfigurationAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAccessPolicy()

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

updateAccessPolicyAsync()

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

updateAsset()

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

updateAssetAsync()

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

updateAssetModel()

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

updateAssetModelAsync()

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

updateAssetModelCompositeModel()

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

updateAssetModelCompositeModelAsync()

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

updateAssetProperty()

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

updateAssetPropertyAsync()

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

updateDashboard()

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

updateDashboardAsync()

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

updateGateway()

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

updateGatewayAsync()

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

updateGatewayCapabilityConfiguration()

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

updateGatewayCapabilityConfigurationAsync()

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

updatePortal()

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

updatePortalAsync()

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

updateProject()

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

updateProjectAsync()

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page