Documentation

AlexaForBusinessClient extends AwsClient
in package

This client is used to interact with the **Alexa For Business** 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
approveSkill()  :
approveSkillAsync()  :
associateContactWithAddressBook()  :
associateContactWithAddressBookAsync()  :
associateDeviceWithNetworkProfile()  :
associateDeviceWithNetworkProfileAsync()  :
associateDeviceWithRoom()  :
associateDeviceWithRoomAsync()  :
associateSkillGroupWithRoom()  :
associateSkillGroupWithRoomAsync()  :
associateSkillWithSkillGroup()  :
associateSkillWithSkillGroupAsync()  :
associateSkillWithUsers()  :
associateSkillWithUsersAsync()  :
createAddressBook()  :
createAddressBookAsync()  :
createBusinessReportSchedule()  :
createBusinessReportScheduleAsync()  :
createConferenceProvider()  :
createConferenceProviderAsync()  :
createContact()  :
createContactAsync()  :
createGatewayGroup()  :
createGatewayGroupAsync()  :
createNetworkProfile()  :
createNetworkProfileAsync()  :
createProfile()  :
createProfileAsync()  :
createRoom()  :
createRoomAsync()  :
createSkillGroup()  :
createSkillGroupAsync()  :
createUser()  :
createUserAsync()  :
deleteAddressBook()  :
deleteAddressBookAsync()  :
deleteBusinessReportSchedule()  :
deleteBusinessReportScheduleAsync()  :
deleteConferenceProvider()  :
deleteConferenceProviderAsync()  :
deleteContact()  :
deleteContactAsync()  :
deleteDevice()  :
deleteDeviceAsync()  :
deleteDeviceUsageData()  :
deleteDeviceUsageDataAsync()  :
deleteGatewayGroup()  :
deleteGatewayGroupAsync()  :
deleteNetworkProfile()  :
deleteNetworkProfileAsync()  :
deleteProfile()  :
deleteProfileAsync()  :
deleteRoom()  :
deleteRoomAsync()  :
deleteRoomSkillParameter()  :
deleteRoomSkillParameterAsync()  :
deleteSkillAuthorization()  :
deleteSkillAuthorizationAsync()  :
deleteSkillGroup()  :
deleteSkillGroupAsync()  :
deleteUser()  :
deleteUserAsync()  :
disassociateContactFromAddressBook()  :
disassociateContactFromAddressBookAsync()  :
disassociateDeviceFromRoom()  :
disassociateDeviceFromRoomAsync()  :
disassociateSkillFromSkillGroup()  :
disassociateSkillFromSkillGroupAsync()  :
disassociateSkillFromUsers()  :
disassociateSkillFromUsersAsync()  :
disassociateSkillGroupFromRoom()  :
disassociateSkillGroupFromRoomAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
forgetSmartHomeAppliances()  :
forgetSmartHomeAppliancesAsync()  :
getAddressBook()  :
getAddressBookAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConferencePreference()  :
getConferencePreferenceAsync()  :
getConferenceProvider()  :
getConferenceProviderAsync()  :
getConfig()  : mixed|null
Get a client configuration value.
getContact()  :
getContactAsync()  :
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDevice()  :
getDeviceAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getGateway()  :
getGatewayAsync()  :
getGatewayGroup()  :
getGatewayGroupAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInvitationConfiguration()  :
getInvitationConfigurationAsync()  :
getIterator()  : mixed
getNetworkProfile()  :
getNetworkProfileAsync()  :
getPaginator()  : mixed
getProfile()  :
getProfileAsync()  :
getRegion()  : string
Get the region to which the client is configured to send requests.
getRoom()  :
getRoomAsync()  :
getRoomSkillParameter()  :
getRoomSkillParameterAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSkillGroup()  :
getSkillGroupAsync()  :
getWaiter()  : mixed
listBusinessReportSchedules()  :
listBusinessReportSchedulesAsync()  :
listConferenceProviders()  :
listConferenceProvidersAsync()  :
listDeviceEvents()  :
listDeviceEventsAsync()  :
listGatewayGroups()  :
listGatewayGroupsAsync()  :
listGateways()  :
listGatewaysAsync()  :
listSkills()  :
listSkillsAsync()  :
listSkillsStoreCategories()  :
listSkillsStoreCategoriesAsync()  :
listSkillsStoreSkillsByCategory()  :
listSkillsStoreSkillsByCategoryAsync()  :
listSmartHomeAppliances()  :
listSmartHomeAppliancesAsync()  :
listTags()  :
listTagsAsync()  :
putConferencePreference()  :
putConferencePreferenceAsync()  :
putInvitationConfiguration()  :
putInvitationConfigurationAsync()  :
putRoomSkillParameter()  :
putRoomSkillParameterAsync()  :
putSkillAuthorization()  :
putSkillAuthorizationAsync()  :
registerAVSDevice()  :
registerAVSDeviceAsync()  :
rejectSkill()  :
rejectSkillAsync()  :
resolveRoom()  :
resolveRoomAsync()  :
revokeInvitation()  :
revokeInvitationAsync()  :
searchAddressBooks()  :
searchAddressBooksAsync()  :
searchContacts()  :
searchContactsAsync()  :
searchDevices()  :
searchDevicesAsync()  :
searchNetworkProfiles()  :
searchNetworkProfilesAsync()  :
searchProfiles()  :
searchProfilesAsync()  :
searchRooms()  :
searchRoomsAsync()  :
searchSkillGroups()  :
searchSkillGroupsAsync()  :
searchUsers()  :
searchUsersAsync()  :
sendAnnouncement()  :
sendAnnouncementAsync()  :
sendInvitation()  :
sendInvitationAsync()  :
startDeviceSync()  :
startDeviceSyncAsync()  :
startSmartHomeApplianceDiscovery()  :
startSmartHomeApplianceDiscoveryAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateAddressBook()  :
updateAddressBookAsync()  :
updateBusinessReportSchedule()  :
updateBusinessReportScheduleAsync()  :
updateConferenceProvider()  :
updateConferenceProviderAsync()  :
updateContact()  :
updateContactAsync()  :
updateDevice()  :
updateDeviceAsync()  :
updateGateway()  :
updateGatewayAsync()  :
updateGatewayGroup()  :
updateGatewayGroupAsync()  :
updateNetworkProfile()  :
updateNetworkProfileAsync()  :
updateProfile()  :
updateProfileAsync()  :
updateRoom()  :
updateRoomAsync()  :
updateSkillGroup()  :
updateSkillGroupAsync()  :
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 —

approveSkill()

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

approveSkillAsync()

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

associateContactWithAddressBook()

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

associateContactWithAddressBookAsync()

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

associateDeviceWithNetworkProfile()

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

associateDeviceWithNetworkProfileAsync()

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

associateDeviceWithRoom()

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

associateDeviceWithRoomAsync()

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

associateSkillGroupWithRoom()

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

associateSkillGroupWithRoomAsync()

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

associateSkillWithSkillGroup()

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

associateSkillWithSkillGroupAsync()

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

associateSkillWithUsers()

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

associateSkillWithUsersAsync()

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

createAddressBook()

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

createAddressBookAsync()

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

createBusinessReportSchedule()

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

createBusinessReportScheduleAsync()

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

createConferenceProvider()

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

createConferenceProviderAsync()

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

createContact()

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

createContactAsync()

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

createGatewayGroup()

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

createGatewayGroupAsync()

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

createNetworkProfile()

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

createNetworkProfileAsync()

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

createProfile()

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

createProfileAsync()

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

createRoom()

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

createRoomAsync()

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

createSkillGroup()

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

createSkillGroupAsync()

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

createUser()

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

createUserAsync()

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

deleteAddressBook()

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

deleteAddressBookAsync()

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

deleteBusinessReportSchedule()

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

deleteBusinessReportScheduleAsync()

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

deleteConferenceProvider()

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

deleteConferenceProviderAsync()

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

deleteContact()

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

deleteContactAsync()

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

deleteDevice()

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

deleteDeviceAsync()

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

deleteDeviceUsageData()

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

deleteDeviceUsageDataAsync()

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

deleteGatewayGroup()

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

deleteGatewayGroupAsync()

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

deleteNetworkProfile()

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

deleteNetworkProfileAsync()

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

deleteProfile()

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

deleteProfileAsync()

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

deleteRoom()

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

deleteRoomAsync()

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

deleteRoomSkillParameter()

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

deleteRoomSkillParameterAsync()

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

deleteSkillAuthorization()

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

deleteSkillAuthorizationAsync()

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

deleteSkillGroup()

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

deleteSkillGroupAsync()

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

deleteUser()

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

deleteUserAsync()

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

disassociateContactFromAddressBook()

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

