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.
- CreateApp
- CreateCampaign
- CreateEmailTemplate
- CreateExportJob
- CreateImportJob
- CreateInAppTemplate
- CreateJourney
- CreatePushTemplate
- CreateRecommenderConfiguration
- CreateSegment
- CreateSmsTemplate
- CreateVoiceTemplate
- DeleteAdmChannel
- DeleteApnsChannel
- DeleteApnsSandboxChannel
- DeleteApnsVoipChannel
- DeleteApnsVoipSandboxChannel
- DeleteApp
- DeleteBaiduChannel
- DeleteCampaign
- DeleteEmailChannel
- DeleteEmailTemplate
- DeleteEndpoint
- DeleteEventStream
- DeleteGcmChannel
- DeleteInAppTemplate
- DeleteJourney
- DeletePushTemplate
- DeleteRecommenderConfiguration
- DeleteSegment
- DeleteSmsChannel
- DeleteSmsTemplate
- DeleteUserEndpoints
- DeleteVoiceChannel
- DeleteVoiceTemplate
- GetAdmChannel
- GetApnsChannel
- GetApnsSandboxChannel
- GetApnsVoipChannel
- GetApnsVoipSandboxChannel
- GetApp
- GetApplicationDateRangeKpi
- GetApplicationSettings
- GetApps
- GetBaiduChannel
- GetCampaign
- GetCampaignActivities
- GetCampaignDateRangeKpi
- GetCampaignVersion
- GetCampaignVersions
- GetCampaigns
- GetChannels
- GetEmailChannel
- GetEmailTemplate
- GetEventStream
- GetExportJob
- GetExportJobs
- GetGcmChannel
- GetImportJob
- GetImportJobs
- GetInAppMessages
- GetInAppTemplate
- GetJourney
- GetJourneyDateRangeKpi
- GetJourneyExecutionActivityMetrics
- GetJourneyExecutionMetrics
- GetJourneyRunExecutionActivityMetrics
- GetJourneyRunExecutionMetrics
- GetJourneyRuns
- GetPushTemplate
- GetRecommenderConfiguration
- GetRecommenderConfigurations
- GetSegment
- GetSegmentExportJobs
- GetSegmentImportJobs
- GetSegmentVersion
- GetSegmentVersions
- GetSegments
- GetSmsChannel
- GetSmsTemplate
- GetUserEndpoint
- GetUserEndpoints
- GetVoiceChannel
- GetVoiceTemplate
- ListJourneys
- ListTagsForResource
- ListTemplateVersions
- ListTemplates
- PhoneNumberValidate
- PutEventStream
- PutEvents
- RemoveAttributes
- SendMessages
- SendOTPMessage
- SendUsersMessages
- TagResource
- UntagResource
- UpdateAdmChannel
- UpdateApnsChannel
- UpdateApnsSandboxChannel
- UpdateApnsVoipChannel
- UpdateApnsVoipSandboxChannel
- UpdateApplicationSettings
- UpdateBaiduChannel
- UpdateCampaign
- UpdateEmailChannel
- UpdateEmailTemplate
- UpdateGcmChannel
- UpdateInAppTemplate
- UpdateJourney
- UpdateJourneyState
- UpdatePushTemplate
- UpdateRecommenderConfiguration
- UpdateSegment
- UpdateSmsChannel
- UpdateSmsTemplate
- UpdateTemplateActiveVersion
- UpdateUserEndpoint
- UpdateUserEndpointsBatch
- UpdateVoiceChannel
- UpdateVoiceTemplate
- VerifyOTPMessage
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
__sleep()
public
__sleep() : mixed
createApp()
public
createApp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAppAsync()
public
createAppAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCampaign()
public
createCampaign(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCampaignAsync()
public
createCampaignAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateEmailTemplate()
public
createEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateEmailTemplateAsync()
public
createEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateExportJob()
public
createExportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateExportJobAsync()
public
createExportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateImportJob()
public
createImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateImportJobAsync()
public
createImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateInAppTemplate()
public
createInAppTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInAppTemplateAsync()
public
createInAppTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateJourney()
public
createJourney(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateJourneyAsync()
public
createJourneyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePushTemplate()
public
createPushTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreatePushTemplateAsync()
public
createPushTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRecommenderConfiguration()
public
createRecommenderConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRecommenderConfigurationAsync()
public
createRecommenderConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSegment()
public
createSegment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSegmentAsync()
public
createSegmentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSmsTemplate()
public
createSmsTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSmsTemplateAsync()
public
createSmsTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateVoiceTemplate()
public
createVoiceTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateVoiceTemplateAsync()
public
createVoiceTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAdmChannel()
public
deleteAdmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAdmChannelAsync()
public
deleteAdmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteApnsChannel()
public
deleteApnsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteApnsChannelAsync()
public
deleteApnsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteApnsSandboxChannel()
public
deleteApnsSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteApnsSandboxChannelAsync()
public
deleteApnsSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteApnsVoipChannel()
public
deleteApnsVoipChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteApnsVoipChannelAsync()
public
deleteApnsVoipChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteApnsVoipSandboxChannel()
public
deleteApnsVoipSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteApnsVoipSandboxChannelAsync()
public
deleteApnsVoipSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteApp()
public
deleteApp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAppAsync()
public
deleteAppAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBaiduChannel()
public
deleteBaiduChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBaiduChannelAsync()
public
deleteBaiduChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCampaign()
public
deleteCampaign(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCampaignAsync()
public
deleteCampaignAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteEmailChannel()
public
deleteEmailChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteEmailChannelAsync()
public
deleteEmailChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteEmailTemplate()
public
deleteEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteEmailTemplateAsync()
public
deleteEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteEndpoint()
public
deleteEndpoint(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteEndpointAsync()
public
deleteEndpointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteEventStream()
public
deleteEventStream(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteEventStreamAsync()
public
deleteEventStreamAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteGcmChannel()
public
deleteGcmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteGcmChannelAsync()
public
deleteGcmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteInAppTemplate()
public
deleteInAppTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteInAppTemplateAsync()
public
deleteInAppTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteJourney()
public
deleteJourney(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteJourneyAsync()
public
deleteJourneyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePushTemplate()
public
deletePushTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePushTemplateAsync()
public
deletePushTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRecommenderConfiguration()
public
deleteRecommenderConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRecommenderConfigurationAsync()
public
deleteRecommenderConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSegment()
public
deleteSegment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSegmentAsync()
public
deleteSegmentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSmsChannel()
public
deleteSmsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSmsChannelAsync()
public
deleteSmsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSmsTemplate()
public
deleteSmsTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSmsTemplateAsync()
public
deleteSmsTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteUserEndpoints()
public
deleteUserEndpoints(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteUserEndpointsAsync()
public
deleteUserEndpointsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVoiceChannel()
public
deleteVoiceChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVoiceChannelAsync()
public
deleteVoiceChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVoiceTemplate()
public
deleteVoiceTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVoiceTemplateAsync()
public
deleteVoiceTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetAdmChannel()
public
getAdmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAdmChannelAsync()
public
getAdmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetApnsChannel()
public
getApnsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApnsChannelAsync()
public
getApnsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApnsSandboxChannel()
public
getApnsSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApnsSandboxChannelAsync()
public
getApnsSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApnsVoipChannel()
public
getApnsVoipChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApnsVoipChannelAsync()
public
getApnsVoipChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApnsVoipSandboxChannel()
public
getApnsVoipSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApnsVoipSandboxChannelAsync()
public
getApnsVoipSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApp()
public
getApp(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAppAsync()
public
getAppAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApplicationDateRangeKpi()
public
getApplicationDateRangeKpi(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApplicationDateRangeKpiAsync()
public
getApplicationDateRangeKpiAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApplicationSettings()
public
getApplicationSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetApplicationSettingsAsync()
public
getApplicationSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApps()
public
getApps(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAppsAsync()
public
getAppsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>getBaiduChannel()
public
getBaiduChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBaiduChannelAsync()
public
getBaiduChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaign()
public
getCampaign(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignActivities()
public
getCampaignActivities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignActivitiesAsync()
public
getCampaignActivitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaignAsync()
public
getCampaignAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaignDateRangeKpi()
public
getCampaignDateRangeKpi(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignDateRangeKpiAsync()
public
getCampaignDateRangeKpiAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaigns()
public
getCampaigns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignsAsync()
public
getCampaignsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaignVersion()
public
getCampaignVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignVersionAsync()
public
getCampaignVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCampaignVersions()
public
getCampaignVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCampaignVersionsAsync()
public
getCampaignVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetChannels()
public
getChannels(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetChannelsAsync()
public
getChannelsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetClientBuiltIns()
Provides the set of built-in keys and values used for endpoint resolution
public
getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientContextParams()
Provides the set of service context parameter key-value pairs used for endpoint resolution.
public
getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterfacegetConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|nullgetCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterfacegetEmailChannel()
public
getEmailChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetEmailChannelAsync()
public
getEmailChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEmailTemplate()
public
getEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetEmailTemplateAsync()
public
getEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
public
getEndpointProvider() : mixed
getEndpointProviderArgs()
Retrieves arguments to be used in endpoint resolution.
public
getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>getEventStream()
public
getEventStream(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetEventStreamAsync()
public
getEventStreamAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetExportJob()
public
getExportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetExportJobAsync()
public
getExportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetExportJobs()
public
getExportJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetExportJobsAsync()
public
getExportJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetGcmChannel()
public
getGcmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetGcmChannelAsync()
public
getGcmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerListgetImportJob()
public
getImportJob(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImportJobAsync()
public
getImportJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetImportJobs()
public
getImportJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetImportJobsAsync()
public
getImportJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetInAppMessages()
public
getInAppMessages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInAppMessagesAsync()
public
getInAppMessagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetInAppTemplate()
public
getInAppTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInAppTemplateAsync()
public
getInAppTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
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
ResultgetJourneyAsync()
public
getJourneyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyDateRangeKpi()
public
getJourneyDateRangeKpi(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyDateRangeKpiAsync()
public
getJourneyDateRangeKpiAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyExecutionActivityMetrics()
public
getJourneyExecutionActivityMetrics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyExecutionActivityMetricsAsync()
public
getJourneyExecutionActivityMetricsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyExecutionMetrics()
public
getJourneyExecutionMetrics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyExecutionMetricsAsync()
public
getJourneyExecutionMetricsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyRunExecutionActivityMetrics()
public
getJourneyRunExecutionActivityMetrics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyRunExecutionActivityMetricsAsync()
public
getJourneyRunExecutionActivityMetricsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyRunExecutionMetrics()
public
getJourneyRunExecutionMetrics(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyRunExecutionMetricsAsync()
public
getJourneyRunExecutionMetricsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetJourneyRuns()
public
getJourneyRuns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetJourneyRunsAsync()
public
getJourneyRunsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPushTemplate()
public
getPushTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPushTemplateAsync()
public
getPushTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRecommenderConfiguration()
public
getRecommenderConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRecommenderConfigurationAsync()
public
getRecommenderConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRecommenderConfigurations()
public
getRecommenderConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRecommenderConfigurationsAsync()
public
getRecommenderConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSegment()
public
getSegment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentAsync()
public
getSegmentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSegmentExportJobs()
public
getSegmentExportJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentExportJobsAsync()
public
getSegmentExportJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSegmentImportJobs()
public
getSegmentImportJobs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentImportJobsAsync()
public
getSegmentImportJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSegments()
public
getSegments(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentsAsync()
public
getSegmentsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSegmentVersion()
public
getSegmentVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentVersionAsync()
public
getSegmentVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSegmentVersions()
public
getSegmentVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSegmentVersionsAsync()
public
getSegmentVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSmsChannel()
public
getSmsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSmsChannelAsync()
public
getSmsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSmsTemplate()
public
getSmsTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSmsTemplateAsync()
public
getSmsTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUserEndpoint()
public
getUserEndpoint(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserEndpointAsync()
public
getUserEndpointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetUserEndpoints()
public
getUserEndpoints(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetUserEndpointsAsync()
public
getUserEndpointsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetVoiceChannel()
public
getVoiceChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetVoiceChannelAsync()
public
getVoiceChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetVoiceTemplate()
public
getVoiceTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetVoiceTemplateAsync()
public
getVoiceTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
listJourneys()
public
listJourneys(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistJourneysAsync()
public
listJourneysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTemplates()
public
listTemplates(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTemplatesAsync()
public
listTemplatesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTemplateVersions()
public
listTemplateVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTemplateVersionsAsync()
public
listTemplateVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisephoneNumberValidate()
public
phoneNumberValidate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultphoneNumberValidateAsync()
public
phoneNumberValidateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputEvents()
public
putEvents(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputEventsAsync()
public
putEventsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputEventStream()
public
putEventStream(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputEventStreamAsync()
public
putEventStreamAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseremoveAttributes()
public
removeAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultremoveAttributesAsync()
public
removeAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendMessages()
public
sendMessages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendMessagesAsync()
public
sendMessagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendOTPMessage()
public
sendOTPMessage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendOTPMessageAsync()
public
sendOTPMessageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesendUsersMessages()
public
sendUsersMessages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsendUsersMessagesAsync()
public
sendUsersMessagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAdmChannel()
public
updateAdmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAdmChannelAsync()
public
updateAdmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateApnsChannel()
public
updateApnsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateApnsChannelAsync()
public
updateApnsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateApnsSandboxChannel()
public
updateApnsSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateApnsSandboxChannelAsync()
public
updateApnsSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateApnsVoipChannel()
public
updateApnsVoipChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateApnsVoipChannelAsync()
public
updateApnsVoipChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateApnsVoipSandboxChannel()
public
updateApnsVoipSandboxChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateApnsVoipSandboxChannelAsync()
public
updateApnsVoipSandboxChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateApplicationSettings()
public
updateApplicationSettings(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateApplicationSettingsAsync()
public
updateApplicationSettingsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateBaiduChannel()
public
updateBaiduChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateBaiduChannelAsync()
public
updateBaiduChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateCampaign()
public
updateCampaign(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCampaignAsync()
public
updateCampaignAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateEmailChannel()
public
updateEmailChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateEmailChannelAsync()
public
updateEmailChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateEmailTemplate()
public
updateEmailTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateEmailTemplateAsync()
public
updateEmailTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateGcmChannel()
public
updateGcmChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateGcmChannelAsync()
public
updateGcmChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateInAppTemplate()
public
updateInAppTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateInAppTemplateAsync()
public
updateInAppTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateJourney()
public
updateJourney(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateJourneyAsync()
public
updateJourneyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateJourneyState()
public
updateJourneyState(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateJourneyStateAsync()
public
updateJourneyStateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePushTemplate()
public
updatePushTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdatePushTemplateAsync()
public
updatePushTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRecommenderConfiguration()
public
updateRecommenderConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRecommenderConfigurationAsync()
public
updateRecommenderConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSegment()
public
updateSegment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSegmentAsync()
public
updateSegmentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSmsChannel()
public
updateSmsChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSmsChannelAsync()
public
updateSmsChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSmsTemplate()
public
updateSmsTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSmsTemplateAsync()
public
updateSmsTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTemplateActiveVersion()
public
updateTemplateActiveVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTemplateActiveVersionAsync()
public
updateTemplateActiveVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserEndpoint()
public
updateUserEndpoint(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserEndpointAsync()
public
updateUserEndpointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateUserEndpointsBatch()
public
updateUserEndpointsBatch(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateUserEndpointsBatchAsync()
public
updateUserEndpointsBatchAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateVoiceChannel()
public
updateVoiceChannel(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateVoiceChannelAsync()
public
updateVoiceChannelAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateVoiceTemplate()
public
updateVoiceTemplate(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateVoiceTemplateAsync()
public
updateVoiceTemplateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseverifyOTPMessage()
public
verifyOTPMessage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultverifyOTPMessageAsync()
public
verifyOTPMessageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []