SDK for PHP 3.x

CloudWatchLogsClient extends AwsClient
in package

This client is used to interact with the Amazon CloudWatch Logs 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.

Table of Contents

Properties

$streamingCommands  : mixed

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
associateKmsKey()  : Result
associateKmsKeyAsync()  : Promise
cancelExportTask()  : Result
cancelExportTaskAsync()  : Promise
createDelivery()  : Result
createDeliveryAsync()  : Promise
createExportTask()  : Result
createExportTaskAsync()  : Promise
createLogAnomalyDetector()  : Result
createLogAnomalyDetectorAsync()  : Promise
createLogGroup()  : Result
createLogGroupAsync()  : Promise
createLogStream()  : Result
createLogStreamAsync()  : Promise
deleteAccountPolicy()  : Result
deleteAccountPolicyAsync()  : Promise
deleteDataProtectionPolicy()  : Result
deleteDataProtectionPolicyAsync()  : Promise
deleteDelivery()  : Result
deleteDeliveryAsync()  : Promise
deleteDeliveryDestination()  : Result
deleteDeliveryDestinationAsync()  : Promise
deleteDeliveryDestinationPolicy()  : Result
deleteDeliveryDestinationPolicyAsync()  : Promise
deleteDeliverySource()  : Result
deleteDeliverySourceAsync()  : Promise
deleteDestination()  : Result
deleteDestinationAsync()  : Promise
deleteLogAnomalyDetector()  : Result
deleteLogAnomalyDetectorAsync()  : Promise
deleteLogGroup()  : Result
deleteLogGroupAsync()  : Promise
deleteLogStream()  : Result
deleteLogStreamAsync()  : Promise
deleteMetricFilter()  : Result
deleteMetricFilterAsync()  : Promise
deleteQueryDefinition()  : Result
deleteQueryDefinitionAsync()  : Promise
deleteResourcePolicy()  : Result
deleteResourcePolicyAsync()  : Promise
deleteRetentionPolicy()  : Result
deleteRetentionPolicyAsync()  : Promise
deleteSubscriptionFilter()  : Result
deleteSubscriptionFilterAsync()  : Promise
describeAccountPolicies()  : Result
describeAccountPoliciesAsync()  : Promise
describeDeliveries()  : Result
describeDeliveriesAsync()  : Promise
describeDeliveryDestinations()  : Result
describeDeliveryDestinationsAsync()  : Promise
describeDeliverySources()  : Result
describeDeliverySourcesAsync()  : Promise
describeDestinations()  : Result
describeDestinationsAsync()  : Promise
describeExportTasks()  : Result
describeExportTasksAsync()  : Promise
describeLogGroups()  : Result
describeLogGroupsAsync()  : Promise
describeLogStreams()  : Result
describeLogStreamsAsync()  : Promise
describeMetricFilters()  : Result
describeMetricFiltersAsync()  : Promise
describeQueries()  : Result
describeQueriesAsync()  : Promise
describeQueryDefinitions()  : Result
describeQueryDefinitionsAsync()  : Promise
describeResourcePolicies()  : Result
describeResourcePoliciesAsync()  : Promise
describeSubscriptionFilters()  : Result
describeSubscriptionFiltersAsync()  : Promise
disassociateKmsKey()  : Result
disassociateKmsKeyAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
filterLogEvents()  : Result
filterLogEventsAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDataProtectionPolicy()  : Result
getDataProtectionPolicyAsync()  : Promise
getDelivery()  : Result
getDeliveryAsync()  : Promise
getDeliveryDestination()  : Result
getDeliveryDestinationAsync()  : Promise
getDeliveryDestinationPolicy()  : Result
getDeliveryDestinationPolicyAsync()  : Promise
getDeliverySource()  : Result
getDeliverySourceAsync()  : 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.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getLogAnomalyDetector()  : Result
getLogAnomalyDetectorAsync()  : Promise
getLogEvents()  : Result
getLogEventsAsync()  : Promise
getLogGroupFields()  : Result
getLogGroupFieldsAsync()  : Promise
getLogRecord()  : Result
getLogRecordAsync()  : Promise
getPaginator()  : mixed
getQueryResults()  : Result
getQueryResultsAsync()  : Promise
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
listAnomalies()  : Result
listAnomaliesAsync()  : Promise
listLogAnomalyDetectors()  : Result
listLogAnomalyDetectorsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listTagsLogGroup()  : Result
listTagsLogGroupAsync()  : Promise
putAccountPolicy()  : Result
putAccountPolicyAsync()  : Promise
putDataProtectionPolicy()  : Result
putDataProtectionPolicyAsync()  : Promise
putDeliveryDestination()  : Result
putDeliveryDestinationAsync()  : Promise
putDeliveryDestinationPolicy()  : Result
putDeliveryDestinationPolicyAsync()  : Promise
putDeliverySource()  : Result
putDeliverySourceAsync()  : Promise
putDestination()  : Result
putDestinationAsync()  : Promise
putDestinationPolicy()  : Result
putDestinationPolicyAsync()  : Promise
putLogEvents()  : Result
putLogEventsAsync()  : Promise
putMetricFilter()  : Result
putMetricFilterAsync()  : Promise
putQueryDefinition()  : Result
putQueryDefinitionAsync()  : Promise
putResourcePolicy()  : Result
putResourcePolicyAsync()  : Promise
putRetentionPolicy()  : Result
putRetentionPolicyAsync()  : Promise
putSubscriptionFilter()  : Result
putSubscriptionFilterAsync()  : Promise
startLiveTail()  : Result
startLiveTailAsync()  : Promise
startLiveTailCheckingForResults()  : Generator
Helper method for 'startLiveTail' operation that checks for results.
startQuery()  : Result
startQueryAsync()  : Promise
stopQuery()  : Result
stopQueryAsync()  : Promise
tagLogGroup()  : Result
tagLogGroupAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
testMetricFilter()  : Result
testMetricFilterAsync()  : Promise
untagLogGroup()  : Result
untagLogGroupAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAnomaly()  : Result
updateAnomalyAsync()  : Promise
updateLogAnomalyDetector()  : Result
updateLogAnomalyDetectorAsync()  : Promise
waitUntil()  : mixed

