SDK for PHP 3.x

ChimeClient extends AwsClient
in package

This client is used to interact with the Amazon Chime 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
associatePhoneNumbersWithVoiceConnector()  : Result
associatePhoneNumbersWithVoiceConnectorAsync()  : Promise
associatePhoneNumbersWithVoiceConnectorGroup()  : Result
associatePhoneNumbersWithVoiceConnectorGroupAsync()  : Promise
associatePhoneNumberWithUser()  : Result
associatePhoneNumberWithUserAsync()  : Promise
associateSigninDelegateGroupsWithAccount()  : Result
associateSigninDelegateGroupsWithAccountAsync()  : Promise
batchCreateAttendee()  : Result
batchCreateAttendeeAsync()  : Promise
batchCreateChannelMembership()  : Result
batchCreateChannelMembershipAsync()  : Promise
batchCreateRoomMembership()  : Result
batchCreateRoomMembershipAsync()  : Promise
batchDeletePhoneNumber()  : Result
batchDeletePhoneNumberAsync()  : Promise
batchSuspendUser()  : Result
batchSuspendUserAsync()  : Promise
batchUnsuspendUser()  : Result
batchUnsuspendUserAsync()  : Promise
batchUpdatePhoneNumber()  : Result
batchUpdatePhoneNumberAsync()  : Promise
batchUpdateUser()  : Result
batchUpdateUserAsync()  : Promise
createAccount()  : Result
createAccountAsync()  : Promise
createAppInstance()  : Result
createAppInstanceAdmin()  : Result
createAppInstanceAdminAsync()  : Promise
createAppInstanceAsync()  : Promise
createAppInstanceUser()  : Result
createAppInstanceUserAsync()  : Promise
createAttendee()  : Result
createAttendeeAsync()  : Promise
createBot()  : Result
createBotAsync()  : Promise
createChannel()  : Result
createChannelAsync()  : Promise
createChannelBan()  : Result
createChannelBanAsync()  : Promise
createChannelMembership()  : Result
createChannelMembershipAsync()  : Promise
createChannelModerator()  : Result
createChannelModeratorAsync()  : Promise
createMediaCapturePipeline()  : Result
createMediaCapturePipelineAsync()  : Promise
createMeeting()  : Result
createMeetingAsync()  : Promise
createMeetingDialOut()  : Result
createMeetingDialOutAsync()  : Promise
createMeetingWithAttendees()  : Result
createMeetingWithAttendeesAsync()  : Promise
createPhoneNumberOrder()  : Result
createPhoneNumberOrderAsync()  : Promise
createProxySession()  : Result
createProxySessionAsync()  : Promise
createRoom()  : Result
createRoomAsync()  : Promise
createRoomMembership()  : Result
createRoomMembershipAsync()  : Promise
createSipMediaApplication()  : Result
createSipMediaApplicationAsync()  : Promise
createSipMediaApplicationCall()  : Result
createSipMediaApplicationCallAsync()  : Promise
createSipRule()  : Result
createSipRuleAsync()  : Promise
createUser()  : Result
createUserAsync()  : Promise
createVoiceConnector()  : Result
createVoiceConnectorAsync()  : Promise
createVoiceConnectorGroup()  : Result
createVoiceConnectorGroupAsync()  : Promise
deleteAccount()  : Result
deleteAccountAsync()  : Promise
deleteAppInstance()  : Result
deleteAppInstanceAdmin()  : Result
deleteAppInstanceAdminAsync()  : Promise
deleteAppInstanceAsync()  : Promise
deleteAppInstanceStreamingConfigurations()  : Result
deleteAppInstanceStreamingConfigurationsAsync()  : Promise
deleteAppInstanceUser()  : Result
deleteAppInstanceUserAsync()  : Promise
deleteAttendee()  : Result
deleteAttendeeAsync()  : Promise
deleteChannel()  : Result
deleteChannelAsync()  : Promise
deleteChannelBan()  : Result
deleteChannelBanAsync()  : Promise
deleteChannelMembership()  : Result
deleteChannelMembershipAsync()  : Promise
deleteChannelMessage()  : Result
deleteChannelMessageAsync()  : Promise
deleteChannelModerator()  : Result
deleteChannelModeratorAsync()  : Promise
deleteEventsConfiguration()  : Result
deleteEventsConfigurationAsync()  : Promise
deleteMediaCapturePipeline()  : Result
deleteMediaCapturePipelineAsync()  : Promise
deleteMeeting()  : Result
deleteMeetingAsync()  : Promise
deletePhoneNumber()  : Result
deletePhoneNumberAsync()  : Promise
deleteProxySession()  : Result
deleteProxySessionAsync()  : Promise
deleteRoom()  : Result
deleteRoomAsync()  : Promise
deleteRoomMembership()  : Result
deleteRoomMembershipAsync()  : Promise
deleteSipMediaApplication()  : Result
deleteSipMediaApplicationAsync()  : Promise
deleteSipRule()  : Result
deleteSipRuleAsync()  : Promise
deleteVoiceConnector()  : Result
deleteVoiceConnectorAsync()  : Promise
deleteVoiceConnectorEmergencyCallingConfiguration()  : Result
deleteVoiceConnectorEmergencyCallingConfigurationAsync()  : Promise
deleteVoiceConnectorGroup()  : Result
deleteVoiceConnectorGroupAsync()  : Promise
deleteVoiceConnectorOrigination()  : Result
deleteVoiceConnectorOriginationAsync()  : Promise
deleteVoiceConnectorProxy()  : Result
deleteVoiceConnectorProxyAsync()  : Promise
deleteVoiceConnectorStreamingConfiguration()  : Result
deleteVoiceConnectorStreamingConfigurationAsync()  : Promise
deleteVoiceConnectorTermination()  : Result
deleteVoiceConnectorTerminationAsync()  : Promise
deleteVoiceConnectorTerminationCredentials()  : Result
deleteVoiceConnectorTerminationCredentialsAsync()  : Promise
describeAppInstance()  : Result
describeAppInstanceAdmin()  : Result
describeAppInstanceAdminAsync()  : Promise
describeAppInstanceAsync()  : Promise
describeAppInstanceUser()  : Result
describeAppInstanceUserAsync()  : Promise
describeChannel()  : Result
describeChannelAsync()  : Promise
describeChannelBan()  : Result
describeChannelBanAsync()  : Promise
describeChannelMembership()  : Result
describeChannelMembershipAsync()  : Promise
describeChannelMembershipForAppInstanceUser()  : Result
describeChannelMembershipForAppInstanceUserAsync()  : Promise
describeChannelModeratedByAppInstanceUser()  : Result
describeChannelModeratedByAppInstanceUserAsync()  : Promise
describeChannelModerator()  : Result
describeChannelModeratorAsync()  : Promise
disassociatePhoneNumberFromUser()  : Result
disassociatePhoneNumberFromUserAsync()  : Promise
disassociatePhoneNumbersFromVoiceConnector()  : Result
disassociatePhoneNumbersFromVoiceConnectorAsync()  : Promise
disassociatePhoneNumbersFromVoiceConnectorGroup()  : Result
disassociatePhoneNumbersFromVoiceConnectorGroupAsync()  : Promise
disassociateSigninDelegateGroupsFromAccount()  : Result
disassociateSigninDelegateGroupsFromAccountAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccount()  : Result
getAccountAsync()  : Promise
getAccountSettings()  : Result
getAccountSettingsAsync()  : Promise
getApi()  : Service
getAppInstanceRetentionSettings()  : Result
getAppInstanceRetentionSettingsAsync()  : Promise
getAppInstanceStreamingConfigurations()  : Result
getAppInstanceStreamingConfigurationsAsync()  : Promise
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getAttendee()  : Result
getAttendeeAsync()  : Promise
getBot()  : Result
getBotAsync()  : Promise
getChannelMessage()  : Result
getChannelMessageAsync()  : 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.
getEventsConfiguration()  : Result
getEventsConfigurationAsync()  : Promise
getGlobalSettings()  : Result
getGlobalSettingsAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getMediaCapturePipeline()  : Result
getMediaCapturePipelineAsync()  : Promise
getMeeting()  : Result
getMeetingAsync()  : Promise
getMessagingSessionEndpoint()  : Result
getMessagingSessionEndpointAsync()  : Promise
getPaginator()  : mixed
getPhoneNumber()  : Result
getPhoneNumberAsync()  : Promise
getPhoneNumberOrder()  : Result
getPhoneNumberOrderAsync()  : Promise
getPhoneNumberSettings()  : Result
getPhoneNumberSettingsAsync()  : Promise
getProxySession()  : Result
getProxySessionAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getRetentionSettings()  : Result
getRetentionSettingsAsync()  : Promise
getRoom()  : Result
getRoomAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSipMediaApplication()  : Result
getSipMediaApplicationAsync()  : Promise
getSipMediaApplicationLoggingConfiguration()  : Result
getSipMediaApplicationLoggingConfigurationAsync()  : Promise
getSipRule()  : Result
getSipRuleAsync()  : Promise
getUser()  : Result
getUserAsync()  : Promise
getUserSettings()  : Result
getUserSettingsAsync()  : Promise
getVoiceConnector()  : Result
getVoiceConnectorAsync()  : Promise
getVoiceConnectorEmergencyCallingConfiguration()  : Result
getVoiceConnectorEmergencyCallingConfigurationAsync()  : Promise
getVoiceConnectorGroup()  : Result
getVoiceConnectorGroupAsync()  : Promise
getVoiceConnectorLoggingConfiguration()  : Result
getVoiceConnectorLoggingConfigurationAsync()  : Promise
getVoiceConnectorOrigination()  : Result
getVoiceConnectorOriginationAsync()  : Promise
getVoiceConnectorProxy()  : Result
getVoiceConnectorProxyAsync()  : Promise
getVoiceConnectorStreamingConfiguration()  : Result
getVoiceConnectorStreamingConfigurationAsync()  : Promise
getVoiceConnectorTermination()  : Result
getVoiceConnectorTerminationAsync()  : Promise
getVoiceConnectorTerminationHealth()  : Result
getVoiceConnectorTerminationHealthAsync()  : Promise
getWaiter()  : mixed
inviteUsers()  : Result
inviteUsersAsync()  : Promise
listAccounts()  : Result
listAccountsAsync()  : Promise
listAppInstanceAdmins()  : Result
listAppInstanceAdminsAsync()  : Promise
listAppInstances()  : Result
listAppInstancesAsync()  : Promise
listAppInstanceUsers()  : Result
listAppInstanceUsersAsync()  : Promise
listAttendees()  : Result
listAttendeesAsync()  : Promise
listAttendeeTags()  : Result
listAttendeeTagsAsync()  : Promise
listBots()  : Result
listBotsAsync()  : Promise
listChannelBans()  : Result
listChannelBansAsync()  : Promise
listChannelMemberships()  : Result
listChannelMembershipsAsync()  : Promise
listChannelMembershipsForAppInstanceUser()  : Result
listChannelMembershipsForAppInstanceUserAsync()  : Promise
listChannelMessages()  : Result
listChannelMessagesAsync()  : Promise
listChannelModerators()  : Result
listChannelModeratorsAsync()  : Promise
listChannels()  : Result
listChannelsAsync()  : Promise
listChannelsModeratedByAppInstanceUser()  : Result
listChannelsModeratedByAppInstanceUserAsync()  : Promise
listMediaCapturePipelines()  : Result
listMediaCapturePipelinesAsync()  : Promise
listMeetings()  : Result
listMeetingsAsync()  : Promise
listMeetingTags()  : Result
listMeetingTagsAsync()  : Promise
listPhoneNumberOrders()  : Result
listPhoneNumberOrdersAsync()  : Promise
listPhoneNumbers()  : Result
listPhoneNumbersAsync()  : Promise
listProxySessions()  : Result
listProxySessionsAsync()  : Promise
listRoomMemberships()  : Result
listRoomMembershipsAsync()  : Promise
listRooms()  : Result
listRoomsAsync()  : Promise
listSipMediaApplications()  : Result
listSipMediaApplicationsAsync()  : Promise
listSipRules()  : Result
listSipRulesAsync()  : Promise
listSupportedPhoneNumberCountries()  : Result
listSupportedPhoneNumberCountriesAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listUsers()  : Result
listUsersAsync()  : Promise
listVoiceConnectorGroups()  : Result
listVoiceConnectorGroupsAsync()  : Promise
listVoiceConnectors()  : Result
listVoiceConnectorsAsync()  : Promise
listVoiceConnectorTerminationCredentials()  : Result
listVoiceConnectorTerminationCredentialsAsync()  : Promise
logoutUser()  : Result
logoutUserAsync()  : Promise
putAppInstanceRetentionSettings()  : Result
putAppInstanceRetentionSettingsAsync()  : Promise
putAppInstanceStreamingConfigurations()  : Result
putAppInstanceStreamingConfigurationsAsync()  : Promise
putEventsConfiguration()  : Result
putEventsConfigurationAsync()  : Promise
putRetentionSettings()  : Result
putRetentionSettingsAsync()  : Promise
putSipMediaApplicationLoggingConfiguration()  : Result
putSipMediaApplicationLoggingConfigurationAsync()  : Promise
putVoiceConnectorEmergencyCallingConfiguration()  : Result
putVoiceConnectorEmergencyCallingConfigurationAsync()  : Promise
putVoiceConnectorLoggingConfiguration()  : Result
putVoiceConnectorLoggingConfigurationAsync()  : Promise
putVoiceConnectorOrigination()  : Result
putVoiceConnectorOriginationAsync()  : Promise
putVoiceConnectorProxy()  : Result
putVoiceConnectorProxyAsync()  : Promise
putVoiceConnectorStreamingConfiguration()  : Result
putVoiceConnectorStreamingConfigurationAsync()  : Promise
putVoiceConnectorTermination()  : Result
putVoiceConnectorTerminationAsync()  : Promise
putVoiceConnectorTerminationCredentials()  : Result
putVoiceConnectorTerminationCredentialsAsync()  : Promise
redactChannelMessage()  : Result
redactChannelMessageAsync()  : Promise
redactConversationMessage()  : Result
redactConversationMessageAsync()  : Promise
redactRoomMessage()  : Result
redactRoomMessageAsync()  : Promise
regenerateSecurityToken()  : Result
regenerateSecurityTokenAsync()  : Promise
resetPersonalPIN()  : Result
resetPersonalPINAsync()  : Promise
restorePhoneNumber()  : Result
restorePhoneNumberAsync()  : Promise
searchAvailablePhoneNumbers()  : Result
searchAvailablePhoneNumbersAsync()  : Promise
sendChannelMessage()  : Result
sendChannelMessageAsync()  : Promise
startMeetingTranscription()  : Result
startMeetingTranscriptionAsync()  : Promise
stopMeetingTranscription()  : Result
stopMeetingTranscriptionAsync()  : Promise
tagAttendee()  : Result
tagAttendeeAsync()  : Promise
tagMeeting()  : Result
tagMeetingAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagAttendee()  : Result
untagAttendeeAsync()  : Promise
untagMeeting()  : Result
untagMeetingAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAccount()  : Result
updateAccountAsync()  : Promise
updateAccountSettings()  : Result
updateAccountSettingsAsync()  : Promise
updateAppInstance()  : Result
updateAppInstanceAsync()  : Promise
updateAppInstanceUser()  : Result
updateAppInstanceUserAsync()  : Promise
updateBot()  : Result
updateBotAsync()  : Promise
updateChannel()  : Result
updateChannelAsync()  : Promise
updateChannelMessage()  : Result
updateChannelMessageAsync()  : Promise
updateChannelReadMarker()  : Result
updateChannelReadMarkerAsync()  : Promise
updateGlobalSettings()  : Result
updateGlobalSettingsAsync()  : Promise
updatePhoneNumber()  : Result
updatePhoneNumberAsync()  : Promise
updatePhoneNumberSettings()  : Result
updatePhoneNumberSettingsAsync()  : Promise
updateProxySession()  : Result
updateProxySessionAsync()  : Promise
updateRoom()  : Result
updateRoomAsync()  : Promise
updateRoomMembership()  : Result
updateRoomMembershipAsync()  : Promise
updateSipMediaApplication()  : Result
updateSipMediaApplicationAsync()  : Promise
updateSipMediaApplicationCall()  : Result
updateSipMediaApplicationCallAsync()  : Promise
updateSipRule()  : Result
updateSipRuleAsync()  : Promise
updateUser()  : Result
updateUserAsync()  : Promise
updateUserSettings()  : Result
updateUserSettingsAsync()  : Promise
updateVoiceConnector()  : Result
updateVoiceConnectorAsync()  : Promise
updateVoiceConnectorGroup()  : Result
updateVoiceConnectorGroupAsync()  : Promise
validateE911Address()  : Result
validateE911AddressAsync()  : 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

