IamClient
extends AwsClient
in package
This client is used to interact with the AWS Identity and Access Management (AWS IAM) 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.
- AddClientIDToOpenIDConnectProvider
- AddRoleToInstanceProfile
- AddUserToGroup
- AttachGroupPolicy
- AttachRolePolicy
- AttachUserPolicy
- ChangePassword
- CreateAccessKey
- CreateAccountAlias
- CreateGroup
- CreateInstanceProfile
- CreateLoginProfile
- CreateOpenIDConnectProvider
- CreatePolicy
- CreatePolicyVersion
- CreateRole
- CreateSAMLProvider
- CreateServiceLinkedRole
- CreateServiceSpecificCredential
- CreateUser
- CreateVirtualMFADevice
- DeactivateMFADevice
- DeleteAccessKey
- DeleteAccountAlias
- DeleteAccountPasswordPolicy
- DeleteGroup
- DeleteGroupPolicy
- DeleteInstanceProfile
- DeleteLoginProfile
- DeleteOpenIDConnectProvider
- DeletePolicy
- DeletePolicyVersion
- DeleteRole
- DeleteRolePermissionsBoundary
- DeleteRolePolicy
- DeleteSAMLProvider
- DeleteSSHPublicKey
- DeleteServerCertificate
- DeleteServiceLinkedRole
- DeleteServiceSpecificCredential
- DeleteSigningCertificate
- DeleteUser
- DeleteUserPermissionsBoundary
- DeleteUserPolicy
- DeleteVirtualMFADevice
- DetachGroupPolicy
- DetachRolePolicy
- DetachUserPolicy
- EnableMFADevice
- GenerateCredentialReport
- GenerateOrganizationsAccessReport
- GenerateServiceLastAccessedDetails
- GetAccessKeyLastUsed
- GetAccountAuthorizationDetails
- GetAccountPasswordPolicy
- GetAccountSummary
- GetContextKeysForCustomPolicy
- GetContextKeysForPrincipalPolicy
- GetCredentialReport
- GetGroup
- GetGroupPolicy
- GetInstanceProfile
- GetLoginProfile
- GetMFADevice
- GetOpenIDConnectProvider
- GetOrganizationsAccessReport
- GetPolicy
- GetPolicyVersion
- GetRole
- GetRolePolicy
- GetSAMLProvider
- GetSSHPublicKey
- GetServerCertificate
- GetServiceLastAccessedDetails
- GetServiceLastAccessedDetailsWithEntities
- GetServiceLinkedRoleDeletionStatus
- GetUser
- GetUserPolicy
- ListAccessKeys
- ListAccountAliases
- ListAttachedGroupPolicies
- ListAttachedRolePolicies
- ListAttachedUserPolicies
- ListEntitiesForPolicy
- ListGroupPolicies
- ListGroups
- ListGroupsForUser
- ListInstanceProfileTags
- ListInstanceProfiles
- ListInstanceProfilesForRole
- ListMFADeviceTags
- ListMFADevices
- ListOpenIDConnectProviderTags
- ListOpenIDConnectProviders
- ListPolicies
- ListPoliciesGrantingServiceAccess
- ListPolicyTags
- ListPolicyVersions
- ListRolePolicies
- ListRoleTags
- ListRoles
- ListSAMLProviderTags
- ListSAMLProviders
- ListSSHPublicKeys
- ListServerCertificateTags
- ListServerCertificates
- ListServiceSpecificCredentials
- ListSigningCertificates
- ListUserPolicies
- ListUserTags
- ListUsers
- ListVirtualMFADevices
- PutGroupPolicy
- PutRolePermissionsBoundary
- PutRolePolicy
- PutUserPermissionsBoundary
- PutUserPolicy
- RemoveClientIDFromOpenIDConnectProvider
- RemoveRoleFromInstanceProfile
- RemoveUserFromGroup
- ResetServiceSpecificCredential
- ResyncMFADevice
- SetDefaultPolicyVersion
- SetSecurityTokenServicePreferences
- SimulateCustomPolicy
- SimulatePrincipalPolicy
- TagInstanceProfile
- TagMFADevice
- TagOpenIDConnectProvider
- TagPolicy
- TagRole
- TagSAMLProvider
- TagServerCertificate
- TagUser
- UntagInstanceProfile
- UntagMFADevice
- UntagOpenIDConnectProvider
- UntagPolicy
- UntagRole
- UntagSAMLProvider
- UntagServerCertificate
- UntagUser
- UpdateAccessKey
- UpdateAccountPasswordPolicy
- UpdateAssumeRolePolicy
- UpdateGroup
- UpdateLoginProfile
- UpdateOpenIDConnectProviderThumbprint
- UpdateRole
- UpdateRoleDescription
- UpdateSAMLProvider
- UpdateSSHPublicKey
- UpdateServerCertificate
- UpdateServiceSpecificCredential
- UpdateSigningCertificate
- UpdateUser
- UploadSSHPublicKey
- UploadServerCertificate
- UploadSigningCertificate
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- addClientIDToOpenIDConnectProvider() : Result
- addClientIDToOpenIDConnectProviderAsync() : Promise
- addRoleToInstanceProfile() : Result
- addRoleToInstanceProfileAsync() : Promise
- addUserToGroup() : Result
- addUserToGroupAsync() : Promise
- attachGroupPolicy() : Result
- attachGroupPolicyAsync() : Promise
- attachRolePolicy() : Result
- attachRolePolicyAsync() : Promise
- attachUserPolicy() : Result
- attachUserPolicyAsync() : Promise
- changePassword() : Result
- changePasswordAsync() : Promise
- createAccessKey() : Result
- createAccessKeyAsync() : Promise
- createAccountAlias() : Result
- createAccountAliasAsync() : Promise
- createGroup() : Result
- createGroupAsync() : Promise
- createInstanceProfile() : Result
- createInstanceProfileAsync() : Promise
- createLoginProfile() : Result
- createLoginProfileAsync() : Promise
- createOpenIDConnectProvider() : Result
- createOpenIDConnectProviderAsync() : Promise
- createPolicy() : Result
- createPolicyAsync() : Promise
- createPolicyVersion() : Result
- createPolicyVersionAsync() : Promise
- createRole() : Result
- createRoleAsync() : Promise
- createSAMLProvider() : Result
- createSAMLProviderAsync() : Promise
- createServiceLinkedRole() : Result
- createServiceLinkedRoleAsync() : Promise
- createServiceSpecificCredential() : Result
- createServiceSpecificCredentialAsync() : Promise
- createUser() : Result
- createUserAsync() : Promise
- createVirtualMFADevice() : Result
- createVirtualMFADeviceAsync() : Promise
- deactivateMFADevice() : Result
- deactivateMFADeviceAsync() : Promise
- deleteAccessKey() : Result
- deleteAccessKeyAsync() : Promise
- deleteAccountAlias() : Result
- deleteAccountAliasAsync() : Promise
- deleteAccountPasswordPolicy() : Result
- deleteAccountPasswordPolicyAsync() : Promise
- deleteGroup() : Result
- deleteGroupAsync() : Promise
- deleteGroupPolicy() : Result
- deleteGroupPolicyAsync() : Promise
- deleteInstanceProfile() : Result
- deleteInstanceProfileAsync() : Promise
- deleteLoginProfile() : Result
- deleteLoginProfileAsync() : Promise
- deleteOpenIDConnectProvider() : Result
- deleteOpenIDConnectProviderAsync() : Promise
- deletePolicy() : Result
- deletePolicyAsync() : Promise
- deletePolicyVersion() : Result
- deletePolicyVersionAsync() : Promise
- deleteRole() : Result
- deleteRoleAsync() : Promise
- deleteRolePermissionsBoundary() : Result
- deleteRolePermissionsBoundaryAsync() : Promise
- deleteRolePolicy() : Result
- deleteRolePolicyAsync() : Promise
- deleteSAMLProvider() : Result
- deleteSAMLProviderAsync() : Promise
- deleteServerCertificate() : Result
- deleteServerCertificateAsync() : Promise
- deleteServiceLinkedRole() : Result
- deleteServiceLinkedRoleAsync() : Promise
- deleteServiceSpecificCredential() : Result
- deleteServiceSpecificCredentialAsync() : Promise
- deleteSigningCertificate() : Result
- deleteSigningCertificateAsync() : Promise
- deleteSSHPublicKey() : Result
- deleteSSHPublicKeyAsync() : Promise
- deleteUser() : Result
- deleteUserAsync() : Promise
- deleteUserPermissionsBoundary() : Result
- deleteUserPermissionsBoundaryAsync() : Promise
- deleteUserPolicy() : Result
- deleteUserPolicyAsync() : Promise
- deleteVirtualMFADevice() : Result
- deleteVirtualMFADeviceAsync() : Promise
- detachGroupPolicy() : Result
- detachGroupPolicyAsync() : Promise
- detachRolePolicy() : Result
- detachRolePolicyAsync() : Promise
- detachUserPolicy() : Result
- detachUserPolicyAsync() : Promise
- emitDeprecationWarning() : mixed
- enableMFADevice() : Result
- enableMFADeviceAsync() : Promise
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- generateCredentialReport() : Result
- generateCredentialReportAsync() : Promise
- generateOrganizationsAccessReport() : Result
- generateOrganizationsAccessReportAsync() : Promise
- generateServiceLastAccessedDetails() : Result
- generateServiceLastAccessedDetailsAsync() : Promise
- getAccessKeyLastUsed() : Result
- getAccessKeyLastUsedAsync() : Promise
- getAccountAuthorizationDetails() : Result
- getAccountAuthorizationDetailsAsync() : Promise
- getAccountPasswordPolicy() : Result
- getAccountPasswordPolicyAsync() : Promise
- getAccountSummary() : Result
- getAccountSummaryAsync() : 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.
- getContextKeysForCustomPolicy() : Result
- getContextKeysForCustomPolicyAsync() : Promise
- getContextKeysForPrincipalPolicy() : Result
- getContextKeysForPrincipalPolicyAsync() : Promise
- getCredentialReport() : Result
- getCredentialReportAsync() : Promise
- 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.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getGroup() : Result
- getGroupAsync() : Promise
- getGroupPolicy() : Result
- getGroupPolicyAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getInstanceProfile() : Result
- getInstanceProfileAsync() : Promise
- getIterator() : mixed
- getLoginProfile() : Result
- getLoginProfileAsync() : Promise
- getMFADevice() : Result
- getMFADeviceAsync() : Promise
- getOpenIDConnectProvider() : Result
- getOpenIDConnectProviderAsync() : Promise
- getOrganizationsAccessReport() : Result
- getOrganizationsAccessReportAsync() : Promise
- getPaginator() : mixed
- getPolicy() : Result
- getPolicyAsync() : Promise
- getPolicyVersion() : Result
- getPolicyVersionAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getRole() : Result
- getRoleAsync() : Promise
- getRolePolicy() : Result
- getRolePolicyAsync() : Promise
- getSAMLProvider() : Result
- getSAMLProviderAsync() : Promise
- getServerCertificate() : Result
- getServerCertificateAsync() : Promise
- getServiceLastAccessedDetails() : Result
- getServiceLastAccessedDetailsAsync() : Promise
- getServiceLastAccessedDetailsWithEntities() : Result
- getServiceLastAccessedDetailsWithEntitiesAsync() : Promise
- getServiceLinkedRoleDeletionStatus() : Result
- getServiceLinkedRoleDeletionStatusAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getSSHPublicKey() : Result
- getSSHPublicKeyAsync() : Promise
- getUser() : Result
- getUserAsync() : Promise
- getUserPolicy() : Result
- getUserPolicyAsync() : Promise
- getWaiter() : mixed
- listAccessKeys() : Result
- listAccessKeysAsync() : Promise
- listAccountAliases() : Result
- listAccountAliasesAsync() : Promise
- listAttachedGroupPolicies() : Result
- listAttachedGroupPoliciesAsync() : Promise
- listAttachedRolePolicies() : Result
- listAttachedRolePoliciesAsync() : Promise
- listAttachedUserPolicies() : Result
- listAttachedUserPoliciesAsync() : Promise
- listEntitiesForPolicy() : Result
- listEntitiesForPolicyAsync() : Promise
- listGroupPolicies() : Result
- listGroupPoliciesAsync() : Promise
- listGroups() : Result
- listGroupsAsync() : Promise
- listGroupsForUser() : Result
- listGroupsForUserAsync() : Promise
- listInstanceProfiles() : Result
- listInstanceProfilesAsync() : Promise
- listInstanceProfilesForRole() : Result
- listInstanceProfilesForRoleAsync() : Promise
- listInstanceProfileTags() : Result
- listInstanceProfileTagsAsync() : Promise
- listMFADevices() : Result
- listMFADevicesAsync() : Promise
- listMFADeviceTags() : Result
- listMFADeviceTagsAsync() : Promise
- listOpenIDConnectProviders() : Result
- listOpenIDConnectProvidersAsync() : Promise
- listOpenIDConnectProviderTags() : Result
- listOpenIDConnectProviderTagsAsync() : Promise
- listPolicies() : Result
- listPoliciesAsync() : Promise
- listPoliciesGrantingServiceAccess() : Result
- listPoliciesGrantingServiceAccessAsync() : Promise
- listPolicyTags() : Result
- listPolicyTagsAsync() : Promise
- listPolicyVersions() : Result
- listPolicyVersionsAsync() : Promise
- listRolePolicies() : Result
- listRolePoliciesAsync() : Promise
- listRoles() : Result
- listRolesAsync() : Promise
- listRoleTags() : Result
- listRoleTagsAsync() : Promise
- listSAMLProviders() : Result
- listSAMLProvidersAsync() : Promise
- listSAMLProviderTags() : Result
- listSAMLProviderTagsAsync() : Promise
- listServerCertificates() : Result
- listServerCertificatesAsync() : Promise
- listServerCertificateTags() : Result
- listServerCertificateTagsAsync() : Promise
- listServiceSpecificCredentials() : Result
- listServiceSpecificCredentialsAsync() : Promise
- listSigningCertificates() : Result
- listSigningCertificatesAsync() : Promise
- listSSHPublicKeys() : Result
- listSSHPublicKeysAsync() : Promise
- listUserPolicies() : Result
- listUserPoliciesAsync() : Promise
- listUsers() : Result
- listUsersAsync() : Promise
- listUserTags() : Result
- listUserTagsAsync() : Promise
- listVirtualMFADevices() : Result
- listVirtualMFADevicesAsync() : Promise
- putGroupPolicy() : Result
- putGroupPolicyAsync() : Promise
- putRolePermissionsBoundary() : Result
- putRolePermissionsBoundaryAsync() : Promise
- putRolePolicy() : Result
- putRolePolicyAsync() : Promise
- putUserPermissionsBoundary() : Result
- putUserPermissionsBoundaryAsync() : Promise
- putUserPolicy() : Result
- putUserPolicyAsync() : Promise
- removeClientIDFromOpenIDConnectProvider() : Result
- removeClientIDFromOpenIDConnectProviderAsync() : Promise
- removeRoleFromInstanceProfile() : Result
- removeRoleFromInstanceProfileAsync() : Promise
- removeUserFromGroup() : Result
- removeUserFromGroupAsync() : Promise
- resetServiceSpecificCredential() : Result
- resetServiceSpecificCredentialAsync() : Promise
- resyncMFADevice() : Result
- resyncMFADeviceAsync() : Promise
- setDefaultPolicyVersion() : Result
- setDefaultPolicyVersionAsync() : Promise
- setSecurityTokenServicePreferences() : Result
- setSecurityTokenServicePreferencesAsync() : Promise
- simulateCustomPolicy() : Result
- simulateCustomPolicyAsync() : Promise
- simulatePrincipalPolicy() : Result
- simulatePrincipalPolicyAsync() : Promise
- tagInstanceProfile() : Result
- tagInstanceProfileAsync() : Promise
- tagMFADevice() : Result
- tagMFADeviceAsync() : Promise
- tagOpenIDConnectProvider() : Result
- tagOpenIDConnectProviderAsync() : Promise
- tagPolicy() : Result
- tagPolicyAsync() : Promise
- tagRole() : Result
- tagRoleAsync() : Promise
- tagSAMLProvider() : Result
- tagSAMLProviderAsync() : Promise
- tagServerCertificate() : Result
- tagServerCertificateAsync() : Promise
- tagUser() : Result
- tagUserAsync() : Promise
- untagInstanceProfile() : Result
- untagInstanceProfileAsync() : Promise
- untagMFADevice() : Result
- untagMFADeviceAsync() : Promise
- untagOpenIDConnectProvider() : Result
- untagOpenIDConnectProviderAsync() : Promise
- untagPolicy() : Result
- untagPolicyAsync() : Promise
- untagRole() : Result
- untagRoleAsync() : Promise
- untagSAMLProvider() : Result
- untagSAMLProviderAsync() : Promise
- untagServerCertificate() : Result
- untagServerCertificateAsync() : Promise
- untagUser() : Result
- untagUserAsync() : Promise
- updateAccessKey() : Result
- updateAccessKeyAsync() : Promise
- updateAccountPasswordPolicy() : Result
- updateAccountPasswordPolicyAsync() : Promise
- updateAssumeRolePolicy() : Result
- updateAssumeRolePolicyAsync() : Promise
- updateGroup() : Result
- updateGroupAsync() : Promise
- updateLoginProfile() : Result
- updateLoginProfileAsync() : Promise
- updateOpenIDConnectProviderThumbprint() : Result
- updateOpenIDConnectProviderThumbprintAsync() : Promise
- updateRole() : Result
- updateRoleAsync() : Promise
- updateRoleDescription() : Result
- updateRoleDescriptionAsync() : Promise
- updateSAMLProvider() : Result
- updateSAMLProviderAsync() : Promise
- updateServerCertificate() : Result
- updateServerCertificateAsync() : Promise
- updateServiceSpecificCredential() : Result
- updateServiceSpecificCredentialAsync() : Promise
- updateSigningCertificate() : Result
- updateSigningCertificateAsync() : Promise
- updateSSHPublicKey() : Result
- updateSSHPublicKeyAsync() : Promise
- updateUser() : Result
- updateUserAsync() : Promise
- uploadServerCertificate() : Result
- uploadServerCertificateAsync() : Promise
- uploadSigningCertificate() : Result
- uploadSigningCertificateAsync() : Promise
- uploadSSHPublicKey() : Result
- uploadSSHPublicKeyAsync() : 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
addClientIDToOpenIDConnectProvider()
public
addClientIDToOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddClientIDToOpenIDConnectProviderAsync()
public
addClientIDToOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseaddRoleToInstanceProfile()
public
addRoleToInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddRoleToInstanceProfileAsync()
public
addRoleToInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseaddUserToGroup()
public
addUserToGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddUserToGroupAsync()
public
addUserToGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachGroupPolicy()
public
attachGroupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachGroupPolicyAsync()
public
attachGroupPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachRolePolicy()
public
attachRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachRolePolicyAsync()
public
attachRolePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachUserPolicy()
public
attachUserPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachUserPolicyAsync()
public
attachUserPolicyAsync(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
PromisecreateAccessKey()
public
createAccessKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAccessKeyAsync()
public
createAccessKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateAccountAlias()
public
createAccountAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAccountAliasAsync()
public
createAccountAliasAsync(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
PromisecreateInstanceProfile()
public
createInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInstanceProfileAsync()
public
createInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateLoginProfile()
public
createLoginProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateLoginProfileAsync()
public
createLoginProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateOpenIDConnectProvider()
public
createOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateOpenIDConnectProviderAsync()
public
createOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePolicy()
public
createPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePolicyAsync()
public
createPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePolicyVersion()
public
createPolicyVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePolicyVersionAsync()
public
createPolicyVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRole()
public
createRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRoleAsync()
public
createRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSAMLProvider()
public
createSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSAMLProviderAsync()
public
createSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateServiceLinkedRole()
public
createServiceLinkedRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateServiceLinkedRoleAsync()
public
createServiceLinkedRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateServiceSpecificCredential()
public
createServiceSpecificCredential(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateServiceSpecificCredentialAsync()
public
createServiceSpecificCredentialAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUser()
public
createUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUserAsync()
public
createUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateVirtualMFADevice()
public
createVirtualMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateVirtualMFADeviceAsync()
public
createVirtualMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeactivateMFADevice()
public
deactivateMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeactivateMFADeviceAsync()
public
deactivateMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAccessKey()
public
deleteAccessKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAccessKeyAsync()
public
deleteAccessKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAccountAlias()
public
deleteAccountAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAccountAliasAsync()
public
deleteAccountAliasAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAccountPasswordPolicy()
public
deleteAccountPasswordPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAccountPasswordPolicyAsync()
public
deleteAccountPasswordPolicyAsync(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
PromisedeleteGroupPolicy()
public
deleteGroupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteGroupPolicyAsync()
public
deleteGroupPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInstanceProfile()
public
deleteInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInstanceProfileAsync()
public
deleteInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLoginProfile()
public
deleteLoginProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLoginProfileAsync()
public
deleteLoginProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteOpenIDConnectProvider()
public
deleteOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteOpenIDConnectProviderAsync()
public
deleteOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePolicy()
public
deletePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePolicyAsync()
public
deletePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePolicyVersion()
public
deletePolicyVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePolicyVersionAsync()
public
deletePolicyVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRole()
public
deleteRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRoleAsync()
public
deleteRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRolePermissionsBoundary()
public
deleteRolePermissionsBoundary(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRolePermissionsBoundaryAsync()
public
deleteRolePermissionsBoundaryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRolePolicy()
public
deleteRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRolePolicyAsync()
public
deleteRolePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSAMLProvider()
public
deleteSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSAMLProviderAsync()
public
deleteSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteServerCertificate()
public
deleteServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteServerCertificateAsync()
public
deleteServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteServiceLinkedRole()
public
deleteServiceLinkedRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteServiceLinkedRoleAsync()
public
deleteServiceLinkedRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteServiceSpecificCredential()
public
deleteServiceSpecificCredential(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteServiceSpecificCredentialAsync()
public
deleteServiceSpecificCredentialAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSigningCertificate()
public
deleteSigningCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSigningCertificateAsync()
public
deleteSigningCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSSHPublicKey()
public
deleteSSHPublicKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSSHPublicKeyAsync()
public
deleteSSHPublicKeyAsync(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
PromisedeleteUserPermissionsBoundary()
public
deleteUserPermissionsBoundary(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserPermissionsBoundaryAsync()
public
deleteUserPermissionsBoundaryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserPolicy()
public
deleteUserPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserPolicyAsync()
public
deleteUserPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVirtualMFADevice()
public
deleteVirtualMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVirtualMFADeviceAsync()
public
deleteVirtualMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachGroupPolicy()
public
detachGroupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachGroupPolicyAsync()
public
detachGroupPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachRolePolicy()
public
detachRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachRolePolicyAsync()
public
detachRolePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachUserPolicy()
public
detachUserPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachUserPolicyAsync()
public
detachUserPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
enableMFADevice()
public
enableMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenableMFADeviceAsync()
public
enableMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promiseexecute()
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
staticgenerateCredentialReport()
public
generateCredentialReport(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgenerateCredentialReportAsync()
public
generateCredentialReportAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegenerateOrganizationsAccessReport()
public
generateOrganizationsAccessReport(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgenerateOrganizationsAccessReportAsync()
public
generateOrganizationsAccessReportAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegenerateServiceLastAccessedDetails()
public
generateServiceLastAccessedDetails(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgenerateServiceLastAccessedDetailsAsync()
public
generateServiceLastAccessedDetailsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetAccessKeyLastUsed()
public
getAccessKeyLastUsed(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccessKeyLastUsedAsync()
public
getAccessKeyLastUsedAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetAccountAuthorizationDetails()
public
getAccountAuthorizationDetails(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountAuthorizationDetailsAsync()
public
getAccountAuthorizationDetailsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetAccountPasswordPolicy()
public
getAccountPasswordPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountPasswordPolicyAsync()
public
getAccountPasswordPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetAccountSummary()
public
getAccountSummary(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountSummaryAsync()
public
getAccountSummaryAsync(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|nullgetContextKeysForCustomPolicy()
public
getContextKeysForCustomPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContextKeysForCustomPolicyAsync()
public
getContextKeysForCustomPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetContextKeysForPrincipalPolicy()
public
getContextKeysForPrincipalPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContextKeysForPrincipalPolicyAsync()
public
getContextKeysForPrincipalPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCredentialReport()
public
getCredentialReport(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCredentialReportAsync()
public
getCredentialReportAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCredentials()
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
PromiseInterfacegetEndpoint()
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
PromisegetGroupPolicy()
public
getGroupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetGroupPolicyAsync()
public
getGroupPolicyAsync(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
HandlerListgetInstanceProfile()
public
getInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInstanceProfileAsync()
public
getInstanceProfileAsync(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> = []
getLoginProfile()
public
getLoginProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetLoginProfileAsync()
public
getLoginProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMFADevice()
public
getMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMFADeviceAsync()
public
getMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOpenIDConnectProvider()
public
getOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOpenIDConnectProviderAsync()
public
getOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOrganizationsAccessReport()
public
getOrganizationsAccessReport(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOrganizationsAccessReportAsync()
public
getOrganizationsAccessReportAsync(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> = []
getPolicy()
public
getPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPolicyAsync()
public
getPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPolicyVersion()
public
getPolicyVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPolicyVersionAsync()
public
getPolicyVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetRole()
public
getRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRoleAsync()
public
getRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRolePolicy()
public
getRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRolePolicyAsync()
public
getRolePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSAMLProvider()
public
getSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSAMLProviderAsync()
public
getSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetServerCertificate()
public
getServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetServerCertificateAsync()
public
getServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetServiceLastAccessedDetails()
public
getServiceLastAccessedDetails(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetServiceLastAccessedDetailsAsync()
public
getServiceLastAccessedDetailsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetServiceLastAccessedDetailsWithEntities()
public
getServiceLastAccessedDetailsWithEntities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetServiceLastAccessedDetailsWithEntitiesAsync()
public
getServiceLastAccessedDetailsWithEntitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetServiceLinkedRoleDeletionStatus()
public
getServiceLinkedRoleDeletionStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetServiceLinkedRoleDeletionStatusAsync()
public
getServiceLinkedRoleDeletionStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSSHPublicKey()
public
getSSHPublicKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSSHPublicKeyAsync()
public
getSSHPublicKeyAsync(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
PromisegetUserPolicy()
public
getUserPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserPolicyAsync()
public
getUserPolicyAsync(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> = []
listAccessKeys()
public
listAccessKeys(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAccessKeysAsync()
public
listAccessKeysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAccountAliases()
public
listAccountAliases(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAccountAliasesAsync()
public
listAccountAliasesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAttachedGroupPolicies()
public
listAttachedGroupPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAttachedGroupPoliciesAsync()
public
listAttachedGroupPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAttachedRolePolicies()
public
listAttachedRolePolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAttachedRolePoliciesAsync()
public
listAttachedRolePoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAttachedUserPolicies()
public
listAttachedUserPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAttachedUserPoliciesAsync()
public
listAttachedUserPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistEntitiesForPolicy()
public
listEntitiesForPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistEntitiesForPolicyAsync()
public
listEntitiesForPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGroupPolicies()
public
listGroupPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGroupPoliciesAsync()
public
listGroupPoliciesAsync(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
PromiselistGroupsForUser()
public
listGroupsForUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGroupsForUserAsync()
public
listGroupsForUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInstanceProfiles()
public
listInstanceProfiles(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInstanceProfilesAsync()
public
listInstanceProfilesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInstanceProfilesForRole()
public
listInstanceProfilesForRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInstanceProfilesForRoleAsync()
public
listInstanceProfilesForRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInstanceProfileTags()
public
listInstanceProfileTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInstanceProfileTagsAsync()
public
listInstanceProfileTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMFADevices()
public
listMFADevices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMFADevicesAsync()
public
listMFADevicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMFADeviceTags()
public
listMFADeviceTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMFADeviceTagsAsync()
public
listMFADeviceTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOpenIDConnectProviders()
public
listOpenIDConnectProviders(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOpenIDConnectProvidersAsync()
public
listOpenIDConnectProvidersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOpenIDConnectProviderTags()
public
listOpenIDConnectProviderTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOpenIDConnectProviderTagsAsync()
public
listOpenIDConnectProviderTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPolicies()
public
listPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPoliciesAsync()
public
listPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPoliciesGrantingServiceAccess()
public
listPoliciesGrantingServiceAccess(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPoliciesGrantingServiceAccessAsync()
public
listPoliciesGrantingServiceAccessAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPolicyTags()
public
listPolicyTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPolicyTagsAsync()
public
listPolicyTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPolicyVersions()
public
listPolicyVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPolicyVersionsAsync()
public
listPolicyVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRolePolicies()
public
listRolePolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRolePoliciesAsync()
public
listRolePoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRoles()
public
listRoles(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRolesAsync()
public
listRolesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRoleTags()
public
listRoleTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRoleTagsAsync()
public
listRoleTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSAMLProviders()
public
listSAMLProviders(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSAMLProvidersAsync()
public
listSAMLProvidersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSAMLProviderTags()
public
listSAMLProviderTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSAMLProviderTagsAsync()
public
listSAMLProviderTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistServerCertificates()
public
listServerCertificates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistServerCertificatesAsync()
public
listServerCertificatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistServerCertificateTags()
public
listServerCertificateTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistServerCertificateTagsAsync()
public
listServerCertificateTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistServiceSpecificCredentials()
public
listServiceSpecificCredentials(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistServiceSpecificCredentialsAsync()
public
listServiceSpecificCredentialsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSigningCertificates()
public
listSigningCertificates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSigningCertificatesAsync()
public
listSigningCertificatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSSHPublicKeys()
public
listSSHPublicKeys(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSSHPublicKeysAsync()
public
listSSHPublicKeysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistUserPolicies()
public
listUserPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUserPoliciesAsync()
public
listUserPoliciesAsync(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
PromiselistUserTags()
public
listUserTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistUserTagsAsync()
public
listUserTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistVirtualMFADevices()
public
listVirtualMFADevices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistVirtualMFADevicesAsync()
public
listVirtualMFADevicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputGroupPolicy()
public
putGroupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputGroupPolicyAsync()
public
putGroupPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputRolePermissionsBoundary()
public
putRolePermissionsBoundary(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputRolePermissionsBoundaryAsync()
public
putRolePermissionsBoundaryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputRolePolicy()
public
putRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputRolePolicyAsync()
public
putRolePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputUserPermissionsBoundary()
public
putUserPermissionsBoundary(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputUserPermissionsBoundaryAsync()
public
putUserPermissionsBoundaryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputUserPolicy()
public
putUserPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputUserPolicyAsync()
public
putUserPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveClientIDFromOpenIDConnectProvider()
public
removeClientIDFromOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveClientIDFromOpenIDConnectProviderAsync()
public
removeClientIDFromOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveRoleFromInstanceProfile()
public
removeRoleFromInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveRoleFromInstanceProfileAsync()
public
removeRoleFromInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveUserFromGroup()
public
removeUserFromGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveUserFromGroupAsync()
public
removeUserFromGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseresetServiceSpecificCredential()
public
resetServiceSpecificCredential(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultresetServiceSpecificCredentialAsync()
public
resetServiceSpecificCredentialAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseresyncMFADevice()
public
resyncMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultresyncMFADeviceAsync()
public
resyncMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetDefaultPolicyVersion()
public
setDefaultPolicyVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetDefaultPolicyVersionAsync()
public
setDefaultPolicyVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetSecurityTokenServicePreferences()
public
setSecurityTokenServicePreferences(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetSecurityTokenServicePreferencesAsync()
public
setSecurityTokenServicePreferencesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesimulateCustomPolicy()
public
simulateCustomPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsimulateCustomPolicyAsync()
public
simulateCustomPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesimulatePrincipalPolicy()
public
simulatePrincipalPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsimulatePrincipalPolicyAsync()
public
simulatePrincipalPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagInstanceProfile()
public
tagInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagInstanceProfileAsync()
public
tagInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagMFADevice()
public
tagMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagMFADeviceAsync()
public
tagMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagOpenIDConnectProvider()
public
tagOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagOpenIDConnectProviderAsync()
public
tagOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagPolicy()
public
tagPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagPolicyAsync()
public
tagPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagRole()
public
tagRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagRoleAsync()
public
tagRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagSAMLProvider()
public
tagSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagSAMLProviderAsync()
public
tagSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagServerCertificate()
public
tagServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagServerCertificateAsync()
public
tagServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagUser()
public
tagUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagUserAsync()
public
tagUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagInstanceProfile()
public
untagInstanceProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagInstanceProfileAsync()
public
untagInstanceProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagMFADevice()
public
untagMFADevice(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagMFADeviceAsync()
public
untagMFADeviceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagOpenIDConnectProvider()
public
untagOpenIDConnectProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagOpenIDConnectProviderAsync()
public
untagOpenIDConnectProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagPolicy()
public
untagPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagPolicyAsync()
public
untagPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagRole()
public
untagRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagRoleAsync()
public
untagRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagSAMLProvider()
public
untagSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagSAMLProviderAsync()
public
untagSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagServerCertificate()
public
untagServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagServerCertificateAsync()
public
untagServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagUser()
public
untagUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagUserAsync()
public
untagUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAccessKey()
public
updateAccessKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAccessKeyAsync()
public
updateAccessKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAccountPasswordPolicy()
public
updateAccountPasswordPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAccountPasswordPolicyAsync()
public
updateAccountPasswordPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAssumeRolePolicy()
public
updateAssumeRolePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAssumeRolePolicyAsync()
public
updateAssumeRolePolicyAsync(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
PromiseupdateLoginProfile()
public
updateLoginProfile(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateLoginProfileAsync()
public
updateLoginProfileAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateOpenIDConnectProviderThumbprint()
public
updateOpenIDConnectProviderThumbprint(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateOpenIDConnectProviderThumbprintAsync()
public
updateOpenIDConnectProviderThumbprintAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRole()
public
updateRole(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRoleAsync()
public
updateRoleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRoleDescription()
public
updateRoleDescription(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRoleDescriptionAsync()
public
updateRoleDescriptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSAMLProvider()
public
updateSAMLProvider(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSAMLProviderAsync()
public
updateSAMLProviderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateServerCertificate()
public
updateServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateServerCertificateAsync()
public
updateServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateServiceSpecificCredential()
public
updateServiceSpecificCredential(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateServiceSpecificCredentialAsync()
public
updateServiceSpecificCredentialAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSigningCertificate()
public
updateSigningCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSigningCertificateAsync()
public
updateSigningCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSSHPublicKey()
public
updateSSHPublicKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSSHPublicKeyAsync()
public
updateSSHPublicKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUser()
public
updateUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserAsync()
public
updateUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuploadServerCertificate()
public
uploadServerCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuploadServerCertificateAsync()
public
uploadServerCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuploadSigningCertificate()
public
uploadSigningCertificate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuploadSigningCertificateAsync()
public
uploadSigningCertificateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuploadSSHPublicKey()
public
uploadSSHPublicKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuploadSSHPublicKeyAsync()
public
uploadSSHPublicKeyAsync(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> = []