ConnectClient
extends AwsClient
in package
This client is used to interact with the **Amazon Connect Service** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- associateApprovedOrigin() :
- associateApprovedOriginAsync() :
- associateInstanceStorageConfig() :
- associateInstanceStorageConfigAsync() :
- associateLambdaFunction() :
- associateLambdaFunctionAsync() :
- associateLexBot() :
- associateLexBotAsync() :
- associateRoutingProfileQueues() :
- associateRoutingProfileQueuesAsync() :
- associateSecurityKey() :
- associateSecurityKeyAsync() :
- createContactFlow() :
- createContactFlowAsync() :
- createInstance() :
- createInstanceAsync() :
- createIntegrationAssociation() :
- createIntegrationAssociationAsync() :
- createRoutingProfile() :
- createRoutingProfileAsync() :
- createUseCase() :
- createUseCaseAsync() :
- createUser() :
- createUserAsync() :
- createUserHierarchyGroup() :
- createUserHierarchyGroupAsync() :
- deleteInstance() :
- deleteInstanceAsync() :
- deleteIntegrationAssociation() :
- deleteIntegrationAssociationAsync() :
- deleteUseCase() :
- deleteUseCaseAsync() :
- deleteUser() :
- deleteUserAsync() :
- deleteUserHierarchyGroup() :
- deleteUserHierarchyGroupAsync() :
- describeContactFlow() :
- describeContactFlowAsync() :
- describeInstance() :
- describeInstanceAsync() :
- describeInstanceAttribute() :
- describeInstanceAttributeAsync() :
- describeInstanceStorageConfig() :
- describeInstanceStorageConfigAsync() :
- describeRoutingProfile() :
- describeRoutingProfileAsync() :
- describeUser() :
- describeUserAsync() :
- describeUserHierarchyGroup() :
- describeUserHierarchyGroupAsync() :
- describeUserHierarchyStructure() :
- describeUserHierarchyStructureAsync() :
- disassociateApprovedOrigin() :
- disassociateApprovedOriginAsync() :
- disassociateInstanceStorageConfig() :
- disassociateInstanceStorageConfigAsync() :
- disassociateLambdaFunction() :
- disassociateLambdaFunctionAsync() :
- disassociateLexBot() :
- disassociateLexBotAsync() :
- disassociateRoutingProfileQueues() :
- disassociateRoutingProfileQueuesAsync() :
- disassociateSecurityKey() :
- disassociateSecurityKeyAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getContactAttributes() :
- getContactAttributesAsync() :
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getCurrentMetricData() :
- getCurrentMetricDataAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getFederationToken() :
- getFederationTokenAsync() :
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getMetricData() :
- getMetricDataAsync() :
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listApprovedOrigins() :
- listApprovedOriginsAsync() :
- listContactFlows() :
- listContactFlowsAsync() :
- listHoursOfOperations() :
- listHoursOfOperationsAsync() :
- listInstanceAttributes() :
- listInstanceAttributesAsync() :
- listInstances() :
- listInstancesAsync() :
- listInstanceStorageConfigs() :
- listInstanceStorageConfigsAsync() :
- listIntegrationAssociations() :
- listIntegrationAssociationsAsync() :
- listLambdaFunctions() :
- listLambdaFunctionsAsync() :
- listLexBots() :
- listLexBotsAsync() :
- listPhoneNumbers() :
- listPhoneNumbersAsync() :
- listPrompts() :
- listPromptsAsync() :
- listQueues() :
- listQueuesAsync() :
- listRoutingProfileQueues() :
- listRoutingProfileQueuesAsync() :
- listRoutingProfiles() :
- listRoutingProfilesAsync() :
- listSecurityKeys() :
- listSecurityKeysAsync() :
- listSecurityProfiles() :
- listSecurityProfilesAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- listUseCases() :
- listUseCasesAsync() :
- listUserHierarchyGroups() :
- listUserHierarchyGroupsAsync() :
- listUsers() :
- listUsersAsync() :
- resumeContactRecording() :
- resumeContactRecordingAsync() :
- startChatContact() :
- startChatContactAsync() :
- startContactRecording() :
- startContactRecordingAsync() :
- startOutboundVoiceContact() :
- startOutboundVoiceContactAsync() :
- startTaskContact() :
- startTaskContactAsync() :
- stopContact() :
- stopContactAsync() :
- stopContactRecording() :
- stopContactRecordingAsync() :
- suspendContactRecording() :
- suspendContactRecordingAsync() :
- tagResource() :
- tagResourceAsync() :
- untagResource() :
- untagResourceAsync() :
- updateContactAttributes() :
- updateContactAttributesAsync() :
- updateContactFlowContent() :
- updateContactFlowContentAsync() :
- updateContactFlowName() :
- updateContactFlowNameAsync() :
- updateInstanceAttribute() :
- updateInstanceAttributeAsync() :
- updateInstanceStorageConfig() :
- updateInstanceStorageConfigAsync() :
- updateRoutingProfileConcurrency() :
- updateRoutingProfileConcurrencyAsync() :
- updateRoutingProfileDefaultOutboundQueue() :
- updateRoutingProfileDefaultOutboundQueueAsync() :
- updateRoutingProfileName() :
- updateRoutingProfileNameAsync() :
- updateRoutingProfileQueues() :
- updateRoutingProfileQueuesAsync() :
- updateUserHierarchy() :
- updateUserHierarchyAsync() :
- updateUserHierarchyGroupName() :
- updateUserHierarchyGroupNameAsync() :
- updateUserHierarchyStructure() :
- updateUserHierarchyStructureAsync() :
- updateUserIdentityInfo() :
- updateUserIdentityInfoAsync() :
- updateUserPhoneConfig() :
- updateUserPhoneConfigAsync() :
- updateUserRoutingProfile() :
- updateUserRoutingProfileAsync() :
- updateUserSecurityProfiles() :
- updateUserSecurityProfilesAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
Return values
mixed —__construct()
The client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
- credentials:
(Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
the credentials used to sign requests. Provide an
Aws\Credentials\CredentialsInterface object, an associative array of
"key", "secret", and an optional "token" key,
falseto use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment. - csm:
(Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies
the credentials used to sign requests. Provide an
Aws\ClientSideMonitoring\ConfigurationInterface object, a callable
configuration provider used to create client-side monitoring configuration,
falseto 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_receiveroption 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
schemeto "http". - signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
- signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
- use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
- validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
- version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —associateApprovedOrigin()
public
associateApprovedOrigin(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateApprovedOriginAsync()
public
associateApprovedOriginAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateInstanceStorageConfig()
public
associateInstanceStorageConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateInstanceStorageConfigAsync()
public
associateInstanceStorageConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateLambdaFunction()
public
associateLambdaFunction(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateLambdaFunctionAsync()
public
associateLambdaFunctionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateLexBot()
public
associateLexBot(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateLexBotAsync()
public
associateLexBotAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateRoutingProfileQueues()
public
associateRoutingProfileQueues(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateRoutingProfileQueuesAsync()
public
associateRoutingProfileQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateSecurityKey()
public
associateSecurityKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateSecurityKeyAsync()
public
associateSecurityKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createContactFlow()
public
createContactFlow(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createContactFlowAsync()
public
createContactFlowAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createInstance()
public
createInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createInstanceAsync()
public
createInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIntegrationAssociation()
public
createIntegrationAssociation(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIntegrationAssociationAsync()
public
createIntegrationAssociationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createRoutingProfile()
public
createRoutingProfile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createRoutingProfileAsync()
public
createRoutingProfileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUseCase()
public
createUseCase(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUseCaseAsync()
public
createUseCaseAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUser()
public
createUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserAsync()
public
createUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserHierarchyGroup()
public
createUserHierarchyGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserHierarchyGroupAsync()
public
createUserHierarchyGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteInstance()
public
deleteInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteInstanceAsync()
public
deleteInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIntegrationAssociation()
public
deleteIntegrationAssociation(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIntegrationAssociationAsync()
public
deleteIntegrationAssociationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUseCase()
public
deleteUseCase(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUseCaseAsync()
public
deleteUseCaseAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUser()
public
deleteUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserAsync()
public
deleteUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserHierarchyGroup()
public
deleteUserHierarchyGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserHierarchyGroupAsync()
public
deleteUserHierarchyGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeContactFlow()
public
describeContactFlow(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeContactFlowAsync()
public
describeContactFlowAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstance()
public
describeInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstanceAsync()
public
describeInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstanceAttribute()
public
describeInstanceAttribute(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstanceAttributeAsync()
public
describeInstanceAttributeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstanceStorageConfig()
public
describeInstanceStorageConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstanceStorageConfigAsync()
public
describeInstanceStorageConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeRoutingProfile()
public
describeRoutingProfile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeRoutingProfileAsync()
public
describeRoutingProfileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUser()
public
describeUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserAsync()
public
describeUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserHierarchyGroup()
public
describeUserHierarchyGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserHierarchyGroupAsync()
public
describeUserHierarchyGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserHierarchyStructure()
public
describeUserHierarchyStructure(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserHierarchyStructureAsync()
public
describeUserHierarchyStructureAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateApprovedOrigin()
public
disassociateApprovedOrigin(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateApprovedOriginAsync()
public
disassociateApprovedOriginAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateInstanceStorageConfig()
public
disassociateInstanceStorageConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateInstanceStorageConfigAsync()
public
disassociateInstanceStorageConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateLambdaFunction()
public
disassociateLambdaFunction(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateLambdaFunctionAsync()
public
disassociateLambdaFunctionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateLexBot()
public
disassociateLexBot(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateLexBotAsync()
public
disassociateLexBotAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateRoutingProfileQueues()
public
disassociateRoutingProfileQueues(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateRoutingProfileQueuesAsync()
public
disassociateRoutingProfileQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateSecurityKey()
public
disassociateSecurityKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateSecurityKeyAsync()
public
disassociateSecurityKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getApi()
public
abstract getApi() : Service
Return values
Service —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> —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 —getContactAttributes()
public
getContactAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getContactAttributesAsync()
public
getContactAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterface —getCurrentMetricData()
public
getCurrentMetricData(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCurrentMetricDataAsync()
public
getCurrentMetricDataAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getFederationToken()
public
getFederationToken(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getFederationTokenAsync()
public
getFederationTokenAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerList —getIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getMetricData()
public
getMetricData(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getMetricDataAsync()
public
getMetricDataAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
string —getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —listApprovedOrigins()
public
listApprovedOrigins(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listApprovedOriginsAsync()
public
listApprovedOriginsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listContactFlows()
public
listContactFlows(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listContactFlowsAsync()
public
listContactFlowsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHoursOfOperations()
public
listHoursOfOperations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHoursOfOperationsAsync()
public
listHoursOfOperationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstanceAttributes()
public
listInstanceAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstanceAttributesAsync()
public
listInstanceAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstances()
public
listInstances(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstancesAsync()
public
listInstancesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstanceStorageConfigs()
public
listInstanceStorageConfigs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listInstanceStorageConfigsAsync()
public
listInstanceStorageConfigsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIntegrationAssociations()
public
listIntegrationAssociations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIntegrationAssociationsAsync()
public
listIntegrationAssociationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listLambdaFunctions()
public
listLambdaFunctions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listLambdaFunctionsAsync()
public
listLambdaFunctionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listLexBots()
public
listLexBots(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listLexBotsAsync()
public
listLexBotsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPhoneNumbers()
public
listPhoneNumbers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPhoneNumbersAsync()
public
listPhoneNumbersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPrompts()
public
listPrompts(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPromptsAsync()
public
listPromptsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listQueues()
public
listQueues(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listQueuesAsync()
public
listQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRoutingProfileQueues()
public
listRoutingProfileQueues(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRoutingProfileQueuesAsync()
public
listRoutingProfileQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRoutingProfiles()
public
listRoutingProfiles(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRoutingProfilesAsync()
public
listRoutingProfilesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listSecurityKeys()
public
listSecurityKeys(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listSecurityKeysAsync()
public
listSecurityKeysAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listSecurityProfiles()
public
listSecurityProfiles(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listSecurityProfilesAsync()
public
listSecurityProfilesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUseCases()
public
listUseCases(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUseCasesAsync()
public
listUseCasesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserHierarchyGroups()
public
listUserHierarchyGroups(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserHierarchyGroupsAsync()
public
listUserHierarchyGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUsers()
public
listUsers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUsersAsync()
public
listUsersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resumeContactRecording()
public
resumeContactRecording(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resumeContactRecordingAsync()
public
resumeContactRecordingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startChatContact()
public
startChatContact(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startChatContactAsync()
public
startChatContactAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startContactRecording()
public
startContactRecording(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startContactRecordingAsync()
public
startContactRecordingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startOutboundVoiceContact()
public
startOutboundVoiceContact(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startOutboundVoiceContactAsync()
public
startOutboundVoiceContactAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startTaskContact()
public
startTaskContact(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startTaskContactAsync()
public
startTaskContactAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopContact()
public
stopContact(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopContactAsync()
public
stopContactAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopContactRecording()
public
stopContactRecording(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopContactRecordingAsync()
public
stopContactRecordingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—suspendContactRecording()
public
suspendContactRecording(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—suspendContactRecordingAsync()
public
suspendContactRecordingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResource()
public
tagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—tagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResource()
public
untagResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—untagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactAttributes()
public
updateContactAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactAttributesAsync()
public
updateContactAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactFlowContent()
public
updateContactFlowContent(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactFlowContentAsync()
public
updateContactFlowContentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactFlowName()
public
updateContactFlowName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateContactFlowNameAsync()
public
updateContactFlowNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateInstanceAttribute()
public
updateInstanceAttribute(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateInstanceAttributeAsync()
public
updateInstanceAttributeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateInstanceStorageConfig()
public
updateInstanceStorageConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateInstanceStorageConfigAsync()
public
updateInstanceStorageConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileConcurrency()
public
updateRoutingProfileConcurrency(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileConcurrencyAsync()
public
updateRoutingProfileConcurrencyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileDefaultOutboundQueue()
public
updateRoutingProfileDefaultOutboundQueue(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileDefaultOutboundQueueAsync()
public
updateRoutingProfileDefaultOutboundQueueAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileName()
public
updateRoutingProfileName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileNameAsync()
public
updateRoutingProfileNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileQueues()
public
updateRoutingProfileQueues(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateRoutingProfileQueuesAsync()
public
updateRoutingProfileQueuesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchy()
public
updateUserHierarchy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchyAsync()
public
updateUserHierarchyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchyGroupName()
public
updateUserHierarchyGroupName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchyGroupNameAsync()
public
updateUserHierarchyGroupNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchyStructure()
public
updateUserHierarchyStructure(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserHierarchyStructureAsync()
public
updateUserHierarchyStructureAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserIdentityInfo()
public
updateUserIdentityInfo(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserIdentityInfoAsync()
public
updateUserIdentityInfoAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPhoneConfig()
public
updateUserPhoneConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPhoneConfigAsync()
public
updateUserPhoneConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserRoutingProfile()
public
updateUserRoutingProfile(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserRoutingProfileAsync()
public
updateUserRoutingProfileAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserSecurityProfiles()
public
updateUserSecurityProfiles(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserSecurityProfilesAsync()
public
updateUserSecurityProfilesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>