Documentation

IamClient extends AwsClient
in package

This client is used to interact with the **AWS Identity and Access Management (AWS IAM)** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
addClientIDToOpenIDConnectProvider()  :
addClientIDToOpenIDConnectProviderAsync()  :
addRoleToInstanceProfile()  :
addRoleToInstanceProfileAsync()  :
addUserToGroup()  :
addUserToGroupAsync()  :
attachGroupPolicy()  :
attachGroupPolicyAsync()  :
attachRolePolicy()  :
attachRolePolicyAsync()  :
attachUserPolicy()  :
attachUserPolicyAsync()  :
changePassword()  :
changePasswordAsync()  :
createAccessKey()  :
createAccessKeyAsync()  :
createAccountAlias()  :
createAccountAliasAsync()  :
createGroup()  :
createGroupAsync()  :
createInstanceProfile()  :
createInstanceProfileAsync()  :
createLoginProfile()  :
createLoginProfileAsync()  :
createOpenIDConnectProvider()  :
createOpenIDConnectProviderAsync()  :
createPolicy()  :
createPolicyAsync()  :
createPolicyVersion()  :
createPolicyVersionAsync()  :
createRole()  :
createRoleAsync()  :
createSAMLProvider()  :
createSAMLProviderAsync()  :
createServiceLinkedRole()  :
createServiceLinkedRoleAsync()  :
createServiceSpecificCredential()  :
createServiceSpecificCredentialAsync()  :
createUser()  :
createUserAsync()  :
createVirtualMFADevice()  :
createVirtualMFADeviceAsync()  :
deactivateMFADevice()  :
deactivateMFADeviceAsync()  :
deleteAccessKey()  :
deleteAccessKeyAsync()  :
deleteAccountAlias()  :
deleteAccountAliasAsync()  :
deleteAccountPasswordPolicy()  :
deleteAccountPasswordPolicyAsync()  :
deleteGroup()  :
deleteGroupAsync()  :
deleteGroupPolicy()  :
deleteGroupPolicyAsync()  :
deleteInstanceProfile()  :
deleteInstanceProfileAsync()  :
deleteLoginProfile()  :
deleteLoginProfileAsync()  :
deleteOpenIDConnectProvider()  :
deleteOpenIDConnectProviderAsync()  :
deletePolicy()  :
deletePolicyAsync()  :
deletePolicyVersion()  :
deletePolicyVersionAsync()  :
deleteRole()  :
deleteRoleAsync()  :
deleteRolePermissionsBoundary()  :
deleteRolePermissionsBoundaryAsync()  :
deleteRolePolicy()  :
deleteRolePolicyAsync()  :
deleteSAMLProvider()  :
deleteSAMLProviderAsync()  :
deleteServerCertificate()  :
deleteServerCertificateAsync()  :
deleteServiceLinkedRole()  :
deleteServiceLinkedRoleAsync()  :
deleteServiceSpecificCredential()  :
deleteServiceSpecificCredentialAsync()  :
deleteSigningCertificate()  :
deleteSigningCertificateAsync()  :
deleteSSHPublicKey()  :
deleteSSHPublicKeyAsync()  :
deleteUser()  :
deleteUserAsync()  :
deleteUserPermissionsBoundary()  :
deleteUserPermissionsBoundaryAsync()  :
deleteUserPolicy()  :
deleteUserPolicyAsync()  :
deleteVirtualMFADevice()  :
deleteVirtualMFADeviceAsync()  :
detachGroupPolicy()  :
detachGroupPolicyAsync()  :
detachRolePolicy()  :
detachRolePolicyAsync()  :
detachUserPolicy()  :
detachUserPolicyAsync()  :
enableMFADevice()  :
enableMFADeviceAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
generateCredentialReport()  :
generateCredentialReportAsync()  :
generateOrganizationsAccessReport()  :
generateOrganizationsAccessReportAsync()  :
generateServiceLastAccessedDetails()  :
generateServiceLastAccessedDetailsAsync()  :
getAccessKeyLastUsed()  :
getAccessKeyLastUsedAsync()  :
getAccountAuthorizationDetails()  :
getAccountAuthorizationDetailsAsync()  :
getAccountPasswordPolicy()  :
getAccountPasswordPolicyAsync()  :
getAccountSummary()  :
getAccountSummaryAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getContextKeysForCustomPolicy()  :
getContextKeysForCustomPolicyAsync()  :
getContextKeysForPrincipalPolicy()  :
getContextKeysForPrincipalPolicyAsync()  :
getCredentialReport()  :
getCredentialReportAsync()  :
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getGroup()  :
getGroupAsync()  :
getGroupPolicy()  :
getGroupPolicyAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInstanceProfile()  :
getInstanceProfileAsync()  :
getIterator()  : mixed
getLoginProfile()  :
getLoginProfileAsync()  :
getOpenIDConnectProvider()  :
getOpenIDConnectProviderAsync()  :
getOrganizationsAccessReport()  :
getOrganizationsAccessReportAsync()  :
getPaginator()  : mixed
getPolicy()  :
getPolicyAsync()  :
getPolicyVersion()  :
getPolicyVersionAsync()  :
getRegion()  : string
Get the region to which the client is configured to send requests.
getRole()  :
getRoleAsync()  :
getRolePolicy()  :
getRolePolicyAsync()  :
getSAMLProvider()  :
getSAMLProviderAsync()  :
getServerCertificate()  :
getServerCertificateAsync()  :
getServiceLastAccessedDetails()  :
getServiceLastAccessedDetailsAsync()  :
getServiceLastAccessedDetailsWithEntities()  :
getServiceLastAccessedDetailsWithEntitiesAsync()  :
getServiceLinkedRoleDeletionStatus()  :
getServiceLinkedRoleDeletionStatusAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSSHPublicKey()  :
getSSHPublicKeyAsync()  :
getUser()  :
getUserAsync()  :
getUserPolicy()  :
getUserPolicyAsync()  :
getWaiter()  : mixed
listAccessKeys()  :
listAccessKeysAsync()  :
listAccountAliases()  :
listAccountAliasesAsync()  :
listAttachedGroupPolicies()  :
listAttachedGroupPoliciesAsync()  :
listAttachedRolePolicies()  :
listAttachedRolePoliciesAsync()  :
listAttachedUserPolicies()  :
listAttachedUserPoliciesAsync()  :
listEntitiesForPolicy()  :
listEntitiesForPolicyAsync()  :
listGroupPolicies()  :
listGroupPoliciesAsync()  :
listGroups()  :
listGroupsAsync()  :
listGroupsForUser()  :
listGroupsForUserAsync()  :
listInstanceProfiles()  :
listInstanceProfilesAsync()  :
listInstanceProfilesForRole()  :
listInstanceProfilesForRoleAsync()  :
listMFADevices()  :
listMFADevicesAsync()  :
listOpenIDConnectProviders()  :
listOpenIDConnectProvidersAsync()  :
listPolicies()  :
listPoliciesAsync()  :
listPoliciesGrantingServiceAccess()  :
listPoliciesGrantingServiceAccessAsync()  :
listPolicyVersions()  :
listPolicyVersionsAsync()  :
listRolePolicies()  :
listRolePoliciesAsync()  :
listRoles()  :
listRolesAsync()  :
listRoleTags()  :
listRoleTagsAsync()  :
listSAMLProviders()  :
listSAMLProvidersAsync()  :
listServerCertificates()  :
listServerCertificatesAsync()  :
listServiceSpecificCredentials()  :
listServiceSpecificCredentialsAsync()  :
listSigningCertificates()  :
listSigningCertificatesAsync()  :
listSSHPublicKeys()  :
listSSHPublicKeysAsync()  :
listUserPolicies()  :
listUserPoliciesAsync()  :
listUsers()  :
listUsersAsync()  :
listUserTags()  :
listUserTagsAsync()  :
listVirtualMFADevices()  :
listVirtualMFADevicesAsync()  :
putGroupPolicy()  :
putGroupPolicyAsync()  :
putRolePermissionsBoundary()  :
putRolePermissionsBoundaryAsync()  :
putRolePolicy()  :
putRolePolicyAsync()  :
putUserPermissionsBoundary()  :
putUserPermissionsBoundaryAsync()  :
putUserPolicy()  :
putUserPolicyAsync()  :
removeClientIDFromOpenIDConnectProvider()  :
removeClientIDFromOpenIDConnectProviderAsync()  :
removeRoleFromInstanceProfile()  :
removeRoleFromInstanceProfileAsync()  :
removeUserFromGroup()  :
removeUserFromGroupAsync()  :
resetServiceSpecificCredential()  :
resetServiceSpecificCredentialAsync()  :
resyncMFADevice()  :
resyncMFADeviceAsync()  :
setDefaultPolicyVersion()  :
setDefaultPolicyVersionAsync()  :
setSecurityTokenServicePreferences()  :
setSecurityTokenServicePreferencesAsync()  :
simulateCustomPolicy()  :
simulateCustomPolicyAsync()  :
simulatePrincipalPolicy()  :
simulatePrincipalPolicyAsync()  :
tagRole()  :
tagRoleAsync()  :
tagUser()  :
tagUserAsync()  :
untagRole()  :
untagRoleAsync()  :
untagUser()  :
untagUserAsync()  :
updateAccessKey()  :
updateAccessKeyAsync()  :
updateAccountPasswordPolicy()  :
updateAccountPasswordPolicyAsync()  :
updateAssumeRolePolicy()  :
updateAssumeRolePolicyAsync()  :
updateGroup()  :
updateGroupAsync()  :
updateLoginProfile()  :
updateLoginProfileAsync()  :
updateOpenIDConnectProviderThumbprint()  :
updateOpenIDConnectProviderThumbprintAsync()  :
updateRole()  :
updateRoleAsync()  :
updateRoleDescription()  :
updateRoleDescriptionAsync()  :
updateSAMLProvider()  :
updateSAMLProviderAsync()  :
updateServerCertificate()  :
updateServerCertificateAsync()  :
updateServiceSpecificCredential()  :
updateServiceSpecificCredentialAsync()  :
updateSigningCertificate()  :
updateSigningCertificateAsync()  :
updateSSHPublicKey()  :
updateSSHPublicKeyAsync()  :
updateUser()  :
updateUserAsync()  :
uploadServerCertificate()  :
uploadServerCertificateAsync()  :
uploadSigningCertificate()  :
uploadSigningCertificateAsync()  :
uploadSSHPublicKey()  :
uploadSSHPublicKeyAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

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

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, 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.
  • 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).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

