Documentation

ComprehendClient extends AwsClient
in package

This client is used to interact with the **Amazon Comprehend** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchDetectDominantLanguage()  :
batchDetectDominantLanguageAsync()  :
batchDetectEntities()  :
batchDetectEntitiesAsync()  :
batchDetectKeyPhrases()  :
batchDetectKeyPhrasesAsync()  :
batchDetectSentiment()  :
batchDetectSentimentAsync()  :
batchDetectSyntax()  :
batchDetectSyntaxAsync()  :
classifyDocument()  :
classifyDocumentAsync()  :
createDocumentClassifier()  :
createDocumentClassifierAsync()  :
createEndpoint()  :
createEndpointAsync()  :
createEntityRecognizer()  :
createEntityRecognizerAsync()  :
deleteDocumentClassifier()  :
deleteDocumentClassifierAsync()  :
deleteEndpoint()  :
deleteEndpointAsync()  :
deleteEntityRecognizer()  :
deleteEntityRecognizerAsync()  :
describeDocumentClassificationJob()  :
describeDocumentClassificationJobAsync()  :
describeDocumentClassifier()  :
describeDocumentClassifierAsync()  :
describeDominantLanguageDetectionJob()  :
describeDominantLanguageDetectionJobAsync()  :
describeEndpoint()  :
describeEndpointAsync()  :
describeEntitiesDetectionJob()  :
describeEntitiesDetectionJobAsync()  :
describeEntityRecognizer()  :
describeEntityRecognizerAsync()  :
describeEventsDetectionJob()  :
describeEventsDetectionJobAsync()  :
describeKeyPhrasesDetectionJob()  :
describeKeyPhrasesDetectionJobAsync()  :
describePiiEntitiesDetectionJob()  :
describePiiEntitiesDetectionJobAsync()  :
describeSentimentDetectionJob()  :
describeSentimentDetectionJobAsync()  :
describeTopicsDetectionJob()  :
describeTopicsDetectionJobAsync()  :
detectDominantLanguage()  :
detectDominantLanguageAsync()  :
detectEntities()  :
detectEntitiesAsync()  :
detectKeyPhrases()  :
detectKeyPhrasesAsync()  :
detectPiiEntities()  :
detectPiiEntitiesAsync()  :
detectSentiment()  :
detectSentimentAsync()  :
detectSyntax()  :
detectSyntaxAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
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.
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.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listDocumentClassificationJobs()  :
listDocumentClassificationJobsAsync()  :
listDocumentClassifiers()  :
listDocumentClassifiersAsync()  :
listDominantLanguageDetectionJobs()  :
listDominantLanguageDetectionJobsAsync()  :
listEndpoints()  :
listEndpointsAsync()  :
listEntitiesDetectionJobs()  :
listEntitiesDetectionJobsAsync()  :
listEntityRecognizers()  :
listEntityRecognizersAsync()  :
listEventsDetectionJobs()  :
listEventsDetectionJobsAsync()  :
listKeyPhrasesDetectionJobs()  :
listKeyPhrasesDetectionJobsAsync()  :
listPiiEntitiesDetectionJobs()  :
listPiiEntitiesDetectionJobsAsync()  :
listSentimentDetectionJobs()  :
listSentimentDetectionJobsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
listTopicsDetectionJobs()  :
listTopicsDetectionJobsAsync()  :
startDocumentClassificationJob()  :
startDocumentClassificationJobAsync()  :
startDominantLanguageDetectionJob()  :
startDominantLanguageDetectionJobAsync()  :
startEntitiesDetectionJob()  :
startEntitiesDetectionJobAsync()  :
startEventsDetectionJob()  :
startEventsDetectionJobAsync()  :
startKeyPhrasesDetectionJob()  :
startKeyPhrasesDetectionJobAsync()  :
startPiiEntitiesDetectionJob()  :
startPiiEntitiesDetectionJobAsync()  :
startSentimentDetectionJob()  :
startSentimentDetectionJobAsync()  :
startTopicsDetectionJob()  :
startTopicsDetectionJobAsync()  :
stopDominantLanguageDetectionJob()  :
stopDominantLanguageDetectionJobAsync()  :
stopEntitiesDetectionJob()  :
stopEntitiesDetectionJobAsync()  :
stopEventsDetectionJob()  :
stopEventsDetectionJobAsync()  :
stopKeyPhrasesDetectionJob()  :
stopKeyPhrasesDetectionJobAsync()  :
stopPiiEntitiesDetectionJob()  :
stopPiiEntitiesDetectionJobAsync()  :
stopSentimentDetectionJob()  :
stopSentimentDetectionJobAsync()  :
stopTrainingDocumentClassifier()  :
stopTrainingDocumentClassifierAsync()  :
stopTrainingEntityRecognizer()  :
stopTrainingEntityRecognizerAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateEndpoint()  :
updateEndpointAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

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

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

batchDetectDominantLanguage()

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

batchDetectDominantLanguageAsync()

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

batchDetectEntities()

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

batchDetectEntitiesAsync()

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

batchDetectKeyPhrases()

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

batchDetectKeyPhrasesAsync()

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

batchDetectSentiment()

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

batchDetectSentimentAsync()

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

batchDetectSyntax()

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

batchDetectSyntaxAsync()

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

classifyDocument()

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

classifyDocumentAsync()

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

createDocumentClassifier()

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

createDocumentClassifierAsync()

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

createEndpoint()

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

createEndpointAsync()

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

createEntityRecognizer()

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

createEntityRecognizerAsync()

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

deleteDocumentClassifier()

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

deleteDocumentClassifierAsync()

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

deleteEndpoint()

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

deleteEndpointAsync()

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

deleteEntityRecognizer()

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

deleteEntityRecognizerAsync()

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

describeDocumentClassificationJob()

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

describeDocumentClassificationJobAsync()

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

describeDocumentClassifier()

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

describeDocumentClassifierAsync()

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

describeDominantLanguageDetectionJob()

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

describeDominantLanguageDetectionJobAsync()

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

describeEndpoint()

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

describeEndpointAsync()

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

describeEntitiesDetectionJob()

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

describeEntitiesDetectionJobAsync()

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

describeEntityRecognizer()

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

describeEntityRecognizerAsync()

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

describeEventsDetectionJob()

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

describeEventsDetectionJobAsync()

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

describeKeyPhrasesDetectionJob()

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

describeKeyPhrasesDetectionJobAsync()

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

describePiiEntitiesDetectionJob()

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

describePiiEntitiesDetectionJobAsync()

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

describeSentimentDetectionJob()

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

describeSentimentDetectionJobAsync()

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

describeTopicsDetectionJob()

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

describeTopicsDetectionJobAsync()

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

detectDominantLanguage()

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

detectDominantLanguageAsync()

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

detectEntities()

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

detectEntitiesAsync()

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

detectKeyPhrases()

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

detectKeyPhrasesAsync()

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

detectPiiEntities()

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

detectPiiEntitiesAsync()

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

detectSentiment()

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

detectSentimentAsync()

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

detectSyntax()

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

detectSyntaxAsync()

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

factory()

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

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getCredentials()

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

public getCredentials() : PromiseInterface

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

Return values
PromiseInterface —

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList —

getIterator()

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

getPaginator()

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

getRegion()

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

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

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

listDocumentClassificationJobs()

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

listDocumentClassificationJobsAsync()

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

listDocumentClassifiers()

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

listDocumentClassifiersAsync()

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

listDominantLanguageDetectionJobs()

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

listDominantLanguageDetectionJobsAsync()

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

listEndpoints()

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

listEndpointsAsync()

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

listEntitiesDetectionJobs()

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

listEntitiesDetectionJobsAsync()

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

listEntityRecognizers()

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

listEntityRecognizersAsync()

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

listEventsDetectionJobs()

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

listEventsDetectionJobsAsync()

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

listKeyPhrasesDetectionJobs()

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

listKeyPhrasesDetectionJobsAsync()

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

listPiiEntitiesDetectionJobs()

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

listPiiEntitiesDetectionJobsAsync()

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

listSentimentDetectionJobs()

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

listSentimentDetectionJobsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTopicsDetectionJobs()

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

listTopicsDetectionJobsAsync()

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

startDocumentClassificationJob()

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

startDocumentClassificationJobAsync()

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

startDominantLanguageDetectionJob()

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

startDominantLanguageDetectionJobAsync()

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

startEntitiesDetectionJob()

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

startEntitiesDetectionJobAsync()

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

startEventsDetectionJob()

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

startEventsDetectionJobAsync()

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

startKeyPhrasesDetectionJob()

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

startKeyPhrasesDetectionJobAsync()

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

startPiiEntitiesDetectionJob()

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

startPiiEntitiesDetectionJobAsync()

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

startSentimentDetectionJob()

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

startSentimentDetectionJobAsync()

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

startTopicsDetectionJob()

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

startTopicsDetectionJobAsync()

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

stopDominantLanguageDetectionJob()

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

stopDominantLanguageDetectionJobAsync()

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

stopEntitiesDetectionJob()

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

stopEntitiesDetectionJobAsync()

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

stopEventsDetectionJob()

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

stopEventsDetectionJobAsync()

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

stopKeyPhrasesDetectionJob()

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

stopKeyPhrasesDetectionJobAsync()

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

stopPiiEntitiesDetectionJob()

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

stopPiiEntitiesDetectionJobAsync()

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

stopSentimentDetectionJob()

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

stopSentimentDetectionJobAsync()

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

stopTrainingDocumentClassifier()

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

stopTrainingDocumentClassifierAsync()

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

stopTrainingEntityRecognizer()

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

stopTrainingEntityRecognizerAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateEndpoint()

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

updateEndpointAsync()

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

waitUntil()

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

addEndpointDiscoveryMiddleware()

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

addEndpointParameterMiddleware()

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

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

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

parseClass()

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

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

Search results