WorkDocsClient
extends AwsClient
in package
This client is used to interact with the Amazon WorkDocs 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.
- AbortDocumentVersionUpload
- ActivateUser
- AddResourcePermissions
- CreateComment
- CreateCustomMetadata
- CreateFolder
- CreateLabels
- CreateNotificationSubscription
- CreateUser
- DeactivateUser
- DeleteComment
- DeleteCustomMetadata
- DeleteDocument
- DeleteDocumentVersion
- DeleteFolder
- DeleteFolderContents
- DeleteLabels
- DeleteNotificationSubscription
- DeleteUser
- DescribeActivities
- DescribeComments
- DescribeDocumentVersions
- DescribeFolderContents
- DescribeGroups
- DescribeNotificationSubscriptions
- DescribeResourcePermissions
- DescribeRootFolders
- DescribeUsers
- GetCurrentUser
- GetDocument
- GetDocumentPath
- GetDocumentVersion
- GetFolder
- GetFolderPath
- GetResources
- InitiateDocumentVersionUpload
- RemoveAllResourcePermissions
- RemoveResourcePermission
- RestoreDocumentVersions
- SearchResources
- UpdateDocument
- UpdateDocumentVersion
- UpdateFolder
- UpdateUser
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- abortDocumentVersionUpload() : Result
- abortDocumentVersionUploadAsync() : Promise
- activateUser() : Result
- activateUserAsync() : Promise
- addResourcePermissions() : Result
- addResourcePermissionsAsync() : Promise
- createComment() : Result
- createCommentAsync() : Promise
- createCustomMetadata() : Result
- createCustomMetadataAsync() : Promise
- createFolder() : Result
- createFolderAsync() : Promise
- createLabels() : Result
- createLabelsAsync() : Promise
- createNotificationSubscription() : Result
- createNotificationSubscriptionAsync() : Promise
- createUser() : Result
- createUserAsync() : Promise
- deactivateUser() : Result
- deactivateUserAsync() : Promise
- deleteComment() : Result
- deleteCommentAsync() : Promise
- deleteCustomMetadata() : Result
- deleteCustomMetadataAsync() : Promise
- deleteDocument() : Result
- deleteDocumentAsync() : Promise
- deleteDocumentVersion() : Result
- deleteDocumentVersionAsync() : Promise
- deleteFolder() : Result
- deleteFolderAsync() : Promise
- deleteFolderContents() : Result
- deleteFolderContentsAsync() : Promise
- deleteLabels() : Result
- deleteLabelsAsync() : Promise
- deleteNotificationSubscription() : Result
- deleteNotificationSubscriptionAsync() : Promise
- deleteUser() : Result
- deleteUserAsync() : Promise
- describeActivities() : Result
- describeActivitiesAsync() : Promise
- describeComments() : Result
- describeCommentsAsync() : Promise
- describeDocumentVersions() : Result
- describeDocumentVersionsAsync() : Promise
- describeFolderContents() : Result
- describeFolderContentsAsync() : Promise
- describeGroups() : Result
- describeGroupsAsync() : Promise
- describeNotificationSubscriptions() : Result
- describeNotificationSubscriptionsAsync() : Promise
- describeResourcePermissions() : Result
- describeResourcePermissionsAsync() : Promise
- describeRootFolders() : Result
- describeRootFoldersAsync() : Promise
- describeUsers() : Result
- describeUsersAsync() : Promise
- emitDeprecationWarning() : mixed
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getClientBuiltIns() : array<string|int, mixed>
- Provides the set of built-in keys and values used for endpoint resolution
- getClientContextParams() : array<string|int, mixed>
- Provides the set of service context parameter key-value pairs used for endpoint resolution.
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getCurrentUser() : Result
- getCurrentUserAsync() : Promise
- getDocument() : Result
- getDocumentAsync() : Promise
- getDocumentPath() : Result
- getDocumentPathAsync() : Promise
- getDocumentVersion() : Result
- getDocumentVersionAsync() : Promise
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getEndpointProvider() : mixed
- getEndpointProviderArgs() : array<string|int, mixed>
- Retrieves arguments to be used in endpoint resolution.
- getFolder() : Result
- getFolderAsync() : Promise
- getFolderPath() : Result
- getFolderPathAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getResources() : Result
- getResourcesAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- initiateDocumentVersionUpload() : Result
- initiateDocumentVersionUploadAsync() : Promise
- removeAllResourcePermissions() : Result
- removeAllResourcePermissionsAsync() : Promise
- removeResourcePermission() : Result
- removeResourcePermissionAsync() : Promise
- restoreDocumentVersions() : Result
- restoreDocumentVersionsAsync() : Promise
- searchResources() : Result
- searchResourcesAsync() : Promise
- updateDocument() : Result
- updateDocumentAsync() : Promise
- updateDocumentVersion() : Result
- updateDocumentVersionAsync() : Promise
- updateFolder() : Result
- updateFolderAsync() : Promise
- updateUser() : Result
- updateUserAsync() : 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
abortDocumentVersionUpload()
public
abortDocumentVersionUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultabortDocumentVersionUploadAsync()
public
abortDocumentVersionUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseactivateUser()
public
activateUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultactivateUserAsync()
public
activateUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseaddResourcePermissions()
public
addResourcePermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddResourcePermissionsAsync()
public
addResourcePermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateComment()
public
createComment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCommentAsync()
public
createCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCustomMetadata()
public
createCustomMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCustomMetadataAsync()
public
createCustomMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateFolder()
public
createFolder(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateFolderAsync()
public
createFolderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateLabels()
public
createLabels(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateLabelsAsync()
public
createLabelsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateNotificationSubscription()
public
createNotificationSubscription(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateNotificationSubscriptionAsync()
public
createNotificationSubscriptionAsync(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
PromisedeactivateUser()
public
deactivateUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeactivateUserAsync()
public
deactivateUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteComment()
public
deleteComment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCommentAsync()
public
deleteCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCustomMetadata()
public
deleteCustomMetadata(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCustomMetadataAsync()
public
deleteCustomMetadataAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDocument()
public
deleteDocument(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDocumentAsync()
public
deleteDocumentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDocumentVersion()
public
deleteDocumentVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDocumentVersionAsync()
public
deleteDocumentVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteFolder()
public
deleteFolder(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteFolderAsync()
public
deleteFolderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteFolderContents()
public
deleteFolderContents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteFolderContentsAsync()
public
deleteFolderContentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLabels()
public
deleteLabels(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLabelsAsync()
public
deleteLabelsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteNotificationSubscription()
public
deleteNotificationSubscription(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteNotificationSubscriptionAsync()
public
deleteNotificationSubscriptionAsync(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
PromisedescribeActivities()
public
describeActivities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeActivitiesAsync()
public
describeActivitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeComments()
public
describeComments(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeCommentsAsync()
public
describeCommentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeDocumentVersions()
public
describeDocumentVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeDocumentVersionsAsync()
public
describeDocumentVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeFolderContents()
public
describeFolderContents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeFolderContentsAsync()
public
describeFolderContentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeGroups()
public
describeGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeGroupsAsync()
public
describeGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeNotificationSubscriptions()
public
describeNotificationSubscriptions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeNotificationSubscriptionsAsync()
public
describeNotificationSubscriptionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeResourcePermissions()
public
describeResourcePermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeResourcePermissionsAsync()
public
describeResourcePermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeRootFolders()
public
describeRootFolders(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeRootFoldersAsync()
public
describeRootFoldersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeUsers()
public
describeUsers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeUsersAsync()
public
describeUsersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|nullgetCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterfacegetCurrentUser()
public
getCurrentUser(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCurrentUserAsync()
public
getCurrentUserAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDocument()
public
getDocument(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDocumentAsync()
public
getDocumentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDocumentPath()
public
getDocumentPath(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDocumentPathAsync()
public
getDocumentPathAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDocumentVersion()
public
getDocumentVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDocumentVersionAsync()
public
getDocumentVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getFolder()
public
getFolder(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFolderAsync()
public
getFolderAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetFolderPath()
public
getFolderPath(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFolderPathAsync()
public
getFolderPathAsync(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
HandlerListgetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetResources()
public
getResources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetResourcesAsync()
public
getResourcesAsync(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
callablegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
initiateDocumentVersionUpload()
public
initiateDocumentVersionUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultinitiateDocumentVersionUploadAsync()
public
initiateDocumentVersionUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveAllResourcePermissions()
public
removeAllResourcePermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveAllResourcePermissionsAsync()
public
removeAllResourcePermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveResourcePermission()
public
removeResourcePermission(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveResourcePermissionAsync()
public
removeResourcePermissionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserestoreDocumentVersions()
public
restoreDocumentVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrestoreDocumentVersionsAsync()
public
restoreDocumentVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesearchResources()
public
searchResources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsearchResourcesAsync()
public
searchResourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDocument()
public
updateDocument(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDocumentAsync()
public
updateDocumentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDocumentVersion()
public
updateDocumentVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDocumentVersionAsync()
public
updateDocumentVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateFolder()
public
updateFolder(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateFolderAsync()
public
updateFolderAsync(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
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []