CognitoIdentityProviderClient
extends AwsClient
in package
This client is used to interact with the **Amazon Cognito Identity Provider** 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
- addCustomAttributes() :
- addCustomAttributesAsync() :
- adminAddUserToGroup() :
- adminAddUserToGroupAsync() :
- adminConfirmSignUp() :
- adminConfirmSignUpAsync() :
- adminCreateUser() :
- adminCreateUserAsync() :
- adminDeleteUser() :
- adminDeleteUserAsync() :
- adminDeleteUserAttributes() :
- adminDeleteUserAttributesAsync() :
- adminDisableProviderForUser() :
- adminDisableProviderForUserAsync() :
- adminDisableUser() :
- adminDisableUserAsync() :
- adminEnableUser() :
- adminEnableUserAsync() :
- adminForgetDevice() :
- adminForgetDeviceAsync() :
- adminGetDevice() :
- adminGetDeviceAsync() :
- adminGetUser() :
- adminGetUserAsync() :
- adminInitiateAuth() :
- adminInitiateAuthAsync() :
- adminLinkProviderForUser() :
- adminLinkProviderForUserAsync() :
- adminListDevices() :
- adminListDevicesAsync() :
- adminListGroupsForUser() :
- adminListGroupsForUserAsync() :
- adminListUserAuthEvents() :
- adminListUserAuthEventsAsync() :
- adminRemoveUserFromGroup() :
- adminRemoveUserFromGroupAsync() :
- adminResetUserPassword() :
- adminResetUserPasswordAsync() :
- adminRespondToAuthChallenge() :
- adminRespondToAuthChallengeAsync() :
- adminSetUserMFAPreference() :
- adminSetUserMFAPreferenceAsync() :
- adminSetUserPassword() :
- adminSetUserPasswordAsync() :
- adminSetUserSettings() :
- adminSetUserSettingsAsync() :
- adminUpdateAuthEventFeedback() :
- adminUpdateAuthEventFeedbackAsync() :
- adminUpdateDeviceStatus() :
- adminUpdateDeviceStatusAsync() :
- adminUpdateUserAttributes() :
- adminUpdateUserAttributesAsync() :
- adminUserGlobalSignOut() :
- adminUserGlobalSignOutAsync() :
- associateSoftwareToken() :
- associateSoftwareTokenAsync() :
- changePassword() :
- changePasswordAsync() :
- confirmDevice() :
- confirmDeviceAsync() :
- confirmForgotPassword() :
- confirmForgotPasswordAsync() :
- confirmSignUp() :
- confirmSignUpAsync() :
- createGroup() :
- createGroupAsync() :
- createIdentityProvider() :
- createIdentityProviderAsync() :
- createResourceServer() :
- createResourceServerAsync() :
- createUserImportJob() :
- createUserImportJobAsync() :
- createUserPool() :
- createUserPoolAsync() :
- createUserPoolClient() :
- createUserPoolClientAsync() :
- createUserPoolDomain() :
- createUserPoolDomainAsync() :
- deleteGroup() :
- deleteGroupAsync() :
- deleteIdentityProvider() :
- deleteIdentityProviderAsync() :
- deleteResourceServer() :
- deleteResourceServerAsync() :
- deleteUser() :
- deleteUserAsync() :
- deleteUserAttributes() :
- deleteUserAttributesAsync() :
- deleteUserPool() :
- deleteUserPoolAsync() :
- deleteUserPoolClient() :
- deleteUserPoolClientAsync() :
- deleteUserPoolDomain() :
- deleteUserPoolDomainAsync() :
- describeIdentityProvider() :
- describeIdentityProviderAsync() :
- describeResourceServer() :
- describeResourceServerAsync() :
- describeRiskConfiguration() :
- describeRiskConfigurationAsync() :
- describeUserImportJob() :
- describeUserImportJobAsync() :
- describeUserPool() :
- describeUserPoolAsync() :
- describeUserPoolClient() :
- describeUserPoolClientAsync() :
- describeUserPoolDomain() :
- describeUserPoolDomainAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- forgetDevice() :
- forgetDeviceAsync() :
- forgotPassword() :
- forgotPasswordAsync() :
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getCSVHeader() :
- getCSVHeaderAsync() :
- getDevice() :
- getDeviceAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getGroup() :
- getGroupAsync() :
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIdentityProviderByIdentifier() :
- getIdentityProviderByIdentifierAsync() :
- getIterator() : mixed
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getSigningCertificate() :
- getSigningCertificateAsync() :
- getUICustomization() :
- getUICustomizationAsync() :
- getUser() :
- getUserAsync() :
- getUserAttributeVerificationCode() :
- getUserAttributeVerificationCodeAsync() :
- getUserPoolMfaConfig() :
- getUserPoolMfaConfigAsync() :
- getWaiter() : mixed
- globalSignOut() :
- globalSignOutAsync() :
- initiateAuth() :
- initiateAuthAsync() :
- listDevices() :
- listDevicesAsync() :
- listGroups() :
- listGroupsAsync() :
- listIdentityProviders() :
- listIdentityProvidersAsync() :
- listResourceServers() :
- listResourceServersAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- listUserImportJobs() :
- listUserImportJobsAsync() :
- listUserPoolClients() :
- listUserPoolClientsAsync() :
- listUserPools() :
- listUserPoolsAsync() :
- listUsers() :
- listUsersAsync() :
- listUsersInGroup() :
- listUsersInGroupAsync() :
- resendConfirmationCode() :
- resendConfirmationCodeAsync() :
- respondToAuthChallenge() :
- respondToAuthChallengeAsync() :
- setRiskConfiguration() :
- setRiskConfigurationAsync() :
- setUICustomization() :
- setUICustomizationAsync() :
- setUserMFAPreference() :
- setUserMFAPreferenceAsync() :
- setUserPoolMfaConfig() :
- setUserPoolMfaConfigAsync() :
- setUserSettings() :
- setUserSettingsAsync() :
- signUp() :
- signUpAsync() :
- startUserImportJob() :
- startUserImportJobAsync() :
- stopUserImportJob() :
- stopUserImportJobAsync() :
- tagResource() :
- tagResourceAsync() :
- untagResource() :
- untagResourceAsync() :
- updateAuthEventFeedback() :
- updateAuthEventFeedbackAsync() :
- updateDeviceStatus() :
- updateDeviceStatusAsync() :
- updateGroup() :
- updateGroupAsync() :
- updateIdentityProvider() :
- updateIdentityProviderAsync() :
- updateResourceServer() :
- updateResourceServerAsync() :
- updateUserAttributes() :
- updateUserAttributesAsync() :
- updateUserPool() :
- updateUserPoolAsync() :
- updateUserPoolClient() :
- updateUserPoolClientAsync() :
- updateUserPoolDomain() :
- updateUserPoolDomainAsync() :
- verifySoftwareToken() :
- verifySoftwareTokenAsync() :
- verifyUserAttribute() :
- verifyUserAttributeAsync() :
- 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 —addCustomAttributes()
public
addCustomAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—addCustomAttributesAsync()
public
addCustomAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminAddUserToGroup()
public
adminAddUserToGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminAddUserToGroupAsync()
public
adminAddUserToGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminConfirmSignUp()
public
adminConfirmSignUp(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminConfirmSignUpAsync()
public
adminConfirmSignUpAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminCreateUser()
public
adminCreateUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminCreateUserAsync()
public
adminCreateUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDeleteUser()
public
adminDeleteUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDeleteUserAsync()
public
adminDeleteUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDeleteUserAttributes()
public
adminDeleteUserAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDeleteUserAttributesAsync()
public
adminDeleteUserAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDisableProviderForUser()
public
adminDisableProviderForUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDisableProviderForUserAsync()
public
adminDisableProviderForUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDisableUser()
public
adminDisableUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminDisableUserAsync()
public
adminDisableUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminEnableUser()
public
adminEnableUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminEnableUserAsync()
public
adminEnableUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminForgetDevice()
public
adminForgetDevice(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminForgetDeviceAsync()
public
adminForgetDeviceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminGetDevice()
public
adminGetDevice(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminGetDeviceAsync()
public
adminGetDeviceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminGetUser()
public
adminGetUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminGetUserAsync()
public
adminGetUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminInitiateAuth()
public
adminInitiateAuth(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminInitiateAuthAsync()
public
adminInitiateAuthAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminLinkProviderForUser()
public
adminLinkProviderForUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminLinkProviderForUserAsync()
public
adminLinkProviderForUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListDevices()
public
adminListDevices(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListDevicesAsync()
public
adminListDevicesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListGroupsForUser()
public
adminListGroupsForUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListGroupsForUserAsync()
public
adminListGroupsForUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListUserAuthEvents()
public
adminListUserAuthEvents(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminListUserAuthEventsAsync()
public
adminListUserAuthEventsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminRemoveUserFromGroup()
public
adminRemoveUserFromGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminRemoveUserFromGroupAsync()
public
adminRemoveUserFromGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminResetUserPassword()
public
adminResetUserPassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminResetUserPasswordAsync()
public
adminResetUserPasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminRespondToAuthChallenge()
public
adminRespondToAuthChallenge(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminRespondToAuthChallengeAsync()
public
adminRespondToAuthChallengeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserMFAPreference()
public
adminSetUserMFAPreference(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserMFAPreferenceAsync()
public
adminSetUserMFAPreferenceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserPassword()
public
adminSetUserPassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserPasswordAsync()
public
adminSetUserPasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserSettings()
public
adminSetUserSettings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminSetUserSettingsAsync()
public
adminSetUserSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateAuthEventFeedback()
public
adminUpdateAuthEventFeedback(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateAuthEventFeedbackAsync()
public
adminUpdateAuthEventFeedbackAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateDeviceStatus()
public
adminUpdateDeviceStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateDeviceStatusAsync()
public
adminUpdateDeviceStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateUserAttributes()
public
adminUpdateUserAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUpdateUserAttributesAsync()
public
adminUpdateUserAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUserGlobalSignOut()
public
adminUserGlobalSignOut(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—adminUserGlobalSignOutAsync()
public
adminUserGlobalSignOutAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateSoftwareToken()
public
associateSoftwareToken(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateSoftwareTokenAsync()
public
associateSoftwareTokenAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changePassword()
public
changePassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changePasswordAsync()
public
changePasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmDevice()
public
confirmDevice(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmDeviceAsync()
public
confirmDeviceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmForgotPassword()
public
confirmForgotPassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmForgotPasswordAsync()
public
confirmForgotPasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmSignUp()
public
confirmSignUp(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—confirmSignUpAsync()
public
confirmSignUpAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createGroup()
public
createGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createGroupAsync()
public
createGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIdentityProvider()
public
createIdentityProvider(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createIdentityProviderAsync()
public
createIdentityProviderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createResourceServer()
public
createResourceServer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createResourceServerAsync()
public
createResourceServerAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserImportJob()
public
createUserImportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserImportJobAsync()
public
createUserImportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPool()
public
createUserPool(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPoolAsync()
public
createUserPoolAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPoolClient()
public
createUserPoolClient(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPoolClientAsync()
public
createUserPoolClientAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPoolDomain()
public
createUserPoolDomain(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createUserPoolDomainAsync()
public
createUserPoolDomainAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteGroup()
public
deleteGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteGroupAsync()
public
deleteGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIdentityProvider()
public
deleteIdentityProvider(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteIdentityProviderAsync()
public
deleteIdentityProviderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteResourceServer()
public
deleteResourceServer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteResourceServerAsync()
public
deleteResourceServerAsync(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
—deleteUserAttributes()
public
deleteUserAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserAttributesAsync()
public
deleteUserAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPool()
public
deleteUserPool(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPoolAsync()
public
deleteUserPoolAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPoolClient()
public
deleteUserPoolClient(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPoolClientAsync()
public
deleteUserPoolClientAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPoolDomain()
public
deleteUserPoolDomain(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteUserPoolDomainAsync()
public
deleteUserPoolDomainAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeIdentityProvider()
public
describeIdentityProvider(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeIdentityProviderAsync()
public
describeIdentityProviderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeResourceServer()
public
describeResourceServer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeResourceServerAsync()
public
describeResourceServerAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeRiskConfiguration()
public
describeRiskConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeRiskConfigurationAsync()
public
describeRiskConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserImportJob()
public
describeUserImportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserImportJobAsync()
public
describeUserImportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPool()
public
describeUserPool(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPoolAsync()
public
describeUserPoolAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPoolClient()
public
describeUserPoolClient(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPoolClientAsync()
public
describeUserPoolClientAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPoolDomain()
public
describeUserPoolDomain(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeUserPoolDomainAsync()
public
describeUserPoolDomainAsync(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 —forgetDevice()
public
forgetDevice(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—forgetDeviceAsync()
public
forgetDeviceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—forgotPassword()
public
forgotPassword(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—forgotPasswordAsync()
public
forgotPasswordAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 —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 —getCSVHeader()
public
getCSVHeader(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCSVHeaderAsync()
public
getCSVHeaderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDevice()
public
getDevice(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDeviceAsync()
public
getDeviceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getGroup()
public
getGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getGroupAsync()
public
getGroupAsync(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 —getIdentityProviderByIdentifier()
public
getIdentityProviderByIdentifier(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIdentityProviderByIdentifierAsync()
public
getIdentityProviderByIdentifierAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —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 —getSigningCertificate()
public
getSigningCertificate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSigningCertificateAsync()
public
getSigningCertificateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUICustomization()
public
getUICustomization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUICustomizationAsync()
public
getUICustomizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUser()
public
getUser(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUserAsync()
public
getUserAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUserAttributeVerificationCode()
public
getUserAttributeVerificationCode(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUserAttributeVerificationCodeAsync()
public
getUserAttributeVerificationCodeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUserPoolMfaConfig()
public
getUserPoolMfaConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getUserPoolMfaConfigAsync()
public
getUserPoolMfaConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —globalSignOut()
public
globalSignOut(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—globalSignOutAsync()
public
globalSignOutAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—initiateAuth()
public
initiateAuth(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—initiateAuthAsync()
public
initiateAuthAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listDevices()
public
listDevices(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listDevicesAsync()
public
listDevicesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroups()
public
listGroups(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGroupsAsync()
public
listGroupsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIdentityProviders()
public
listIdentityProviders(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listIdentityProvidersAsync()
public
listIdentityProvidersAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceServers()
public
listResourceServers(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceServersAsync()
public
listResourceServersAsync(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
—listUserImportJobs()
public
listUserImportJobs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserImportJobsAsync()
public
listUserImportJobsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserPoolClients()
public
listUserPoolClients(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserPoolClientsAsync()
public
listUserPoolClientsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserPools()
public
listUserPools(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUserPoolsAsync()
public
listUserPoolsAsync(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
—listUsersInGroup()
public
listUsersInGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listUsersInGroupAsync()
public
listUsersInGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resendConfirmationCode()
public
resendConfirmationCode(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—resendConfirmationCodeAsync()
public
resendConfirmationCodeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—respondToAuthChallenge()
public
respondToAuthChallenge(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—respondToAuthChallengeAsync()
public
respondToAuthChallengeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setRiskConfiguration()
public
setRiskConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setRiskConfigurationAsync()
public
setRiskConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUICustomization()
public
setUICustomization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUICustomizationAsync()
public
setUICustomizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserMFAPreference()
public
setUserMFAPreference(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserMFAPreferenceAsync()
public
setUserMFAPreferenceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserPoolMfaConfig()
public
setUserPoolMfaConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserPoolMfaConfigAsync()
public
setUserPoolMfaConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserSettings()
public
setUserSettings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—setUserSettingsAsync()
public
setUserSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—signUp()
public
signUp(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—signUpAsync()
public
signUpAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startUserImportJob()
public
startUserImportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—startUserImportJobAsync()
public
startUserImportJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopUserImportJob()
public
stopUserImportJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—stopUserImportJobAsync()
public
stopUserImportJobAsync(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
—updateAuthEventFeedback()
public
updateAuthEventFeedback(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateAuthEventFeedbackAsync()
public
updateAuthEventFeedbackAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDeviceStatus()
public
updateDeviceStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateDeviceStatusAsync()
public
updateDeviceStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateGroup()
public
updateGroup(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateGroupAsync()
public
updateGroupAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateIdentityProvider()
public
updateIdentityProvider(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateIdentityProviderAsync()
public
updateIdentityProviderAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateResourceServer()
public
updateResourceServer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateResourceServerAsync()
public
updateResourceServerAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserAttributes()
public
updateUserAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserAttributesAsync()
public
updateUserAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPool()
public
updateUserPool(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPoolAsync()
public
updateUserPoolAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPoolClient()
public
updateUserPoolClient(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPoolClientAsync()
public
updateUserPoolClientAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPoolDomain()
public
updateUserPoolDomain(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateUserPoolDomainAsync()
public
updateUserPoolDomainAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifySoftwareToken()
public
verifySoftwareToken(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifySoftwareTokenAsync()
public
verifySoftwareTokenAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyUserAttribute()
public
verifyUserAttribute(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—verifyUserAttributeAsync()
public
verifyUserAttributeAsync(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>