associatePhoneNumbersWithVoiceConnector()

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

associatePhoneNumbersWithVoiceConnectorAsync()

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

associatePhoneNumbersWithVoiceConnectorGroup()

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

associatePhoneNumbersWithVoiceConnectorGroupAsync()

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

associatePhoneNumberWithUser()

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

associatePhoneNumberWithUserAsync()

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

associateSigninDelegateGroupsWithAccount()

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

associateSigninDelegateGroupsWithAccountAsync()

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

batchCreateAttendee()

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

batchCreateAttendeeAsync()

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

batchCreateChannelMembership()

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

batchCreateChannelMembershipAsync()

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

batchCreateRoomMembership()

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

batchCreateRoomMembershipAsync()

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

batchDeletePhoneNumber()

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

batchDeletePhoneNumberAsync()

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

batchSuspendUser()

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

batchSuspendUserAsync()

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

batchUnsuspendUser()

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

batchUnsuspendUserAsync()

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

batchUpdatePhoneNumber()

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

batchUpdatePhoneNumberAsync()

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

batchUpdateUser()

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

batchUpdateUserAsync()

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

createAccount()

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

createAccountAsync()

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

createAppInstance()

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

createAppInstanceAdmin()

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

createAppInstanceAdminAsync()

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

createAppInstanceAsync()

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

createAppInstanceUser()

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

createAppInstanceUserAsync()

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

createAttendee()

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

createAttendeeAsync()

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

createBot()

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

createBotAsync()

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

createChannel()

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

createChannelAsync()

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

createChannelBan()

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

createChannelBanAsync()

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

createChannelMembership()

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

createChannelMembershipAsync()

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

createChannelModerator()

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

createChannelModeratorAsync()

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

createMediaCapturePipeline()

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

createMediaCapturePipelineAsync()

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

createMeeting()

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

createMeetingAsync()

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

createMeetingDialOut()

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

createMeetingDialOutAsync()

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

createMeetingWithAttendees()

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

createMeetingWithAttendeesAsync()

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

createPhoneNumberOrder()

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

createPhoneNumberOrderAsync()

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

createProxySession()

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

createProxySessionAsync()

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

createRoom()

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

createRoomAsync()

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

createRoomMembership()

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

createRoomMembershipAsync()

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

createSipMediaApplication()

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

createSipMediaApplicationAsync()

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

createSipMediaApplicationCall()

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

createSipMediaApplicationCallAsync()

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

createSipRule()

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

createSipRuleAsync()

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

createUser()

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

createUserAsync()

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

createVoiceConnector()

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

createVoiceConnectorAsync()

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

createVoiceConnectorGroup()

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

createVoiceConnectorGroupAsync()

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

deleteAccount()

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

deleteAccountAsync()

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

deleteAppInstance()

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

deleteAppInstanceAdmin()

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

deleteAppInstanceAdminAsync()

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

deleteAppInstanceAsync()

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

deleteAppInstanceStreamingConfigurations()

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

deleteAppInstanceStreamingConfigurationsAsync()

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

deleteAppInstanceUser()

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

deleteAppInstanceUserAsync()

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

deleteAttendee()

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

deleteAttendeeAsync()

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

deleteChannel()

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

deleteChannelAsync()

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

deleteChannelBan()

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

deleteChannelBanAsync()

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

deleteChannelMembership()

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

deleteChannelMembershipAsync()

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

deleteChannelMessage()

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

deleteChannelMessageAsync()

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

deleteChannelModerator()

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

deleteChannelModeratorAsync()

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

deleteEventsConfiguration()

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

deleteEventsConfigurationAsync()

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

deleteMediaCapturePipeline()

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

deleteMediaCapturePipelineAsync()

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

deleteMeeting()

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

deleteMeetingAsync()

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

deletePhoneNumber()

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

deletePhoneNumberAsync()

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

deleteProxySession()

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

deleteProxySessionAsync()

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

deleteRoom()

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

