SDK for PHP 3.x

CognitoIdentityProviderClient extends AwsClient
in package

This client is used to interact with the Amazon Cognito Identity Provider service.

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

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

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

addCustomAttributes()

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

addCustomAttributesAsync()

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

adminAddUserToGroup()

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

adminAddUserToGroupAsync()

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

adminConfirmSignUp()

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

adminConfirmSignUpAsync()

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

adminCreateUser()

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

adminCreateUserAsync()

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

adminDeleteUser()

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

adminDeleteUserAsync()

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

adminDeleteUserAttributes()

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

adminDeleteUserAttributesAsync()

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

adminDisableProviderForUser()

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

adminDisableProviderForUserAsync()

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

adminDisableUser()

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

adminDisableUserAsync()

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

adminEnableUser()

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

adminEnableUserAsync()

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

adminForgetDevice()

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

adminForgetDeviceAsync()

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

adminGetDevice()

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

adminGetDeviceAsync()

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

adminGetUser()

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

adminGetUserAsync()

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

adminInitiateAuth()

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

adminInitiateAuthAsync()

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

adminLinkProviderForUser()

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

adminLinkProviderForUserAsync()

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

adminListDevices()

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

adminListDevicesAsync()

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

adminListGroupsForUser()

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

adminListGroupsForUserAsync()

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

adminListUserAuthEvents()

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

adminListUserAuthEventsAsync()

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

adminRemoveUserFromGroup()

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

adminRemoveUserFromGroupAsync()

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

adminResetUserPassword()

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

adminResetUserPasswordAsync()

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

adminRespondToAuthChallenge()

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

adminRespondToAuthChallengeAsync()

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

adminSetUserMFAPreference()

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

adminSetUserMFAPreferenceAsync()

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

adminSetUserPassword()

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

adminSetUserPasswordAsync()

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

adminSetUserSettings()

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

adminSetUserSettingsAsync()

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

adminUpdateAuthEventFeedback()

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

adminUpdateAuthEventFeedbackAsync()

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

adminUpdateDeviceStatus()

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

adminUpdateDeviceStatusAsync()

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

adminUpdateUserAttributes()

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

adminUpdateUserAttributesAsync()

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

adminUserGlobalSignOut()

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

adminUserGlobalSignOutAsync()

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

associateSoftwareToken()

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

associateSoftwareTokenAsync()

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

changePassword()

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

changePasswordAsync()

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

confirmDevice()

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

confirmDeviceAsync()

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

confirmForgotPassword()

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

confirmForgotPasswordAsync()

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

confirmSignUp()

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

confirmSignUpAsync()

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

createGroup()

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

createGroupAsync()

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

createIdentityProvider()

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

createIdentityProviderAsync()

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

createResourceServer()

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

createResourceServerAsync()

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

createUserImportJob()

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

createUserImportJobAsync()

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

createUserPool()

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

createUserPoolAsync()

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

createUserPoolClient()

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

createUserPoolClientAsync()

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

createUserPoolDomain()

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

createUserPoolDomainAsync()

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

deleteGroup()

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

deleteGroupAsync()

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

deleteIdentityProvider()

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

deleteIdentityProviderAsync()

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

deleteResourceServer()

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

deleteResourceServerAsync()

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

deleteUser()

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

deleteUserAsync()

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

deleteUserAttributes()

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

deleteUserAttributesAsync()

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

deleteUserPool()

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

deleteUserPoolAsync()

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

deleteUserPoolClient()

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

deleteUserPoolClientAsync()

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

deleteUserPoolDomain()

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

deleteUserPoolDomainAsync()

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

describeIdentityProvider()

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

describeIdentityProviderAsync()

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

describeResourceServer()

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

describeResourceServerAsync()

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

describeRiskConfiguration()

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

describeRiskConfigurationAsync()

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

describeUserImportJob()

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

describeUserImportJobAsync()

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

describeUserPool()

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

describeUserPoolAsync()

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

describeUserPoolClient()

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

describeUserPoolClientAsync()

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

describeUserPoolDomain()

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

describeUserPoolDomainAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

forgetDevice()

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

forgetDeviceAsync()

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

forgotPassword()

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

forgotPasswordAsync()

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

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

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

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getCSVHeader()

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

getCSVHeaderAsync()

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

getDevice()

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

getDeviceAsync()

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

getEndpoint()

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

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGroup()

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

getGroupAsync()

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList

getIdentityProviderByIdentifier()

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

getIdentityProviderByIdentifierAsync()

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

getIterator()

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

getLogDeliveryConfiguration()

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

getLogDeliveryConfigurationAsync()

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

getPaginator()

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

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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getSigningCertificateAsync()

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

getUICustomization()

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

getUICustomizationAsync()

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

getUser()

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

getUserAsync()

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

getUserAttributeVerificationCode()

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

getUserAttributeVerificationCodeAsync()

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

getUserPoolMfaConfig()

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

getUserPoolMfaConfigAsync()

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

getWaiter()

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

globalSignOut()

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

globalSignOutAsync()

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

initiateAuth()

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

initiateAuthAsync()

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

listDevices()

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

listDevicesAsync()

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

listGroups()

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

listGroupsAsync()

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

listIdentityProviders()

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

listIdentityProvidersAsync()

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

listResourceServers()

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

listResourceServersAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listUserImportJobs()

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

listUserImportJobsAsync()

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

listUserPoolClients()

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

listUserPoolClientsAsync()

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

listUserPools()

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

listUserPoolsAsync()

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

listUsers()

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

listUsersAsync()

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

listUsersInGroup()

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

listUsersInGroupAsync()

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

resendConfirmationCode()

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

resendConfirmationCodeAsync()

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

respondToAuthChallenge()

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

respondToAuthChallengeAsync()

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

revokeToken()

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

revokeTokenAsync()

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

setLogDeliveryConfiguration()

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

setLogDeliveryConfigurationAsync()

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

setRiskConfiguration()

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

setRiskConfigurationAsync()

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

setUICustomization()

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

setUICustomizationAsync()

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

setUserMFAPreference()

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

setUserMFAPreferenceAsync()

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

setUserPoolMfaConfig()

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

setUserPoolMfaConfigAsync()

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

setUserSettings()

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

setUserSettingsAsync()

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

signUp()

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

signUpAsync()

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

startUserImportJob()

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

startUserImportJobAsync()

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

stopUserImportJob()

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

stopUserImportJobAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAuthEventFeedback()

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

updateAuthEventFeedbackAsync()

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

updateDeviceStatus()

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

updateDeviceStatusAsync()

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

updateGroup()

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

updateGroupAsync()

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

updateIdentityProvider()

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

updateIdentityProviderAsync()

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

updateResourceServer()

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

updateResourceServerAsync()

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

updateUserAttributes()

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

updateUserAttributesAsync()

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

updateUserPool()

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

updateUserPoolAsync()

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

updateUserPoolClient()

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

updateUserPoolClientAsync()

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

updateUserPoolDomain()

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

updateUserPoolDomainAsync()

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

verifySoftwareToken()

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

verifySoftwareTokenAsync()

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

verifyUserAttribute()

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

verifyUserAttributeAsync()

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

waitUntil()

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