CloudDirectoryClient
extends AwsClient
in package
This client is used to interact with the Amazon CloudDirectory 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.
- AddFacetToObject
- ApplySchema
- AttachObject
- AttachPolicy
- AttachToIndex
- AttachTypedLink
- BatchRead
- BatchWrite
- CreateDirectory
- CreateFacet
- CreateIndex
- CreateObject
- CreateSchema
- CreateTypedLinkFacet
- DeleteDirectory
- DeleteFacet
- DeleteObject
- DeleteSchema
- DeleteTypedLinkFacet
- DetachFromIndex
- DetachObject
- DetachPolicy
- DetachTypedLink
- DisableDirectory
- EnableDirectory
- GetAppliedSchemaVersion
- GetDirectory
- GetFacet
- GetLinkAttributes
- GetObjectAttributes
- GetObjectInformation
- GetSchemaAsJson
- GetTypedLinkFacetInformation
- ListAppliedSchemaArns
- ListAttachedIndices
- ListDevelopmentSchemaArns
- ListDirectories
- ListFacetAttributes
- ListFacetNames
- ListIncomingTypedLinks
- ListIndex
- ListManagedSchemaArns
- ListObjectAttributes
- ListObjectChildren
- ListObjectParentPaths
- ListObjectParents
- ListObjectPolicies
- ListOutgoingTypedLinks
- ListPolicyAttachments
- ListPublishedSchemaArns
- ListTagsForResource
- ListTypedLinkFacetAttributes
- ListTypedLinkFacetNames
- LookupPolicy
- PublishSchema
- PutSchemaFromJson
- RemoveFacetFromObject
- TagResource
- UntagResource
- UpdateFacet
- UpdateLinkAttributes
- UpdateObjectAttributes
- UpdateSchema
- UpdateTypedLinkFacet
- UpgradeAppliedSchema
- UpgradePublishedSchema
- AddFacetToObject
- ApplySchema
- AttachObject
- AttachPolicy
- AttachToIndex
- AttachTypedLink
- BatchRead
- BatchWrite
- CreateDirectory
- CreateFacet
- CreateIndex
- CreateObject
- CreateSchema
- CreateTypedLinkFacet
- DeleteDirectory
- DeleteFacet
- DeleteObject
- DeleteSchema
- DeleteTypedLinkFacet
- DetachFromIndex
- DetachObject
- DetachPolicy
- DetachTypedLink
- DisableDirectory
- EnableDirectory
- GetAppliedSchemaVersion
- GetDirectory
- GetFacet
- GetLinkAttributes
- GetObjectAttributes
- GetObjectInformation
- GetSchemaAsJson
- GetTypedLinkFacetInformation
- ListAppliedSchemaArns
- ListAttachedIndices
- ListDevelopmentSchemaArns
- ListDirectories
- ListFacetAttributes
- ListFacetNames
- ListIncomingTypedLinks
- ListIndex
- ListObjectAttributes
- ListObjectChildren
- ListObjectParentPaths
- ListObjectParents
- ListObjectPolicies
- ListOutgoingTypedLinks
- ListPolicyAttachments
- ListPublishedSchemaArns
- ListTagsForResource
- ListTypedLinkFacetAttributes
- ListTypedLinkFacetNames
- LookupPolicy
- PublishSchema
- PutSchemaFromJson
- RemoveFacetFromObject
- TagResource
- UntagResource
- UpdateFacet
- UpdateLinkAttributes
- UpdateObjectAttributes
- UpdateSchema
- UpdateTypedLinkFacet
- UpgradeAppliedSchema
- UpgradePublishedSchema
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- addFacetToObject() : Result
- addFacetToObjectAsync() : Promise
- applySchema() : Result
- applySchemaAsync() : Promise
- attachObject() : Result
- attachObjectAsync() : Promise
- attachPolicy() : Result
- attachPolicyAsync() : Promise
- attachToIndex() : Result
- attachToIndexAsync() : Promise
- attachTypedLink() : Result
- attachTypedLinkAsync() : Promise
- batchRead() : Result
- batchReadAsync() : Promise
- batchWrite() : Result
- batchWriteAsync() : Promise
- createDirectory() : Result
- createDirectoryAsync() : Promise
- createFacet() : Result
- createFacetAsync() : Promise
- createIndex() : Result
- createIndexAsync() : Promise
- createObject() : Result
- createObjectAsync() : Promise
- createSchema() : Result
- createSchemaAsync() : Promise
- createTypedLinkFacet() : Result
- createTypedLinkFacetAsync() : Promise
- deleteDirectory() : Result
- deleteDirectoryAsync() : Promise
- deleteFacet() : Result
- deleteFacetAsync() : Promise
- deleteObject() : Result
- deleteObjectAsync() : Promise
- deleteSchema() : Result
- deleteSchemaAsync() : Promise
- deleteTypedLinkFacet() : Result
- deleteTypedLinkFacetAsync() : Promise
- detachFromIndex() : Result
- detachFromIndexAsync() : Promise
- detachObject() : Result
- detachObjectAsync() : Promise
- detachPolicy() : Result
- detachPolicyAsync() : Promise
- detachTypedLink() : Result
- detachTypedLinkAsync() : Promise
- disableDirectory() : Result
- disableDirectoryAsync() : Promise
- emitDeprecationWarning() : mixed
- enableDirectory() : Result
- enableDirectoryAsync() : Promise
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getAppliedSchemaVersion() : Result
- getAppliedSchemaVersionAsync() : Promise
- 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.
- getDirectory() : Result
- getDirectoryAsync() : 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.
- getFacet() : Result
- getFacetAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getLinkAttributes() : Result
- getLinkAttributesAsync() : Promise
- getObjectAttributes() : Result
- getObjectAttributesAsync() : Promise
- getObjectInformation() : Result
- getObjectInformationAsync() : Promise
- getPaginator() : mixed
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getSchemaAsJson() : Result
- getSchemaAsJsonAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getTypedLinkFacetInformation() : Result
- getTypedLinkFacetInformationAsync() : Promise
- getWaiter() : mixed
- listAppliedSchemaArns() : Result
- listAppliedSchemaArnsAsync() : Promise
- listAttachedIndices() : Result
- listAttachedIndicesAsync() : Promise
- listDevelopmentSchemaArns() : Result
- listDevelopmentSchemaArnsAsync() : Promise
- listDirectories() : Result
- listDirectoriesAsync() : Promise
- listFacetAttributes() : Result
- listFacetAttributesAsync() : Promise
- listFacetNames() : Result
- listFacetNamesAsync() : Promise
- listIncomingTypedLinks() : Result
- listIncomingTypedLinksAsync() : Promise
- listIndex() : Result
- listIndexAsync() : Promise
- listManagedSchemaArns() : Result
- listManagedSchemaArnsAsync() : Promise
- listObjectAttributes() : Result
- listObjectAttributesAsync() : Promise
- listObjectChildren() : Result
- listObjectChildrenAsync() : Promise
- listObjectParentPaths() : Result
- listObjectParentPathsAsync() : Promise
- listObjectParents() : Result
- listObjectParentsAsync() : Promise
- listObjectPolicies() : Result
- listObjectPoliciesAsync() : Promise
- listOutgoingTypedLinks() : Result
- listOutgoingTypedLinksAsync() : Promise
- listPolicyAttachments() : Result
- listPolicyAttachmentsAsync() : Promise
- listPublishedSchemaArns() : Result
- listPublishedSchemaArnsAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listTypedLinkFacetAttributes() : Result
- listTypedLinkFacetAttributesAsync() : Promise
- listTypedLinkFacetNames() : Result
- listTypedLinkFacetNamesAsync() : Promise
- lookupPolicy() : Result
- lookupPolicyAsync() : Promise
- publishSchema() : Result
- publishSchemaAsync() : Promise
- putSchemaFromJson() : Result
- putSchemaFromJsonAsync() : Promise
- removeFacetFromObject() : Result
- removeFacetFromObjectAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateFacet() : Result
- updateFacetAsync() : Promise
- updateLinkAttributes() : Result
- updateLinkAttributesAsync() : Promise
- updateObjectAttributes() : Result
- updateObjectAttributesAsync() : Promise
- updateSchema() : Result
- updateSchemaAsync() : Promise
- updateTypedLinkFacet() : Result
- updateTypedLinkFacetAsync() : Promise
- upgradeAppliedSchema() : Result
- upgradeAppliedSchemaAsync() : Promise
- upgradePublishedSchema() : Result
- upgradePublishedSchemaAsync() : 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
addFacetToObject()
public
addFacetToObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultaddFacetToObjectAsync()
public
addFacetToObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseapplySchema()
public
applySchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultapplySchemaAsync()
public
applySchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachObject()
public
attachObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachObjectAsync()
public
attachObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachPolicy()
public
attachPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachPolicyAsync()
public
attachPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachToIndex()
public
attachToIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachToIndexAsync()
public
attachToIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachTypedLink()
public
attachTypedLink(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachTypedLinkAsync()
public
attachTypedLinkAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchRead()
public
batchRead(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchReadAsync()
public
batchReadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchWrite()
public
batchWrite(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchWriteAsync()
public
batchWriteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDirectory()
public
createDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDirectoryAsync()
public
createDirectoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateFacet()
public
createFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateFacetAsync()
public
createFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateIndex()
public
createIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateIndexAsync()
public
createIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateObject()
public
createObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateObjectAsync()
public
createObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSchema()
public
createSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSchemaAsync()
public
createSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTypedLinkFacet()
public
createTypedLinkFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTypedLinkFacetAsync()
public
createTypedLinkFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDirectory()
public
deleteDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDirectoryAsync()
public
deleteDirectoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteFacet()
public
deleteFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteFacetAsync()
public
deleteFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteObject()
public
deleteObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteObjectAsync()
public
deleteObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSchema()
public
deleteSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSchemaAsync()
public
deleteSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTypedLinkFacet()
public
deleteTypedLinkFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTypedLinkFacetAsync()
public
deleteTypedLinkFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachFromIndex()
public
detachFromIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachFromIndexAsync()
public
detachFromIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachObject()
public
detachObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachObjectAsync()
public
detachObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachPolicy()
public
detachPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachPolicyAsync()
public
detachPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachTypedLink()
public
detachTypedLink(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachTypedLinkAsync()
public
detachTypedLinkAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisableDirectory()
public
disableDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisableDirectoryAsync()
public
disableDirectoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
enableDirectory()
public
enableDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenableDirectoryAsync()
public
enableDirectoryAsync(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
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetAppliedSchemaVersion()
public
getAppliedSchemaVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAppliedSchemaVersionAsync()
public
getAppliedSchemaVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetArguments()
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
PromiseInterfacegetDirectory()
public
getDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDirectoryAsync()
public
getDirectoryAsync(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>getFacet()
public
getFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFacetAsync()
public
getFacetAsync(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> = []
getLinkAttributes()
public
getLinkAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetLinkAttributesAsync()
public
getLinkAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectAttributes()
public
getObjectAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectAttributesAsync()
public
getObjectAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectInformation()
public
getObjectInformation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectInformationAsync()
public
getObjectInformationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSchemaAsJson()
public
getSchemaAsJson(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSchemaAsJsonAsync()
public
getSchemaAsJsonAsync(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
callablegetTypedLinkFacetInformation()
public
getTypedLinkFacetInformation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTypedLinkFacetInformationAsync()
public
getTypedLinkFacetInformationAsync(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> = []
listAppliedSchemaArns()
public
listAppliedSchemaArns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAppliedSchemaArnsAsync()
public
listAppliedSchemaArnsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAttachedIndices()
public
listAttachedIndices(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAttachedIndicesAsync()
public
listAttachedIndicesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDevelopmentSchemaArns()
public
listDevelopmentSchemaArns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDevelopmentSchemaArnsAsync()
public
listDevelopmentSchemaArnsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDirectories()
public
listDirectories(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDirectoriesAsync()
public
listDirectoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistFacetAttributes()
public
listFacetAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistFacetAttributesAsync()
public
listFacetAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistFacetNames()
public
listFacetNames(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistFacetNamesAsync()
public
listFacetNamesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIncomingTypedLinks()
public
listIncomingTypedLinks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIncomingTypedLinksAsync()
public
listIncomingTypedLinksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIndex()
public
listIndex(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIndexAsync()
public
listIndexAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistManagedSchemaArns()
public
listManagedSchemaArns(array<string|int, mixed> $args = []) : Result
(supported in versions 2017-01-11)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistManagedSchemaArnsAsync()
public
listManagedSchemaArnsAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2017-01-11)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectAttributes()
public
listObjectAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectAttributesAsync()
public
listObjectAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectChildren()
public
listObjectChildren(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectChildrenAsync()
public
listObjectChildrenAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectParentPaths()
public
listObjectParentPaths(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectParentPathsAsync()
public
listObjectParentPathsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectParents()
public
listObjectParents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectParentsAsync()
public
listObjectParentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectPolicies()
public
listObjectPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectPoliciesAsync()
public
listObjectPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOutgoingTypedLinks()
public
listOutgoingTypedLinks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOutgoingTypedLinksAsync()
public
listOutgoingTypedLinksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPolicyAttachments()
public
listPolicyAttachments(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPolicyAttachmentsAsync()
public
listPolicyAttachmentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPublishedSchemaArns()
public
listPublishedSchemaArns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPublishedSchemaArnsAsync()
public
listPublishedSchemaArnsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTypedLinkFacetAttributes()
public
listTypedLinkFacetAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTypedLinkFacetAttributesAsync()
public
listTypedLinkFacetAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTypedLinkFacetNames()
public
listTypedLinkFacetNames(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTypedLinkFacetNamesAsync()
public
listTypedLinkFacetNamesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselookupPolicy()
public
lookupPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlookupPolicyAsync()
public
lookupPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisepublishSchema()
public
publishSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultpublishSchemaAsync()
public
publishSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputSchemaFromJson()
public
putSchemaFromJson(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputSchemaFromJsonAsync()
public
putSchemaFromJsonAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveFacetFromObject()
public
removeFacetFromObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveFacetFromObjectAsync()
public
removeFacetFromObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateFacet()
public
updateFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateFacetAsync()
public
updateFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateLinkAttributes()
public
updateLinkAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateLinkAttributesAsync()
public
updateLinkAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateObjectAttributes()
public
updateObjectAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateObjectAttributesAsync()
public
updateObjectAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSchema()
public
updateSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSchemaAsync()
public
updateSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTypedLinkFacet()
public
updateTypedLinkFacet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTypedLinkFacetAsync()
public
updateTypedLinkFacetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupgradeAppliedSchema()
public
upgradeAppliedSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupgradeAppliedSchemaAsync()
public
upgradeAppliedSchemaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupgradePublishedSchema()
public
upgradePublishedSchema(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupgradePublishedSchemaAsync()
public
upgradePublishedSchemaAsync(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> = []