deleteRoomAsync()

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

deleteRoomMembership()

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

deleteRoomMembershipAsync()

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

deleteSipMediaApplication()

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

deleteSipMediaApplicationAsync()

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

deleteSipRule()

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

deleteSipRuleAsync()

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

deleteVoiceConnector()

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

deleteVoiceConnectorAsync()

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

deleteVoiceConnectorEmergencyCallingConfiguration()

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

deleteVoiceConnectorEmergencyCallingConfigurationAsync()

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

deleteVoiceConnectorGroup()

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

deleteVoiceConnectorGroupAsync()

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

deleteVoiceConnectorOrigination()

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

deleteVoiceConnectorOriginationAsync()

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

deleteVoiceConnectorProxy()

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

deleteVoiceConnectorProxyAsync()

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

deleteVoiceConnectorStreamingConfiguration()

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

deleteVoiceConnectorStreamingConfigurationAsync()

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

deleteVoiceConnectorTermination()

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

deleteVoiceConnectorTerminationAsync()

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

deleteVoiceConnectorTerminationCredentials()

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

deleteVoiceConnectorTerminationCredentialsAsync()

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

describeAppInstance()

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

describeAppInstanceAdmin()

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

describeAppInstanceAdminAsync()

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

describeAppInstanceAsync()

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

