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.
- AddCustomAttributes
- AdminAddUserToGroup
- AdminConfirmSignUp
- AdminCreateUser
- AdminDeleteUser
- AdminDeleteUserAttributes
- AdminDisableProviderForUser
- AdminDisableUser
- AdminEnableUser
- AdminForgetDevice
- AdminGetDevice
- AdminGetUser
- AdminInitiateAuth
- AdminLinkProviderForUser
- AdminListDevices
- AdminListGroupsForUser
- AdminListUserAuthEvents
- AdminRemoveUserFromGroup
- AdminResetUserPassword
- AdminRespondToAuthChallenge
- AdminSetUserMFAPreference
- AdminSetUserPassword
- AdminSetUserSettings
- AdminUpdateAuthEventFeedback
- AdminUpdateDeviceStatus
- AdminUpdateUserAttributes
- AdminUserGlobalSignOut
- AssociateSoftwareToken
- ChangePassword
- ConfirmDevice
- ConfirmForgotPassword
- ConfirmSignUp
- CreateGroup
- CreateIdentityProvider
- CreateResourceServer
- CreateUserImportJob
- CreateUserPool
- CreateUserPoolClient
- CreateUserPoolDomain
- DeleteGroup
- DeleteIdentityProvider
- DeleteResourceServer
- DeleteUser
- DeleteUserAttributes
- DeleteUserPool
- DeleteUserPoolClient
- DeleteUserPoolDomain
- DescribeIdentityProvider
- DescribeResourceServer
- DescribeRiskConfiguration
- DescribeUserImportJob
- DescribeUserPool
- DescribeUserPoolClient
- DescribeUserPoolDomain
- ForgetDevice
- ForgotPassword
- GetCSVHeader
- GetDevice
- GetGroup
- GetIdentityProviderByIdentifier
- GetLogDeliveryConfiguration
- GetSigningCertificate
- GetUICustomization
- GetUser
- GetUserAttributeVerificationCode
- GetUserPoolMfaConfig
- GlobalSignOut
- InitiateAuth
- ListDevices
- ListGroups
- ListIdentityProviders
- ListResourceServers
- ListTagsForResource
- ListUserImportJobs
- ListUserPoolClients
- ListUserPools
- ListUsers
- ListUsersInGroup
- ResendConfirmationCode
- RespondToAuthChallenge
- RevokeToken
- SetLogDeliveryConfiguration
- SetRiskConfiguration
- SetUICustomization
- SetUserMFAPreference
- SetUserPoolMfaConfig
- SetUserSettings
- SignUp
- StartUserImportJob
- StopUserImportJob
- TagResource
- UntagResource
- UpdateAuthEventFeedback
- UpdateDeviceStatus
- UpdateGroup
- UpdateIdentityProvider
- UpdateResourceServer
- UpdateUserAttributes
- UpdateUserPool
- UpdateUserPoolClient
- UpdateUserPoolDomain
- VerifySoftwareToken
- VerifyUserAttribute
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
__sleep()
public
__sleep() : mixed
addCustomAttributes()
public
addCustomAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddCustomAttributesAsync()
public
addCustomAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminAddUserToGroup()
public
adminAddUserToGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminAddUserToGroupAsync()
public
adminAddUserToGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminConfirmSignUp()
public
adminConfirmSignUp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminConfirmSignUpAsync()
public
adminConfirmSignUpAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminCreateUser()
public
adminCreateUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminCreateUserAsync()
public
adminCreateUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminDeleteUser()
public
adminDeleteUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminDeleteUserAsync()
public
adminDeleteUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminDeleteUserAttributes()
public
adminDeleteUserAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminDeleteUserAttributesAsync()
public
adminDeleteUserAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminDisableProviderForUser()
public
adminDisableProviderForUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminDisableProviderForUserAsync()
public
adminDisableProviderForUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminDisableUser()
public
adminDisableUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminDisableUserAsync()
public
adminDisableUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminEnableUser()
public
adminEnableUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminEnableUserAsync()
public
adminEnableUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminForgetDevice()
public
adminForgetDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminForgetDeviceAsync()
public
adminForgetDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminGetDevice()
public
adminGetDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminGetDeviceAsync()
public
adminGetDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminGetUser()
public
adminGetUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminGetUserAsync()
public
adminGetUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminInitiateAuth()
public
adminInitiateAuth(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminInitiateAuthAsync()
public
adminInitiateAuthAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminLinkProviderForUser()
public
adminLinkProviderForUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminLinkProviderForUserAsync()
public
adminLinkProviderForUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminListDevices()
public
adminListDevices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminListDevicesAsync()
public
adminListDevicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminListGroupsForUser()
public
adminListGroupsForUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminListGroupsForUserAsync()
public
adminListGroupsForUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminListUserAuthEvents()
public
adminListUserAuthEvents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminListUserAuthEventsAsync()
public
adminListUserAuthEventsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminRemoveUserFromGroup()
public
adminRemoveUserFromGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminRemoveUserFromGroupAsync()
public
adminRemoveUserFromGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminResetUserPassword()
public
adminResetUserPassword(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminResetUserPasswordAsync()
public
adminResetUserPasswordAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminRespondToAuthChallenge()
public
adminRespondToAuthChallenge(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminRespondToAuthChallengeAsync()
public
adminRespondToAuthChallengeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminSetUserMFAPreference()
public
adminSetUserMFAPreference(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminSetUserMFAPreferenceAsync()
public
adminSetUserMFAPreferenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminSetUserPassword()
public
adminSetUserPassword(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminSetUserPasswordAsync()
public
adminSetUserPasswordAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminSetUserSettings()
public
adminSetUserSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminSetUserSettingsAsync()
public
adminSetUserSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminUpdateAuthEventFeedback()
public
adminUpdateAuthEventFeedback(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminUpdateAuthEventFeedbackAsync()
public
adminUpdateAuthEventFeedbackAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminUpdateDeviceStatus()
public
adminUpdateDeviceStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminUpdateDeviceStatusAsync()
public
adminUpdateDeviceStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminUpdateUserAttributes()
public
adminUpdateUserAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminUpdateUserAttributesAsync()
public
adminUpdateUserAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseadminUserGlobalSignOut()
public
adminUserGlobalSignOut(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultadminUserGlobalSignOutAsync()
public
adminUserGlobalSignOutAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateSoftwareToken()
public
associateSoftwareToken(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateSoftwareTokenAsync()
public
associateSoftwareTokenAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisechangePassword()
public
changePassword(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultchangePasswordAsync()
public
changePasswordAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmDevice()
public
confirmDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmDeviceAsync()
public
confirmDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmForgotPassword()
public
confirmForgotPassword(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmForgotPasswordAsync()
public
confirmForgotPasswordAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseconfirmSignUp()
public
confirmSignUp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultconfirmSignUpAsync()
public
confirmSignUpAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateGroup()
public
createGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateGroupAsync()
public
createGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateIdentityProvider()
public
createIdentityProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateIdentityProviderAsync()
public
createIdentityProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateResourceServer()
public
createResourceServer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateResourceServerAsync()
public
createResourceServerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUserImportJob()
public
createUserImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUserImportJobAsync()
public
createUserImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUserPool()
public
createUserPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUserPoolAsync()
public
createUserPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUserPoolClient()
public
createUserPoolClient(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUserPoolClientAsync()
public
createUserPoolClientAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUserPoolDomain()
public
createUserPoolDomain(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUserPoolDomainAsync()
public
createUserPoolDomainAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteGroup()
public
deleteGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteGroupAsync()
public
deleteGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIdentityProvider()
public
deleteIdentityProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIdentityProviderAsync()
public
deleteIdentityProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteResourceServer()
public
deleteResourceServer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteResourceServerAsync()
public
deleteResourceServerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUser()
public
deleteUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserAsync()
public
deleteUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserAttributes()
public
deleteUserAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserAttributesAsync()
public
deleteUserAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserPool()
public
deleteUserPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserPoolAsync()
public
deleteUserPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserPoolClient()
public
deleteUserPoolClient(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserPoolClientAsync()
public
deleteUserPoolClientAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserPoolDomain()
public
deleteUserPoolDomain(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserPoolDomainAsync()
public
deleteUserPoolDomainAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeIdentityProvider()
public
describeIdentityProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeIdentityProviderAsync()
public
describeIdentityProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeResourceServer()
public
describeResourceServer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeResourceServerAsync()
public
describeResourceServerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeRiskConfiguration()
public
describeRiskConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeRiskConfigurationAsync()
public
describeRiskConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeUserImportJob()
public
describeUserImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeUserImportJobAsync()
public
describeUserImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeUserPool()
public
describeUserPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeUserPoolAsync()
public
describeUserPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeUserPoolClient()
public
describeUserPoolClient(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeUserPoolClientAsync()
public
describeUserPoolClientAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeUserPoolDomain()
public
describeUserPoolDomain(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeUserPoolDomainAsync()
public
describeUserPoolDomainAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticforgetDevice()
public
forgetDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultforgetDeviceAsync()
public
forgetDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseforgotPassword()
public
forgotPassword(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultforgotPasswordAsync()
public
forgotPasswordAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetCSVHeader()
public
getCSVHeader(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCSVHeaderAsync()
public
getCSVHeaderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDevice()
public
getDevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDeviceAsync()
public
getDeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
ResultgetGroupAsync()
public
getGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHandlerList()
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
HandlerListgetIdentityProviderByIdentifier()
public
getIdentityProviderByIdentifier(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIdentityProviderByIdentifierAsync()
public
getIdentityProviderByIdentifierAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
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
ResultgetLogDeliveryConfigurationAsync()
public
getLogDeliveryConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
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
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSigningCertificate()
public
getSigningCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSigningCertificateAsync()
public
getSigningCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUICustomization()
public
getUICustomization(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUICustomizationAsync()
public
getUICustomizationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUser()
public
getUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserAsync()
public
getUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUserAttributeVerificationCode()
public
getUserAttributeVerificationCode(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserAttributeVerificationCodeAsync()
public
getUserAttributeVerificationCodeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUserPoolMfaConfig()
public
getUserPoolMfaConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserPoolMfaConfigAsync()
public
getUserPoolMfaConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
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
ResultglobalSignOutAsync()
public
globalSignOutAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseinitiateAuth()
public
initiateAuth(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultinitiateAuthAsync()
public
initiateAuthAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDevices()
public
listDevices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDevicesAsync()
public
listDevicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGroups()
public
listGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGroupsAsync()
public
listGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIdentityProviders()
public
listIdentityProviders(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIdentityProvidersAsync()
public
listIdentityProvidersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistResourceServers()
public
listResourceServers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistResourceServersAsync()
public
listResourceServersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUserImportJobs()
public
listUserImportJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUserImportJobsAsync()
public
listUserImportJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUserPoolClients()
public
listUserPoolClients(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUserPoolClientsAsync()
public
listUserPoolClientsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUserPools()
public
listUserPools(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUserPoolsAsync()
public
listUserPoolsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUsers()
public
listUsers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUsersAsync()
public
listUsersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUsersInGroup()
public
listUsersInGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUsersInGroupAsync()
public
listUsersInGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseresendConfirmationCode()
public
resendConfirmationCode(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultresendConfirmationCodeAsync()
public
resendConfirmationCodeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserespondToAuthChallenge()
public
respondToAuthChallenge(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrespondToAuthChallengeAsync()
public
respondToAuthChallengeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserevokeToken()
public
revokeToken(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrevokeTokenAsync()
public
revokeTokenAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetLogDeliveryConfiguration()
public
setLogDeliveryConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetLogDeliveryConfigurationAsync()
public
setLogDeliveryConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetRiskConfiguration()
public
setRiskConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetRiskConfigurationAsync()
public
setRiskConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetUICustomization()
public
setUICustomization(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetUICustomizationAsync()
public
setUICustomizationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetUserMFAPreference()
public
setUserMFAPreference(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetUserMFAPreferenceAsync()
public
setUserMFAPreferenceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetUserPoolMfaConfig()
public
setUserPoolMfaConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetUserPoolMfaConfigAsync()
public
setUserPoolMfaConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetUserSettings()
public
setUserSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetUserSettingsAsync()
public
setUserSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesignUp()
public
signUp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsignUpAsync()
public
signUpAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartUserImportJob()
public
startUserImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartUserImportJobAsync()
public
startUserImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopUserImportJob()
public
stopUserImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopUserImportJobAsync()
public
stopUserImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAuthEventFeedback()
public
updateAuthEventFeedback(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAuthEventFeedbackAsync()
public
updateAuthEventFeedbackAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDeviceStatus()
public
updateDeviceStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDeviceStatusAsync()
public
updateDeviceStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateGroup()
public
updateGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateGroupAsync()
public
updateGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateIdentityProvider()
public
updateIdentityProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateIdentityProviderAsync()
public
updateIdentityProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateResourceServer()
public
updateResourceServer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateResourceServerAsync()
public
updateResourceServerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserAttributes()
public
updateUserAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserAttributesAsync()
public
updateUserAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserPool()
public
updateUserPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserPoolAsync()
public
updateUserPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserPoolClient()
public
updateUserPoolClient(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserPoolClientAsync()
public
updateUserPoolClientAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserPoolDomain()
public
updateUserPoolDomain(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserPoolDomainAsync()
public
updateUserPoolDomainAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifySoftwareToken()
public
verifySoftwareToken(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifySoftwareTokenAsync()
public
verifySoftwareTokenAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyUserAttribute()
public
verifyUserAttribute(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyUserAttributeAsync()
public
verifyUserAttributeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []