SDK for PHP 3.x

PinpointClient extends AwsClient
in package

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

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
createApp()  : Result
createAppAsync()  : Promise
createCampaign()  : Result
createCampaignAsync()  : Promise
createEmailTemplate()  : Result
createEmailTemplateAsync()  : Promise
createExportJob()  : Result
createExportJobAsync()  : Promise
createImportJob()  : Result
createImportJobAsync()  : Promise
createInAppTemplate()  : Result
createInAppTemplateAsync()  : Promise
createJourney()  : Result
createJourneyAsync()  : Promise
createPushTemplate()  : Result
createPushTemplateAsync()  : Promise
createRecommenderConfiguration()  : Result
createRecommenderConfigurationAsync()  : Promise
createSegment()  : Result
createSegmentAsync()  : Promise
createSmsTemplate()  : Result
createSmsTemplateAsync()  : Promise
createVoiceTemplate()  : Result
createVoiceTemplateAsync()  : Promise
deleteAdmChannel()  : Result
deleteAdmChannelAsync()  : Promise
deleteApnsChannel()  : Result
deleteApnsChannelAsync()  : Promise
deleteApnsSandboxChannel()  : Result
deleteApnsSandboxChannelAsync()  : Promise
deleteApnsVoipChannel()  : Result
deleteApnsVoipChannelAsync()  : Promise
deleteApnsVoipSandboxChannel()  : Result
deleteApnsVoipSandboxChannelAsync()  : Promise
deleteApp()  : Result
deleteAppAsync()  : Promise
deleteBaiduChannel()  : Result
deleteBaiduChannelAsync()  : Promise
deleteCampaign()  : Result
deleteCampaignAsync()  : Promise
deleteEmailChannel()  : Result
deleteEmailChannelAsync()  : Promise
deleteEmailTemplate()  : Result
deleteEmailTemplateAsync()  : Promise
deleteEndpoint()  : Result
deleteEndpointAsync()  : Promise
deleteEventStream()  : Result
deleteEventStreamAsync()  : Promise
deleteGcmChannel()  : Result
deleteGcmChannelAsync()  : Promise
deleteInAppTemplate()  : Result
deleteInAppTemplateAsync()  : Promise
deleteJourney()  : Result
deleteJourneyAsync()  : Promise
deletePushTemplate()  : Result
deletePushTemplateAsync()  : Promise
deleteRecommenderConfiguration()  : Result
deleteRecommenderConfigurationAsync()  : Promise
deleteSegment()  : Result
deleteSegmentAsync()  : Promise
deleteSmsChannel()  : Result
deleteSmsChannelAsync()  : Promise
deleteSmsTemplate()  : Result
deleteSmsTemplateAsync()  : Promise
deleteUserEndpoints()  : Result
deleteUserEndpointsAsync()  : Promise
deleteVoiceChannel()  : Result
deleteVoiceChannelAsync()  : Promise
deleteVoiceTemplate()  : Result
deleteVoiceTemplateAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAdmChannel()  : Result
getAdmChannelAsync()  : Promise
getApi()  : Service
getApnsChannel()  : Result
getApnsChannelAsync()  : Promise
getApnsSandboxChannel()  : Result
getApnsSandboxChannelAsync()  : Promise
getApnsVoipChannel()  : Result
getApnsVoipChannelAsync()  : Promise
getApnsVoipSandboxChannel()  : Result
getApnsVoipSandboxChannelAsync()  : Promise
getApp()  : Result
getAppAsync()  : Promise
getApplicationDateRangeKpi()  : Result
getApplicationDateRangeKpiAsync()  : Promise
getApplicationSettings()  : Result
getApplicationSettingsAsync()  : Promise
getApps()  : Result
getAppsAsync()  : Promise
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getBaiduChannel()  : Result
getBaiduChannelAsync()  : Promise
getCampaign()  : Result
getCampaignActivities()  : Result
getCampaignActivitiesAsync()  : Promise
getCampaignAsync()  : Promise
getCampaignDateRangeKpi()  : Result
getCampaignDateRangeKpiAsync()  : Promise
getCampaigns()  : Result
getCampaignsAsync()  : Promise
getCampaignVersion()  : Result
getCampaignVersionAsync()  : Promise
getCampaignVersions()  : Result
getCampaignVersionsAsync()  : Promise
getChannels()  : Result
getChannelsAsync()  : Promise
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.
getEmailChannel()  : Result
getEmailChannelAsync()  : Promise
getEmailTemplate()  : Result
getEmailTemplateAsync()  : 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.
getEventStream()  : Result
getEventStreamAsync()  : Promise
getExportJob()  : Result
getExportJobAsync()  : Promise
getExportJobs()  : Result
getExportJobsAsync()  : Promise
getGcmChannel()  : Result
getGcmChannelAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getImportJob()  : Result
getImportJobAsync()  : Promise
getImportJobs()  : Result
getImportJobsAsync()  : Promise
getInAppMessages()  : Result
getInAppMessagesAsync()  : Promise
getInAppTemplate()  : Result
getInAppTemplateAsync()  : Promise
getIterator()  : mixed
getJourney()  : Result
getJourneyAsync()  : Promise
getJourneyDateRangeKpi()  : Result
getJourneyDateRangeKpiAsync()  : Promise
getJourneyExecutionActivityMetrics()  : Result
getJourneyExecutionActivityMetricsAsync()  : Promise
getJourneyExecutionMetrics()  : Result
getJourneyExecutionMetricsAsync()  : Promise
getJourneyRunExecutionActivityMetrics()  : Result
getJourneyRunExecutionActivityMetricsAsync()  : Promise
getJourneyRunExecutionMetrics()  : Result
getJourneyRunExecutionMetricsAsync()  : Promise
getJourneyRuns()  : Result
getJourneyRunsAsync()  : Promise
getPaginator()  : mixed
getPushTemplate()  : Result
getPushTemplateAsync()  : Promise
getRecommenderConfiguration()  : Result
getRecommenderConfigurationAsync()  : Promise
getRecommenderConfigurations()  : Result
getRecommenderConfigurationsAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getSegment()  : Result
getSegmentAsync()  : Promise
getSegmentExportJobs()  : Result
getSegmentExportJobsAsync()  : Promise
getSegmentImportJobs()  : Result
getSegmentImportJobsAsync()  : Promise
getSegments()  : Result
getSegmentsAsync()  : Promise
getSegmentVersion()  : Result
getSegmentVersionAsync()  : Promise
getSegmentVersions()  : Result
getSegmentVersionsAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSmsChannel()  : Result
getSmsChannelAsync()  : Promise
getSmsTemplate()  : Result
getSmsTemplateAsync()  : Promise
getUserEndpoint()  : Result
getUserEndpointAsync()  : Promise
getUserEndpoints()  : Result
getUserEndpointsAsync()  : Promise
getVoiceChannel()  : Result
getVoiceChannelAsync()  : Promise
getVoiceTemplate()  : Result
getVoiceTemplateAsync()  : Promise
getWaiter()  : mixed
listJourneys()  : Result
listJourneysAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listTemplates()  : Result
listTemplatesAsync()  : Promise
listTemplateVersions()  : Result
listTemplateVersionsAsync()  : Promise
phoneNumberValidate()  : Result
phoneNumberValidateAsync()  : Promise
putEvents()  : Result
putEventsAsync()  : Promise
putEventStream()  : Result
putEventStreamAsync()  : Promise
removeAttributes()  : Result
removeAttributesAsync()  : Promise
sendMessages()  : Result
sendMessagesAsync()  : Promise
sendOTPMessage()  : Result
sendOTPMessageAsync()  : Promise
sendUsersMessages()  : Result
sendUsersMessagesAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAdmChannel()  : Result
updateAdmChannelAsync()  : Promise
updateApnsChannel()  : Result
updateApnsChannelAsync()  : Promise
updateApnsSandboxChannel()  : Result
updateApnsSandboxChannelAsync()  : Promise
updateApnsVoipChannel()  : Result
updateApnsVoipChannelAsync()  : Promise
updateApnsVoipSandboxChannel()  : Result
updateApnsVoipSandboxChannelAsync()  : Promise
updateApplicationSettings()  : Result
updateApplicationSettingsAsync()  : Promise
updateBaiduChannel()  : Result
updateBaiduChannelAsync()  : Promise
updateCampaign()  : Result
updateCampaignAsync()  : Promise
updateEmailChannel()  : Result
updateEmailChannelAsync()  : Promise
updateEmailTemplate()  : Result
updateEmailTemplateAsync()  : Promise
updateGcmChannel()  : Result
updateGcmChannelAsync()  : Promise
updateInAppTemplate()  : Result
updateInAppTemplateAsync()  : Promise
updateJourney()  : Result
updateJourneyAsync()  : Promise
updateJourneyState()  : Result
updateJourneyStateAsync()  : Promise
updatePushTemplate()  : Result
updatePushTemplateAsync()  : Promise
updateRecommenderConfiguration()  : Result
updateRecommenderConfigurationAsync()  : Promise
updateSegment()  : Result
updateSegmentAsync()  : Promise
updateSmsChannel()  : Result
updateSmsChannelAsync()  : Promise
updateSmsTemplate()  : Result
updateSmsTemplateAsync()  : Promise
updateTemplateActiveVersion()  : Result
updateTemplateActiveVersionAsync()  : Promise
updateUserEndpoint()  : Result
updateUserEndpointAsync()  : Promise
updateUserEndpointsBatch()  : Result
updateUserEndpointsBatchAsync()  : Promise
updateVoiceChannel()  : Result
updateVoiceChannelAsync()  : Promise
updateVoiceTemplate()  : Result
updateVoiceTemplateAsync()  : Promise
verifyOTPMessage()  : Result
verifyOTPMessageAsync()  : 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
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