disassociateContactFromAddressBookAsync()

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

disassociateDeviceFromRoom()

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

disassociateDeviceFromRoomAsync()

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

disassociateSkillFromSkillGroup()

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

disassociateSkillFromSkillGroupAsync()

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

disassociateSkillFromUsers()

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

disassociateSkillFromUsersAsync()

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

disassociateSkillGroupFromRoom()

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

disassociateSkillGroupFromRoomAsync()

public disassociateSkillGroupFromRoomAsync(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 —

forgetSmartHomeAppliances()

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

forgetSmartHomeAppliancesAsync()

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

getAddressBook()

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

getAddressBookAsync()

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

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

getConferencePreference()

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

getConferencePreferenceAsync()

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

getConferenceProvider()

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

getConferenceProviderAsync()

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

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 —

getContact()

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

getContactAsync()

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

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 —

getDevice()

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

getDeviceAsync()

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

getGateway()

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

getGatewayAsync()

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

getGatewayGroup()

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

getGatewayGroupAsync()

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

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 —

getInvitationConfiguration()

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

getInvitationConfigurationAsync()

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

getIterator()

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

getNetworkProfile()

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

getNetworkProfileAsync()

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

getPaginator()

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

getProfile()

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

getProfileAsync()

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

getRegion()

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

public getRegion() : string
Return values
string —

getRoom()

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

getRoomAsync()

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

getRoomSkillParameter()

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

getRoomSkillParameterAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getSkillGroup()

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

getSkillGroupAsync()

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

getWaiter()

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

listBusinessReportSchedules()

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

listBusinessReportSchedulesAsync()

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

listConferenceProviders()

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

listConferenceProvidersAsync()

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

listDeviceEvents()

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

listDeviceEventsAsync()

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

listGatewayGroups()

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

listGatewayGroupsAsync()

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

listGateways()

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

listGatewaysAsync()

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

listSkills()

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

listSkillsAsync()

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

listSkillsStoreCategories()

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

listSkillsStoreCategoriesAsync()

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

listSkillsStoreSkillsByCategory()

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

listSkillsStoreSkillsByCategoryAsync()

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

listSmartHomeAppliances()

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

listSmartHomeAppliancesAsync()

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

listTags()

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

listTagsAsync()

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

putConferencePreference()

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

putConferencePreferenceAsync()

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

putInvitationConfiguration()

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

putInvitationConfigurationAsync()

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

putRoomSkillParameter()

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

putRoomSkillParameterAsync()

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

putSkillAuthorization()

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

putSkillAuthorizationAsync()

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

registerAVSDevice()

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

registerAVSDeviceAsync()

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

rejectSkill()

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

rejectSkillAsync()

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

resolveRoom()

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

resolveRoomAsync()

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

revokeInvitation()

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

revokeInvitationAsync()

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

searchAddressBooks()

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

searchAddressBooksAsync()

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

searchContacts()

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

searchContactsAsync()

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

searchDevices()

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

searchDevicesAsync()

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

searchNetworkProfiles()

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

searchNetworkProfilesAsync()

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

searchProfiles()

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

searchProfilesAsync()

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

searchRooms()

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

searchRoomsAsync()

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

searchSkillGroups()

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

searchSkillGroupsAsync()

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

searchUsers()

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

searchUsersAsync()

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

sendAnnouncement()

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

sendAnnouncementAsync()

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

sendInvitation()

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

sendInvitationAsync()

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

startDeviceSync()

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

startDeviceSyncAsync()

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

startSmartHomeApplianceDiscovery()

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

startSmartHomeApplianceDiscoveryAsync()

public startSmartHomeApplianceDiscoveryAsync(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
—

updateAddressBook()

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

updateAddressBookAsync()

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

updateBusinessReportSchedule()

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

updateBusinessReportScheduleAsync()

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

updateConferenceProvider()

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

updateConferenceProviderAsync()

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

updateContact()

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

updateContactAsync()

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

updateDevice()

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

updateDeviceAsync()

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

updateGateway()

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

updateGatewayAsync()

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

updateGatewayGroup()

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

updateGatewayGroupAsync()

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

updateNetworkProfile()

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

updateNetworkProfileAsync()

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

updateProfile()

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

updateProfileAsync()

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

updateRoom()

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

updateRoomAsync()

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

updateSkillGroup()

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

updateSkillGroupAsync()

public updateSkillGroupAsync(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