Return values
mixed

__sleep()

public __sleep() : mixed
Return values
mixed

addClientIDToOpenIDConnectProvider()

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

addClientIDToOpenIDConnectProviderAsync()

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

addRoleToInstanceProfile()

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

addRoleToInstanceProfileAsync()

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

addUserToGroup()

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

addUserToGroupAsync()

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

attachGroupPolicy()

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

attachGroupPolicyAsync()

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

attachRolePolicy()

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

attachRolePolicyAsync()

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

attachUserPolicy()

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

attachUserPolicyAsync()

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

changePassword()

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

changePasswordAsync()

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

createAccessKey()

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

createAccessKeyAsync()

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

createAccountAlias()

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

createAccountAliasAsync()

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

createGroup()

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

createGroupAsync()

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

createInstanceProfile()

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

createInstanceProfileAsync()

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

createLoginProfile()

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

createLoginProfileAsync()

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

createOpenIDConnectProvider()

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

createOpenIDConnectProviderAsync()

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

createPolicy()

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

createPolicyAsync()

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

createPolicyVersion()

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

createPolicyVersionAsync()

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

createRole()

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

createRoleAsync()

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

createSAMLProvider()

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

createSAMLProviderAsync()

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

createServiceLinkedRole()

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

createServiceLinkedRoleAsync()

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

createServiceSpecificCredential()

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

createServiceSpecificCredentialAsync()

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

createUser()

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

createUserAsync()

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

createVirtualMFADevice()

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

createVirtualMFADeviceAsync()

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

deactivateMFADevice()

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

deactivateMFADeviceAsync()

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

deleteAccessKey()

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

deleteAccessKeyAsync()

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

deleteAccountAlias()

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

deleteAccountAliasAsync()

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

deleteAccountPasswordPolicy()

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

deleteAccountPasswordPolicyAsync()

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

deleteGroup()

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

deleteGroupAsync()

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

deleteGroupPolicy()

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

deleteGroupPolicyAsync()

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

deleteInstanceProfile()

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

deleteInstanceProfileAsync()

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

deleteLoginProfile()

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

deleteLoginProfileAsync()

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

deleteOpenIDConnectProvider()

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

deleteOpenIDConnectProviderAsync()

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

deletePolicy()

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

deletePolicyAsync()

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

deletePolicyVersion()

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

deletePolicyVersionAsync()

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

deleteRole()

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

deleteRoleAsync()

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

deleteRolePermissionsBoundary()

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

deleteRolePermissionsBoundaryAsync()

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

deleteRolePolicy()

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

deleteRolePolicyAsync()

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

deleteSAMLProvider()

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

deleteSAMLProviderAsync()

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

deleteServerCertificate()

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

deleteServerCertificateAsync()

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

deleteServiceLinkedRole()

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

deleteServiceLinkedRoleAsync()

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

deleteServiceSpecificCredential()

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

deleteServiceSpecificCredentialAsync()

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

deleteSigningCertificate()

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

deleteSigningCertificateAsync()

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

deleteSSHPublicKey()

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

deleteSSHPublicKeyAsync()

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

deleteUser()

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

deleteUserAsync()

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

deleteUserPermissionsBoundary()

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

deleteUserPermissionsBoundaryAsync()

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

deleteUserPolicy()

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

deleteUserPolicyAsync()

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

deleteVirtualMFADevice()

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

deleteVirtualMFADeviceAsync()

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

detachGroupPolicy()

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

detachGroupPolicyAsync()

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

detachRolePolicy()

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

detachRolePolicyAsync()

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

detachUserPolicy()

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

detachUserPolicyAsync()

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

enableMFADevice()

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

enableMFADeviceAsync()

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

factory()

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

generateCredentialReport()

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

generateCredentialReportAsync()

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

generateOrganizationsAccessReport()

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

generateOrganizationsAccessReportAsync()

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

generateServiceLastAccessedDetails()

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

generateServiceLastAccessedDetailsAsync()

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

getAccessKeyLastUsed()

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

getAccessKeyLastUsedAsync()

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

getAccountAuthorizationDetails()

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

getAccountAuthorizationDetailsAsync()

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

getAccountPasswordPolicy()

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

getAccountPasswordPolicyAsync()

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

getAccountSummary()

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

getAccountSummaryAsync()

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

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>

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

getContextKeysForCustomPolicy()

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

getContextKeysForCustomPolicyAsync()

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

getContextKeysForPrincipalPolicy()

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

getContextKeysForPrincipalPolicyAsync()

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

getCredentialReport()

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

getCredentialReportAsync()

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

getCredentials()

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

public getCredentials() : PromiseInterface

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

Return values
PromiseInterface

getGroup()

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

getGroupAsync()

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

getGroupPolicy()

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

getGroupPolicyAsync()

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList

getInstanceProfile()

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

getInstanceProfileAsync()

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

getIterator()

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

getLoginProfile()

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

getLoginProfileAsync()

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

getOpenIDConnectProvider()

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

getOpenIDConnectProviderAsync()

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

getOrganizationsAccessReport()

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

getOrganizationsAccessReportAsync()

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

getPaginator()

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

getPolicy()

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

getPolicyAsync()

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

getPolicyVersion()

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

getPolicyVersionAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getRole()

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

getRoleAsync()

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

getRolePolicy()

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

getRolePolicyAsync()

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

getSAMLProvider()

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

getSAMLProviderAsync()

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

getServerCertificate()

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

getServerCertificateAsync()

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

getServiceLastAccessedDetails()

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

getServiceLastAccessedDetailsAsync()

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

getServiceLastAccessedDetailsWithEntities()

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

getServiceLastAccessedDetailsWithEntitiesAsync()

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

getServiceLinkedRoleDeletionStatus()

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

getServiceLinkedRoleDeletionStatusAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getSSHPublicKey()

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

getSSHPublicKeyAsync()

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

getUser()

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

getUserAsync()

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

getUserPolicy()

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

getUserPolicyAsync()

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

getWaiter()

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

listAccessKeys()

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

listAccessKeysAsync()

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

listAccountAliases()

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

listAccountAliasesAsync()

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

listAttachedGroupPolicies()

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

listAttachedGroupPoliciesAsync()

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

listAttachedRolePolicies()

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

listAttachedRolePoliciesAsync()

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

listAttachedUserPolicies()

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

listAttachedUserPoliciesAsync()

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

listEntitiesForPolicy()

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

listEntitiesForPolicyAsync()

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