createApp()

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

createAppAsync()

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

createCampaign()

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

createCampaignAsync()

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

createEmailTemplate()

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

createEmailTemplateAsync()

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

createExportJob()

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

createExportJobAsync()

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

createImportJob()

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

createImportJobAsync()

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

createInAppTemplate()

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

createInAppTemplateAsync()

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

createJourney()

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

createJourneyAsync()

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

createPushTemplate()

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

createPushTemplateAsync()

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

createRecommenderConfiguration()

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

createRecommenderConfigurationAsync()

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

createSegment()

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

createSegmentAsync()

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

createSmsTemplate()

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

createSmsTemplateAsync()

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

createVoiceTemplate()

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

createVoiceTemplateAsync()

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

deleteAdmChannel()

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

deleteAdmChannelAsync()

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

deleteApnsChannel()

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

deleteApnsChannelAsync()

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

deleteApnsSandboxChannel()

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

deleteApnsSandboxChannelAsync()

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

deleteApnsVoipChannel()

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

deleteApnsVoipChannelAsync()

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

deleteApnsVoipSandboxChannel()

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

deleteApnsVoipSandboxChannelAsync()

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

deleteApp()

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

deleteAppAsync()

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

deleteBaiduChannel()

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

deleteBaiduChannelAsync()

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