describeAppInstanceUser()

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

describeAppInstanceUserAsync()

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

describeChannel()

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

describeChannelAsync()

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

describeChannelBan()

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

describeChannelBanAsync()

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

describeChannelMembership()

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

describeChannelMembershipAsync()

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

describeChannelMembershipForAppInstanceUser()

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

describeChannelMembershipForAppInstanceUserAsync()

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

describeChannelModeratedByAppInstanceUser()

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

describeChannelModeratedByAppInstanceUserAsync()

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

describeChannelModerator()

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

describeChannelModeratorAsync()

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

disassociatePhoneNumberFromUser()

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

disassociatePhoneNumberFromUserAsync()

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

disassociatePhoneNumbersFromVoiceConnector()

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

disassociatePhoneNumbersFromVoiceConnectorAsync()

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

disassociatePhoneNumbersFromVoiceConnectorGroup()

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

disassociatePhoneNumbersFromVoiceConnectorGroupAsync()

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

disassociateSigninDelegateGroupsFromAccount()

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

disassociateSigninDelegateGroupsFromAccountAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

getAccount()

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

getAccountAsync()

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

getAccountSettings()

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

getAccountSettingsAsync()

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

getAppInstanceRetentionSettings()

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

getAppInstanceRetentionSettingsAsync()

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

getAppInstanceStreamingConfigurations()

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

getAppInstanceStreamingConfigurationsAsync()

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

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>

getAttendee()

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

getAttendeeAsync()

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

getBot()

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

getBotAsync()

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

getChannelMessage()

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

getChannelMessageAsync()

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

getEventsConfiguration()

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

getEventsConfigurationAsync()

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

getGlobalSettings()

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

getGlobalSettingsAsync()

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList

getIterator()

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

getMediaCapturePipeline()

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

getMediaCapturePipelineAsync()

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

getMeeting()

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

getMeetingAsync()

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

getMessagingSessionEndpoint()

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

getMessagingSessionEndpointAsync()

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

getPaginator()

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

getPhoneNumber()

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

getPhoneNumberAsync()

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

getPhoneNumberOrder()

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

getPhoneNumberOrderAsync()

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

getPhoneNumberSettings()

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

getPhoneNumberSettingsAsync()

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

getProxySession()

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

getProxySessionAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getRetentionSettings()

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

getRetentionSettingsAsync()

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

getRoom()

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

getRoomAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getSipMediaApplication()

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

getSipMediaApplicationAsync()

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

getSipMediaApplicationLoggingConfiguration()

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

getSipMediaApplicationLoggingConfigurationAsync()

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

getSipRule()

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

getSipRuleAsync()

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

getUser()

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

getUserAsync()

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

getUserSettings()

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

getUserSettingsAsync()

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

getVoiceConnector()

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

getVoiceConnectorAsync()

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

getVoiceConnectorEmergencyCallingConfiguration()

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

getVoiceConnectorEmergencyCallingConfigurationAsync()

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

getVoiceConnectorGroup()

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

getVoiceConnectorGroupAsync()

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

getVoiceConnectorLoggingConfiguration()

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

getVoiceConnectorLoggingConfigurationAsync()

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

getVoiceConnectorOrigination()

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

getVoiceConnectorOriginationAsync()

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

getVoiceConnectorProxy()

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

getVoiceConnectorProxyAsync()

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

getVoiceConnectorStreamingConfiguration()

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

getVoiceConnectorStreamingConfigurationAsync()

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

getVoiceConnectorTermination()

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

getVoiceConnectorTerminationAsync()

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

getVoiceConnectorTerminationHealth()

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

getVoiceConnectorTerminationHealthAsync()

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

getWaiter()

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

inviteUsers()

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

inviteUsersAsync()

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

listAccounts()

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

listAccountsAsync()

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

listAppInstanceAdmins()

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

listAppInstanceAdminsAsync()

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

listAppInstances()

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

listAppInstancesAsync()

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

listAppInstanceUsers()

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

listAppInstanceUsersAsync()

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

listAttendees()

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

listAttendeesAsync()

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

listAttendeeTags()

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

listAttendeeTagsAsync()

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

listBots()

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

listBotsAsync()

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

listChannelBans()

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

listChannelBansAsync()

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

listChannelMemberships()

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

listChannelMembershipsAsync()

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

listChannelMembershipsForAppInstanceUser()

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

listChannelMembershipsForAppInstanceUserAsync()

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

listChannelMessages()

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

listChannelMessagesAsync()

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

listChannelModerators()

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

listChannelModeratorsAsync()

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

listChannels()

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

listChannelsAsync()

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

listChannelsModeratedByAppInstanceUser()

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

listChannelsModeratedByAppInstanceUserAsync()

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

listMediaCapturePipelines()

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

listMediaCapturePipelinesAsync()

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

listMeetings()

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

listMeetingsAsync()

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

listMeetingTags()

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

listMeetingTagsAsync()

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

listPhoneNumberOrders()

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

listPhoneNumberOrdersAsync()

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

listPhoneNumbers()

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

listPhoneNumbersAsync()

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

listProxySessions()

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

listProxySessionsAsync()

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

listRoomMemberships()

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

listRoomMembershipsAsync()

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

listRooms()

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

listRoomsAsync()

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

listSipMediaApplications()

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

listSipMediaApplicationsAsync()

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

listSipRules()

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

listSipRulesAsync()

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

listSupportedPhoneNumberCountries()

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

listSupportedPhoneNumberCountriesAsync()

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

listUsers()

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

listUsersAsync()

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

listVoiceConnectorGroups()

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

listVoiceConnectorGroupsAsync()

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