Properties

$streamingCommands

public static mixed $streamingCommands = ['StartLiveTail' => true]

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.

__sleep()

public __sleep() : mixed

associateKmsKey()

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

associateKmsKeyAsync()

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

cancelExportTask()

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

cancelExportTaskAsync()

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

createDelivery()

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

createDeliveryAsync()

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

createExportTask()

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

createExportTaskAsync()

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

createLogAnomalyDetector()

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

createLogAnomalyDetectorAsync()

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

createLogGroup()

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

createLogGroupAsync()

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

createLogStream()

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

createLogStreamAsync()

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

deleteAccountPolicy()

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

deleteAccountPolicyAsync()

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

deleteDataProtectionPolicy()

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

deleteDataProtectionPolicyAsync()

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

deleteDelivery()

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

deleteDeliveryAsync()

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

deleteDeliveryDestination()

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

deleteDeliveryDestinationAsync()

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

deleteDeliveryDestinationPolicy()

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

deleteDeliveryDestinationPolicyAsync()

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

deleteDeliverySource()

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

deleteDeliverySourceAsync()

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

deleteDestination()

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

deleteDestinationAsync()

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

deleteLogAnomalyDetector()

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

deleteLogAnomalyDetectorAsync()

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

deleteLogGroup()

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

deleteLogGroupAsync()

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

deleteLogStream()

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

deleteLogStreamAsync()

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

deleteMetricFilter()

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

deleteMetricFilterAsync()

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

deleteQueryDefinition()

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

deleteQueryDefinitionAsync()

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

deleteResourcePolicy()

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

deleteResourcePolicyAsync()

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

deleteRetentionPolicy()

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

deleteRetentionPolicyAsync()

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

deleteSubscriptionFilter()

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

deleteSubscriptionFilterAsync()

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

describeAccountPolicies()

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

describeAccountPoliciesAsync()

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

describeDeliveries()

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