listGroupPolicies()

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

listGroupPoliciesAsync()

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

listGroups()

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

listGroupsAsync()

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

listGroupsForUser()

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

listGroupsForUserAsync()

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

listInstanceProfiles()

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

listInstanceProfilesAsync()

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

listInstanceProfilesForRole()

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

listInstanceProfilesForRoleAsync()

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

listMFADevices()

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

listMFADevicesAsync()

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

listOpenIDConnectProviders()

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

listOpenIDConnectProvidersAsync()

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

listPolicies()

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

listPoliciesAsync()

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

listPoliciesGrantingServiceAccess()

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

listPoliciesGrantingServiceAccessAsync()

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

listPolicyVersions()

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

listPolicyVersionsAsync()

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

listRolePolicies()

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

listRolePoliciesAsync()

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

listRoles()

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

listRolesAsync()

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

listRoleTags()

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

listRoleTagsAsync()

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

listSAMLProviders()

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

listSAMLProvidersAsync()

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

listServerCertificates()

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

listServerCertificatesAsync()

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

listServiceSpecificCredentials()

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

listServiceSpecificCredentialsAsync()

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

listSigningCertificates()

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

listSigningCertificatesAsync()

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

listSSHPublicKeys()

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

listSSHPublicKeysAsync()

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

listUserPolicies()

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

listUserPoliciesAsync()

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

listUsers()

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

listUsersAsync()

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

listUserTags()

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

listUserTagsAsync()

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

listVirtualMFADevices()

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

listVirtualMFADevicesAsync()

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

putGroupPolicy()

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

putGroupPolicyAsync()

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

putRolePermissionsBoundary()

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

putRolePermissionsBoundaryAsync()

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

putRolePolicy()

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

putRolePolicyAsync()

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

putUserPermissionsBoundary()

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

putUserPermissionsBoundaryAsync()

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

putUserPolicy()

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

putUserPolicyAsync()

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

removeClientIDFromOpenIDConnectProvider()

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

removeClientIDFromOpenIDConnectProviderAsync()

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

removeRoleFromInstanceProfile()

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

removeRoleFromInstanceProfileAsync()

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

removeUserFromGroup()

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

removeUserFromGroupAsync()

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

resetServiceSpecificCredential()

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

resetServiceSpecificCredentialAsync()

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

resyncMFADevice()

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

resyncMFADeviceAsync()

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

setDefaultPolicyVersion()

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

setDefaultPolicyVersionAsync()

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

setSecurityTokenServicePreferences()

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

setSecurityTokenServicePreferencesAsync()

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

simulateCustomPolicy()

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

simulateCustomPolicyAsync()

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

simulatePrincipalPolicy()

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

simulatePrincipalPolicyAsync()

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

tagRole()

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

tagRoleAsync()

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

tagUser()

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

tagUserAsync()

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

untagRole()

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

untagRoleAsync()

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

untagUser()

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

untagUserAsync()

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

updateAccessKey()

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

updateAccessKeyAsync()

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

updateAccountPasswordPolicy()

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

updateAccountPasswordPolicyAsync()

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

updateAssumeRolePolicy()

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

updateAssumeRolePolicyAsync()

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

updateGroup()

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

updateGroupAsync()

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

updateLoginProfile()

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

updateLoginProfileAsync()

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

updateOpenIDConnectProviderThumbprint()

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

updateOpenIDConnectProviderThumbprintAsync()

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

updateRole()

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

updateRoleAsync()

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

updateRoleDescription()

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

updateRoleDescriptionAsync()

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

updateSAMLProvider()

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

updateSAMLProviderAsync()

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

updateServerCertificate()

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

updateServerCertificateAsync()

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

updateServiceSpecificCredential()

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

updateServiceSpecificCredentialAsync()

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

updateSigningCertificate()

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

updateSigningCertificateAsync()

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

updateSSHPublicKey()

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

updateSSHPublicKeyAsync()

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

updateUser()

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

updateUserAsync()

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

uploadServerCertificate()

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

uploadServerCertificateAsync()

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

uploadSigningCertificate()

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

uploadSigningCertificateAsync()

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

uploadSSHPublicKey()

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

uploadSSHPublicKeyAsync()

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

waitUntil()

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

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed

addInvocationId()

private addInvocationId() : mixed
Return values
mixed

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results