listVoiceConnectors()

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

listVoiceConnectorsAsync()

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

listVoiceConnectorTerminationCredentials()

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

listVoiceConnectorTerminationCredentialsAsync()

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

logoutUser()

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

logoutUserAsync()

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

putAppInstanceRetentionSettings()

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

putAppInstanceRetentionSettingsAsync()

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

putAppInstanceStreamingConfigurations()

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

putAppInstanceStreamingConfigurationsAsync()

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

putEventsConfiguration()

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

putEventsConfigurationAsync()

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

putRetentionSettings()

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

putRetentionSettingsAsync()

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

putSipMediaApplicationLoggingConfiguration()

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

putSipMediaApplicationLoggingConfigurationAsync()

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

putVoiceConnectorEmergencyCallingConfiguration()

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

putVoiceConnectorEmergencyCallingConfigurationAsync()

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

putVoiceConnectorLoggingConfiguration()

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

putVoiceConnectorLoggingConfigurationAsync()

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

putVoiceConnectorOrigination()

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

putVoiceConnectorOriginationAsync()

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

putVoiceConnectorProxy()

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

putVoiceConnectorProxyAsync()

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

putVoiceConnectorStreamingConfiguration()

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

putVoiceConnectorStreamingConfigurationAsync()

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

putVoiceConnectorTermination()

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

putVoiceConnectorTerminationAsync()

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

putVoiceConnectorTerminationCredentials()

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

putVoiceConnectorTerminationCredentialsAsync()

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

redactChannelMessage()

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

redactChannelMessageAsync()

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

redactConversationMessage()

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

redactConversationMessageAsync()

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

redactRoomMessage()

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

redactRoomMessageAsync()

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

regenerateSecurityToken()

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

regenerateSecurityTokenAsync()

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

resetPersonalPIN()

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

resetPersonalPINAsync()

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

restorePhoneNumber()

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

restorePhoneNumberAsync()

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

searchAvailablePhoneNumbers()

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

searchAvailablePhoneNumbersAsync()

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

sendChannelMessage()

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

sendChannelMessageAsync()

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

startMeetingTranscription()

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

startMeetingTranscriptionAsync()

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

stopMeetingTranscription()

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

stopMeetingTranscriptionAsync()

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

tagAttendee()

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

tagAttendeeAsync()

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

tagMeeting()

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

tagMeetingAsync()

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

untagAttendee()

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

untagAttendeeAsync()

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

untagMeeting()

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

untagMeetingAsync()

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

updateAccount()

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

updateAccountAsync()

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

updateAccountSettings()

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

updateAccountSettingsAsync()

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

updateAppInstance()

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

updateAppInstanceAsync()

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

updateAppInstanceUser()

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

updateAppInstanceUserAsync()

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

updateBot()

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

updateBotAsync()

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

updateChannel()

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

updateChannelAsync()

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

updateChannelMessage()

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

updateChannelMessageAsync()

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

updateChannelReadMarker()

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

updateChannelReadMarkerAsync()

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

updateGlobalSettings()

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

updateGlobalSettingsAsync()

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

updatePhoneNumber()

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

updatePhoneNumberAsync()

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

updatePhoneNumberSettings()

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

updatePhoneNumberSettingsAsync()

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

updateProxySession()

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

updateProxySessionAsync()

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

updateRoom()

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

updateRoomAsync()

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

updateRoomMembership()

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

updateRoomMembershipAsync()

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

updateSipMediaApplication()

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

updateSipMediaApplicationAsync()

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

updateSipMediaApplicationCall()

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

updateSipMediaApplicationCallAsync()

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

updateSipRule()

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

updateSipRuleAsync()

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

updateUser()

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

updateUserAsync()

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

updateUserSettings()

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

updateUserSettingsAsync()

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

updateVoiceConnector()

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

updateVoiceConnectorAsync()

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

updateVoiceConnectorGroup()

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

updateVoiceConnectorGroupAsync()

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

validateE911Address()

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

validateE911AddressAsync()

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