describeDeliveriesAsync()

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

describeDeliveryDestinations()

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

describeDeliveryDestinationsAsync()

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

describeDeliverySources()

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

describeDeliverySourcesAsync()

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

describeDestinations()

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

describeDestinationsAsync()

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

describeExportTasks()

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

describeExportTasksAsync()

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

describeLogGroups()

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

describeLogGroupsAsync()

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

describeLogStreams()

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

describeLogStreamsAsync()

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

describeMetricFilters()

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

describeMetricFiltersAsync()

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

describeQueries()

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

describeQueriesAsync()

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

describeQueryDefinitions()

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

describeQueryDefinitionsAsync()

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

describeResourcePolicies()

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

describeResourcePoliciesAsync()

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

describeSubscriptionFilters()

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

describeSubscriptionFiltersAsync()

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

disassociateKmsKey()

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

disassociateKmsKeyAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

filterLogEvents()

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

filterLogEventsAsync()

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

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>

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
CommandInterface

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

getDataProtectionPolicy()

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

getDataProtectionPolicyAsync()

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

getDelivery()

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

getDeliveryAsync()

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

getDeliveryDestination()

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

getDeliveryDestinationAsync()

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

getDeliveryDestinationPolicy()

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

getDeliveryDestinationPolicyAsync()

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

getDeliverySource()

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

getDeliverySourceAsync()

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

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> = []

getLogAnomalyDetector()

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

getLogAnomalyDetectorAsync()

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

getLogEvents()

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

getLogEventsAsync()

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

getLogGroupFields()

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

getLogGroupFieldsAsync()

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

getLogRecord()

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

getLogRecordAsync()

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

getPaginator()

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

getQueryResults()

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

getQueryResultsAsync()

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

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> = []

listAnomalies()

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

listAnomaliesAsync()

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

listLogAnomalyDetectors()

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

listLogAnomalyDetectorsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTagsLogGroup()

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

listTagsLogGroupAsync()

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

putAccountPolicy()

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

putAccountPolicyAsync()

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

putDataProtectionPolicy()

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

putDataProtectionPolicyAsync()

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

putDeliveryDestination()

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

putDeliveryDestinationAsync()

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

putDeliveryDestinationPolicy()

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

putDeliveryDestinationPolicyAsync()

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

putDeliverySource()

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

putDeliverySourceAsync()

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

putDestination()

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

putDestinationAsync()

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

putDestinationPolicy()

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

putDestinationPolicyAsync()

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

putLogEvents()

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

putLogEventsAsync()

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

putMetricFilter()

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

putMetricFilterAsync()

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

putQueryDefinition()

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

putQueryDefinitionAsync()

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

putResourcePolicy()

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

putResourcePolicyAsync()

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

putRetentionPolicy()

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

putRetentionPolicyAsync()

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

putSubscriptionFilter()

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

putSubscriptionFilterAsync()

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

startLiveTail()

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

startLiveTailAsync()

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

startLiveTailCheckingForResults()

Helper method for 'startLiveTail' operation that checks for results.

public startLiveTailCheckingForResults(array<string|int, mixed> $args) : Generator

Initiates 'startLiveTail' operation with given arguments, and continuously checks response stream for session updates or results, yielding each stream chunk when results are not empty. This method abstracts from users the need of checking if there are logs entry available to be watched, which means that users will always get a next item to be iterated when more log entries are available.

Parameters
$args : array<string|int, mixed>

Command arguments.

Return values
Generator —

Yields session update or result stream chunks.

startQuery()

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

startQueryAsync()

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

stopQuery()

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

stopQueryAsync()

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

tagLogGroup()

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

tagLogGroupAsync()

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

tagResource()

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

tagResourceAsync()

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

testMetricFilter()

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

testMetricFilterAsync()

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

untagLogGroup()

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

untagLogGroupAsync()

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

untagResource()

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

untagResourceAsync()

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

updateAnomaly()

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

updateAnomalyAsync()

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

updateLogAnomalyDetector()

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

updateLogAnomalyDetectorAsync()

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

waitUntil()

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