deleteCampaign()

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

deleteCampaignAsync()

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

deleteEmailChannel()

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

deleteEmailChannelAsync()

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

deleteEmailTemplate()

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

deleteEmailTemplateAsync()

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

deleteEndpoint()

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

deleteEndpointAsync()

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

deleteEventStream()

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

deleteEventStreamAsync()

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

deleteGcmChannel()

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

deleteGcmChannelAsync()

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

deleteInAppTemplate()

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

deleteInAppTemplateAsync()

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

deleteJourney()

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

deleteJourneyAsync()

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

deletePushTemplate()

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

deletePushTemplateAsync()

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

deleteRecommenderConfiguration()

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

deleteRecommenderConfigurationAsync()

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

deleteSegment()

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

deleteSegmentAsync()

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

deleteSmsChannel()

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

deleteSmsChannelAsync()

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

deleteSmsTemplate()

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

deleteSmsTemplateAsync()

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

deleteUserEndpoints()

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

deleteUserEndpointsAsync()

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

deleteVoiceChannel()

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

deleteVoiceChannelAsync()

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

deleteVoiceTemplate()

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

deleteVoiceTemplateAsync()

public deleteVoiceTemplateAsync(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

getAdmChannel()

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

getAdmChannelAsync()

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

getApnsChannel()

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

getApnsChannelAsync()

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

getApnsSandboxChannel()

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

getApnsSandboxChannelAsync()

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

getApnsVoipChannel()

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

getApnsVoipChannelAsync()

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

getApnsVoipSandboxChannel()

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

getApnsVoipSandboxChannelAsync()

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

getApp()

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

getAppAsync()

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

getApplicationDateRangeKpi()

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

getApplicationDateRangeKpiAsync()

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

getApplicationSettings()

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

getApplicationSettingsAsync()

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

getApps()

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

getAppsAsync()

public getAppsAsync(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>

getBaiduChannel()

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

getBaiduChannelAsync()

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

getCampaign()

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

getCampaignActivities()

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

getCampaignActivitiesAsync()

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

getCampaignAsync()

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

getCampaignDateRangeKpi()

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

getCampaignDateRangeKpiAsync()

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

getCampaigns()

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

getCampaignsAsync()

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

getCampaignVersion()

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

getCampaignVersionAsync()

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

getCampaignVersions()

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

getCampaignVersionsAsync()

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

getChannels()

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

getChannelsAsync()

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

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

getEmailChannel()

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

getEmailChannelAsync()

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

getEmailTemplate()

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

getEmailTemplateAsync()

public getEmailTemplateAsync(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>

getEventStream()

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

getEventStreamAsync()

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

getExportJob()

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

getExportJobAsync()

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

getExportJobs()

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

getExportJobsAsync()

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

getGcmChannel()

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

getGcmChannelAsync()

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

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

getImportJob()

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

getImportJobAsync()

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

getImportJobs()

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

getImportJobsAsync()

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

getInAppMessages()

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

getInAppMessagesAsync()

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

getInAppTemplate()

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

getInAppTemplateAsync()

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

getIterator()

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

getJourney()

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

getJourneyAsync()

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

getJourneyDateRangeKpi()

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

getJourneyDateRangeKpiAsync()

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

getJourneyExecutionActivityMetrics()

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

getJourneyExecutionActivityMetricsAsync()

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

getJourneyExecutionMetrics()

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

getJourneyExecutionMetricsAsync()

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

getJourneyRunExecutionActivityMetrics()

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

getJourneyRunExecutionActivityMetricsAsync()

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

getJourneyRunExecutionMetrics()

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

getJourneyRunExecutionMetricsAsync()

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

getJourneyRuns()

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

getJourneyRunsAsync()

public getJourneyRunsAsync(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> = []

getPushTemplate()

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

getPushTemplateAsync()

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

getRecommenderConfiguration()

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

getRecommenderConfigurationAsync()

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

getRecommenderConfigurations()

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

getRecommenderConfigurationsAsync()

public getRecommenderConfigurationsAsync(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

getSegment()

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

getSegmentAsync()

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

getSegmentExportJobs()

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

getSegmentExportJobsAsync()

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

getSegmentImportJobs()

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

getSegmentImportJobsAsync()

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

getSegments()

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

getSegmentsAsync()

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

getSegmentVersion()

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

getSegmentVersionAsync()

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

getSegmentVersions()

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

getSegmentVersionsAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getSmsChannel()

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

getSmsChannelAsync()

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

getSmsTemplate()

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

getSmsTemplateAsync()

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

getUserEndpoint()

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

getUserEndpointAsync()

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

getUserEndpoints()

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

getUserEndpointsAsync()

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

getVoiceChannel()

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

getVoiceChannelAsync()

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

getVoiceTemplate()

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

getVoiceTemplateAsync()

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

getWaiter()

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

listJourneys()

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

listJourneysAsync()

public listJourneysAsync(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

listTemplates()

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

listTemplatesAsync()

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

listTemplateVersions()

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

listTemplateVersionsAsync()

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

phoneNumberValidate()

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

phoneNumberValidateAsync()

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

putEvents()

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

putEventsAsync()

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

putEventStream()

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

putEventStreamAsync()

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

removeAttributes()

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

removeAttributesAsync()

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

sendMessages()

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

sendMessagesAsync()

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

sendOTPMessage()

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

sendOTPMessageAsync()

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

sendUsersMessages()

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

sendUsersMessagesAsync()

public sendUsersMessagesAsync(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

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

updateAdmChannel()

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

updateAdmChannelAsync()

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

updateApnsChannel()

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

updateApnsChannelAsync()

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

updateApnsSandboxChannel()

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

updateApnsSandboxChannelAsync()

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

updateApnsVoipChannel()

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

updateApnsVoipChannelAsync()

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

updateApnsVoipSandboxChannel()

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

updateApnsVoipSandboxChannelAsync()

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

updateApplicationSettings()

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

updateApplicationSettingsAsync()

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

updateBaiduChannel()

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

updateBaiduChannelAsync()

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

updateCampaign()

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

updateCampaignAsync()

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

updateEmailChannel()

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

updateEmailChannelAsync()

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

updateEmailTemplate()

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

updateEmailTemplateAsync()

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

updateGcmChannel()

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

updateGcmChannelAsync()

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

updateInAppTemplate()

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

updateInAppTemplateAsync()

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

updateJourney()

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

updateJourneyAsync()

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

updateJourneyState()

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

updateJourneyStateAsync()

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

updatePushTemplate()

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

updatePushTemplateAsync()

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

updateRecommenderConfiguration()

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

updateRecommenderConfigurationAsync()

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

updateSegment()

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

updateSegmentAsync()

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

updateSmsChannel()

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

updateSmsChannelAsync()

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

updateSmsTemplate()

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

updateSmsTemplateAsync()

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

updateTemplateActiveVersion()

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

updateTemplateActiveVersionAsync()

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

updateUserEndpoint()

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

updateUserEndpointAsync()

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

updateUserEndpointsBatch()

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

updateUserEndpointsBatchAsync()

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

updateVoiceChannel()

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

updateVoiceChannelAsync()

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

updateVoiceTemplate()

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

updateVoiceTemplateAsync()

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

verifyOTPMessage()

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

verifyOTPMessageAsync()

public verifyOTPMessageAsync(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