AWSPinpointTargeting
Objective-C
@interface AWSPinpointTargeting
Swift
class AWSPinpointTargeting
Doc Engage API - Amazon Pinpoint API
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *_Nonnull configuration;
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let PinpointTargeting = AWSPinpointTargeting.default()
Objective-C
AWSPinpointTargeting *PinpointTargeting = [AWSPinpointTargeting defaultPinpointTargeting];
Declaration
Objective-C
+ (nonnull instancetype)defaultPinpointTargeting;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSPinpointTargeting.register(with: configuration!, forKey: "USWest2PinpointTargeting") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSPinpointTargeting registerPinpointTargetingWithConfiguration:configuration forKey:@"USWest2PinpointTargeting"]; return YES; }
Then call the following to get the service client:
Swift
let PinpointTargeting = AWSPinpointTargeting(forKey: "USWest2PinpointTargeting")
Objective-C
AWSPinpointTargeting *PinpointTargeting = [AWSPinpointTargeting PinpointTargetingForKey:@"USWest2PinpointTargeting"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerPinpointTargetingWithConfiguration: (nonnull AWSServiceConfiguration *)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerPinpointTargetingWithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSPinpointTargeting.register(with: configuration!, forKey: "USWest2PinpointTargeting") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSPinpointTargeting registerPinpointTargetingWithConfiguration:configuration forKey:@"USWest2PinpointTargeting"]; return YES; }
Then call the following to get the service client:
Swift
let PinpointTargeting = AWSPinpointTargeting(forKey: "USWest2PinpointTargeting")
Objective-C
AWSPinpointTargeting *PinpointTargeting = [AWSPinpointTargeting PinpointTargetingForKey:@"USWest2PinpointTargeting"];
Declaration
Objective-C
+ (nonnull instancetype)PinpointTargetingForKey:(nonnull NSString *)key;
Swift
convenience init(forKey key: String)
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removePinpointTargetingForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
Creates an application.
See
AWSPinpointTargetingCreateAppRequest
See
AWSPinpointTargetingCreateAppResponse
Declaration
Objective-C
- (nonnull AWSTask *)createApp: (nonnull AWSPinpointTargetingCreateAppRequest *)request;
Swift
func createApp(_ request: AWSPinpointTargetingCreateAppRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateApp service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateAppResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates an application.
See
AWSPinpointTargetingCreateAppRequest
See
AWSPinpointTargetingCreateAppResponse
Declaration
Objective-C
- (void)createApp:(nonnull AWSPinpointTargetingCreateAppRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingCreateAppResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createApp(_ request: AWSPinpointTargetingCreateAppRequest) async throws -> AWSPinpointTargetingCreateAppResponse
Parameters
request
A container for the necessary parameters to execute the CreateApp service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
See
AWSPinpointTargetingCreateCampaignRequest
See
AWSPinpointTargetingCreateCampaignResponse
Declaration
Objective-C
- (nonnull AWSTask *)createCampaign: (nonnull AWSPinpointTargetingCreateCampaignRequest *)request;
Swift
func createCampaign(_ request: AWSPinpointTargetingCreateCampaignRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCampaign service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateCampaignResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new campaign for an application or updates the settings of an existing campaign for an application.
See
AWSPinpointTargetingCreateCampaignRequest
See
AWSPinpointTargetingCreateCampaignResponse
Declaration
Objective-C
- (void)createCampaign: (nonnull AWSPinpointTargetingCreateCampaignRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateCampaignResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCampaign(_ request: AWSPinpointTargetingCreateCampaignRequest) async throws -> AWSPinpointTargetingCreateCampaignResponse
Parameters
request
A container for the necessary parameters to execute the CreateCampaign service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a message template for messages that are sent through the email channel.
See
AWSPinpointTargetingCreateEmailTemplateRequest
See
AWSPinpointTargetingCreateEmailTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)createEmailTemplate: (nonnull AWSPinpointTargetingCreateEmailTemplateRequest *)request;
Swift
func createEmailTemplate(_ request: AWSPinpointTargetingCreateEmailTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateEmailTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateEmailTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a message template for messages that are sent through the email channel.
See
AWSPinpointTargetingCreateEmailTemplateRequest
See
AWSPinpointTargetingCreateEmailTemplateResponse
Declaration
Objective-C
- (void)createEmailTemplate: (nonnull AWSPinpointTargetingCreateEmailTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateEmailTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createEmailTemplate(_ request: AWSPinpointTargetingCreateEmailTemplateRequest) async throws -> AWSPinpointTargetingCreateEmailTemplateResponse
Parameters
request
A container for the necessary parameters to execute the CreateEmailTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates an export job for an application.
See
AWSPinpointTargetingCreateExportJobRequest
See
AWSPinpointTargetingCreateExportJobResponse
Declaration
Objective-C
- (nonnull AWSTask *)createExportJob: (nonnull AWSPinpointTargetingCreateExportJobRequest *)request;
Swift
func createExportJob(_ request: AWSPinpointTargetingCreateExportJobRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateExportJob service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateExportJobResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates an export job for an application.
See
AWSPinpointTargetingCreateExportJobRequest
See
AWSPinpointTargetingCreateExportJobResponse
Declaration
Objective-C
- (void)createExportJob: (nonnull AWSPinpointTargetingCreateExportJobRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateExportJobResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createExportJob(_ request: AWSPinpointTargetingCreateExportJobRequest) async throws -> AWSPinpointTargetingCreateExportJobResponse
Parameters
request
A container for the necessary parameters to execute the CreateExportJob service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates an import job for an application.
See
AWSPinpointTargetingCreateImportJobRequest
See
AWSPinpointTargetingCreateImportJobResponse
Declaration
Objective-C
- (nonnull AWSTask *)createImportJob: (nonnull AWSPinpointTargetingCreateImportJobRequest *)request;
Swift
func createImportJob(_ request: AWSPinpointTargetingCreateImportJobRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateImportJob service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateImportJobResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates an import job for an application.
See
AWSPinpointTargetingCreateImportJobRequest
See
AWSPinpointTargetingCreateImportJobResponse
Declaration
Objective-C
- (void)createImportJob: (nonnull AWSPinpointTargetingCreateImportJobRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateImportJobResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createImportJob(_ request: AWSPinpointTargetingCreateImportJobRequest) async throws -> AWSPinpointTargetingCreateImportJobResponse
Parameters
request
A container for the necessary parameters to execute the CreateImportJob service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new message template for messages using the in-app message channel.
See
AWSPinpointTargetingCreateInAppTemplateRequest
See
AWSPinpointTargetingCreateInAppTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)createInAppTemplate: (nonnull AWSPinpointTargetingCreateInAppTemplateRequest *)request;
Swift
func create(inAppTemplate request: AWSPinpointTargetingCreateInAppTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateInAppTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateInAppTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a new message template for messages using the in-app message channel.
See
AWSPinpointTargetingCreateInAppTemplateRequest
See
AWSPinpointTargetingCreateInAppTemplateResponse
Declaration
Objective-C
- (void)createInAppTemplate: (nonnull AWSPinpointTargetingCreateInAppTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateInAppTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func create(inAppTemplate request: AWSPinpointTargetingCreateInAppTemplateRequest) async throws -> AWSPinpointTargetingCreateInAppTemplateResponse
Parameters
request
A container for the necessary parameters to execute the CreateInAppTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a journey for an application.
See
AWSPinpointTargetingCreateJourneyRequest
See
AWSPinpointTargetingCreateJourneyResponse
Declaration
Objective-C
- (nonnull AWSTask *)createJourney: (nonnull AWSPinpointTargetingCreateJourneyRequest *)request;
Swift
func createJourney(_ request: AWSPinpointTargetingCreateJourneyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateJourney service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateJourneyResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a journey for an application.
See
AWSPinpointTargetingCreateJourneyRequest
See
AWSPinpointTargetingCreateJourneyResponse
Declaration
Objective-C
- (void)createJourney: (nonnull AWSPinpointTargetingCreateJourneyRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingCreateJourneyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createJourney(_ request: AWSPinpointTargetingCreateJourneyRequest) async throws -> AWSPinpointTargetingCreateJourneyResponse
Parameters
request
A container for the necessary parameters to execute the CreateJourney service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a message template for messages that are sent through a push notification channel.
See
AWSPinpointTargetingCreatePushTemplateRequest
See
AWSPinpointTargetingCreatePushTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)createPushTemplate: (nonnull AWSPinpointTargetingCreatePushTemplateRequest *)request;
Swift
func createPushTemplate(_ request: AWSPinpointTargetingCreatePushTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreatePushTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreatePushTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a message template for messages that are sent through a push notification channel.
See
AWSPinpointTargetingCreatePushTemplateRequest
See
AWSPinpointTargetingCreatePushTemplateResponse
Declaration
Objective-C
- (void)createPushTemplate: (nonnull AWSPinpointTargetingCreatePushTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreatePushTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createPushTemplate(_ request: AWSPinpointTargetingCreatePushTemplateRequest) async throws -> AWSPinpointTargetingCreatePushTemplateResponse
Parameters
request
A container for the necessary parameters to execute the CreatePushTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingCreateRecommenderConfigurationRequest
See
AWSPinpointTargetingCreateRecommenderConfigurationResponse
Declaration
Objective-C
- (nonnull AWSTask *)createRecommenderConfiguration: (nonnull AWSPinpointTargetingCreateRecommenderConfigurationRequest *) request;
Swift
func createRecommenderConfiguration(_ request: AWSPinpointTargetingCreateRecommenderConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateRecommenderConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateRecommenderConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingCreateRecommenderConfigurationRequest
See
AWSPinpointTargetingCreateRecommenderConfigurationResponse
Declaration
Objective-C
- (void) createRecommenderConfiguration: (nonnull AWSPinpointTargetingCreateRecommenderConfigurationRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateRecommenderConfigurationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createRecommenderConfiguration(_ request: AWSPinpointTargetingCreateRecommenderConfigurationRequest) async throws -> AWSPinpointTargetingCreateRecommenderConfigurationResponse
Parameters
request
A container for the necessary parameters to execute the CreateRecommenderConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that’s associated with an application.
See
AWSPinpointTargetingCreateSegmentRequest
See
AWSPinpointTargetingCreateSegmentResponse
Declaration
Objective-C
- (nonnull AWSTask *)createSegment: (nonnull AWSPinpointTargetingCreateSegmentRequest *)request;
Swift
func createSegment(_ request: AWSPinpointTargetingCreateSegmentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateSegment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateSegmentResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that’s associated with an application.
See
AWSPinpointTargetingCreateSegmentRequest
See
AWSPinpointTargetingCreateSegmentResponse
Declaration
Objective-C
- (void)createSegment: (nonnull AWSPinpointTargetingCreateSegmentRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingCreateSegmentResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createSegment(_ request: AWSPinpointTargetingCreateSegmentRequest) async throws -> AWSPinpointTargetingCreateSegmentResponse
Parameters
request
A container for the necessary parameters to execute the CreateSegment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a message template for messages that are sent through the SMS channel.
See
AWSPinpointTargetingCreateSmsTemplateRequest
See
AWSPinpointTargetingCreateSmsTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)createSmsTemplate: (nonnull AWSPinpointTargetingCreateSmsTemplateRequest *)request;
Swift
func createSmsTemplate(_ request: AWSPinpointTargetingCreateSmsTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateSmsTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateSmsTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a message template for messages that are sent through the SMS channel.
See
AWSPinpointTargetingCreateSmsTemplateRequest
See
AWSPinpointTargetingCreateSmsTemplateResponse
Declaration
Objective-C
- (void)createSmsTemplate: (nonnull AWSPinpointTargetingCreateSmsTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateSmsTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createSmsTemplate(_ request: AWSPinpointTargetingCreateSmsTemplateRequest) async throws -> AWSPinpointTargetingCreateSmsTemplateResponse
Parameters
request
A container for the necessary parameters to execute the CreateSmsTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a message template for messages that are sent through the voice channel.
See
AWSPinpointTargetingCreateVoiceTemplateRequest
See
AWSPinpointTargetingCreateVoiceTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)createVoiceTemplate: (nonnull AWSPinpointTargetingCreateVoiceTemplateRequest *)request;
Swift
func createVoiceTemplate(_ request: AWSPinpointTargetingCreateVoiceTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateVoiceTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingCreateVoiceTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Creates a message template for messages that are sent through the voice channel.
See
AWSPinpointTargetingCreateVoiceTemplateRequest
See
AWSPinpointTargetingCreateVoiceTemplateResponse
Declaration
Objective-C
- (void)createVoiceTemplate: (nonnull AWSPinpointTargetingCreateVoiceTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingCreateVoiceTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createVoiceTemplate(_ request: AWSPinpointTargetingCreateVoiceTemplateRequest) async throws -> AWSPinpointTargetingCreateVoiceTemplateResponse
Parameters
request
A container for the necessary parameters to execute the CreateVoiceTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Disables the ADM channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteAdmChannelRequest
See
AWSPinpointTargetingDeleteAdmChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteAdmChannel: (nonnull AWSPinpointTargetingDeleteAdmChannelRequest *)request;
Swift
func deleteAdmChannel(_ request: AWSPinpointTargetingDeleteAdmChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteAdmChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteAdmChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the ADM channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteAdmChannelRequest
See
AWSPinpointTargetingDeleteAdmChannelResponse
Declaration
Objective-C
- (void)deleteAdmChannel: (nonnull AWSPinpointTargetingDeleteAdmChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteAdmChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteAdmChannel(_ request: AWSPinpointTargetingDeleteAdmChannelRequest) async throws -> AWSPinpointTargetingDeleteAdmChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteAdmChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsChannelRequest
See
AWSPinpointTargetingDeleteApnsChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteApnsChannel: (nonnull AWSPinpointTargetingDeleteApnsChannelRequest *)request;
Swift
func deleteApnsChannel(_ request: AWSPinpointTargetingDeleteApnsChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteApnsChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteApnsChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsChannelRequest
See
AWSPinpointTargetingDeleteApnsChannelResponse
Declaration
Objective-C
- (void)deleteApnsChannel: (nonnull AWSPinpointTargetingDeleteApnsChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteApnsChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteApnsChannel(_ request: AWSPinpointTargetingDeleteApnsChannelRequest) async throws -> AWSPinpointTargetingDeleteApnsChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteApnsChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsSandboxChannelRequest
See
AWSPinpointTargetingDeleteApnsSandboxChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteApnsSandboxChannel: (nonnull AWSPinpointTargetingDeleteApnsSandboxChannelRequest *)request;
Swift
func deleteApnsSandboxChannel(_ request: AWSPinpointTargetingDeleteApnsSandboxChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteApnsSandboxChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteApnsSandboxChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsSandboxChannelRequest
See
AWSPinpointTargetingDeleteApnsSandboxChannelResponse
Declaration
Objective-C
- (void)deleteApnsSandboxChannel: (nonnull AWSPinpointTargetingDeleteApnsSandboxChannelRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteApnsSandboxChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteApnsSandboxChannel(_ request: AWSPinpointTargetingDeleteApnsSandboxChannelRequest) async throws -> AWSPinpointTargetingDeleteApnsSandboxChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteApnsSandboxChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsVoipChannelRequest
See
AWSPinpointTargetingDeleteApnsVoipChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteApnsVoipChannel: (nonnull AWSPinpointTargetingDeleteApnsVoipChannelRequest *)request;
Swift
func deleteApnsVoipChannel(_ request: AWSPinpointTargetingDeleteApnsVoipChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteApnsVoipChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteApnsVoipChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsVoipChannelRequest
See
AWSPinpointTargetingDeleteApnsVoipChannelResponse
Declaration
Objective-C
- (void) deleteApnsVoipChannel: (nonnull AWSPinpointTargetingDeleteApnsVoipChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteApnsVoipChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteApnsVoipChannel(_ request: AWSPinpointTargetingDeleteApnsVoipChannelRequest) async throws -> AWSPinpointTargetingDeleteApnsVoipChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteApnsVoipChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest
See
AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteApnsVoipSandboxChannel: (nonnull AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest *)request;
Swift
func deleteApnsVoipSandboxChannel(_ request: AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteApnsVoipSandboxChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest
See
AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse
Declaration
Objective-C
- (void) deleteApnsVoipSandboxChannel: (nonnull AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteApnsVoipSandboxChannel(_ request: AWSPinpointTargetingDeleteApnsVoipSandboxChannelRequest) async throws -> AWSPinpointTargetingDeleteApnsVoipSandboxChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteApnsVoipSandboxChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an application.
See
AWSPinpointTargetingDeleteAppRequest
See
AWSPinpointTargetingDeleteAppResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteApp: (nonnull AWSPinpointTargetingDeleteAppRequest *)request;
Swift
func deleteApp(_ request: AWSPinpointTargetingDeleteAppRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteApp service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteAppResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an application.
See
AWSPinpointTargetingDeleteAppRequest
See
AWSPinpointTargetingDeleteAppResponse
Declaration
Objective-C
- (void)deleteApp:(nonnull AWSPinpointTargetingDeleteAppRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingDeleteAppResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteApp(_ request: AWSPinpointTargetingDeleteAppRequest) async throws -> AWSPinpointTargetingDeleteAppResponse
Parameters
request
A container for the necessary parameters to execute the DeleteApp service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the Baidu channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteBaiduChannelRequest
See
AWSPinpointTargetingDeleteBaiduChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteBaiduChannel: (nonnull AWSPinpointTargetingDeleteBaiduChannelRequest *)request;
Swift
func deleteBaiduChannel(_ request: AWSPinpointTargetingDeleteBaiduChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteBaiduChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteBaiduChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the Baidu channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteBaiduChannelRequest
See
AWSPinpointTargetingDeleteBaiduChannelResponse
Declaration
Objective-C
- (void)deleteBaiduChannel: (nonnull AWSPinpointTargetingDeleteBaiduChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteBaiduChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteBaiduChannel(_ request: AWSPinpointTargetingDeleteBaiduChannelRequest) async throws -> AWSPinpointTargetingDeleteBaiduChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteBaiduChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a campaign from an application.
See
AWSPinpointTargetingDeleteCampaignRequest
See
AWSPinpointTargetingDeleteCampaignResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteCampaign: (nonnull AWSPinpointTargetingDeleteCampaignRequest *)request;
Swift
func deleteCampaign(_ request: AWSPinpointTargetingDeleteCampaignRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteCampaign service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteCampaignResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a campaign from an application.
See
AWSPinpointTargetingDeleteCampaignRequest
See
AWSPinpointTargetingDeleteCampaignResponse
Declaration
Objective-C
- (void)deleteCampaign: (nonnull AWSPinpointTargetingDeleteCampaignRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteCampaignResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteCampaign(_ request: AWSPinpointTargetingDeleteCampaignRequest) async throws -> AWSPinpointTargetingDeleteCampaignResponse
Parameters
request
A container for the necessary parameters to execute the DeleteCampaign service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the email channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteEmailChannelRequest
See
AWSPinpointTargetingDeleteEmailChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteEmailChannel: (nonnull AWSPinpointTargetingDeleteEmailChannelRequest *)request;
Swift
func deleteEmailChannel(_ request: AWSPinpointTargetingDeleteEmailChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteEmailChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteEmailChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the email channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteEmailChannelRequest
See
AWSPinpointTargetingDeleteEmailChannelResponse
Declaration
Objective-C
- (void)deleteEmailChannel: (nonnull AWSPinpointTargetingDeleteEmailChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteEmailChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteEmailChannel(_ request: AWSPinpointTargetingDeleteEmailChannelRequest) async throws -> AWSPinpointTargetingDeleteEmailChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteEmailChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the email channel.
See
AWSPinpointTargetingDeleteEmailTemplateRequest
See
AWSPinpointTargetingDeleteEmailTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteEmailTemplate: (nonnull AWSPinpointTargetingDeleteEmailTemplateRequest *)request;
Swift
func deleteEmailTemplate(_ request: AWSPinpointTargetingDeleteEmailTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteEmailTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteEmailTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the email channel.
See
AWSPinpointTargetingDeleteEmailTemplateRequest
See
AWSPinpointTargetingDeleteEmailTemplateResponse
Declaration
Objective-C
- (void)deleteEmailTemplate: (nonnull AWSPinpointTargetingDeleteEmailTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteEmailTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteEmailTemplate(_ request: AWSPinpointTargetingDeleteEmailTemplateRequest) async throws -> AWSPinpointTargetingDeleteEmailTemplateResponse
Parameters
request
A container for the necessary parameters to execute the DeleteEmailTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an endpoint from an application.
See
AWSPinpointTargetingDeleteEndpointRequest
See
AWSPinpointTargetingDeleteEndpointResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteEndpoint: (nonnull AWSPinpointTargetingDeleteEndpointRequest *)request;
Swift
func deleteEndpoint(_ request: AWSPinpointTargetingDeleteEndpointRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteEndpoint service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteEndpointResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an endpoint from an application.
See
AWSPinpointTargetingDeleteEndpointRequest
See
AWSPinpointTargetingDeleteEndpointResponse
Declaration
Objective-C
- (void)deleteEndpoint: (nonnull AWSPinpointTargetingDeleteEndpointRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteEndpointResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteEndpoint(_ request: AWSPinpointTargetingDeleteEndpointRequest) async throws -> AWSPinpointTargetingDeleteEndpointResponse
Parameters
request
A container for the necessary parameters to execute the DeleteEndpoint service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes the event stream for an application.
See
AWSPinpointTargetingDeleteEventStreamRequest
See
AWSPinpointTargetingDeleteEventStreamResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteEventStream: (nonnull AWSPinpointTargetingDeleteEventStreamRequest *)request;
Swift
func deleteEventStream(_ request: AWSPinpointTargetingDeleteEventStreamRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteEventStream service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteEventStreamResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes the event stream for an application.
See
AWSPinpointTargetingDeleteEventStreamRequest
See
AWSPinpointTargetingDeleteEventStreamResponse
Declaration
Objective-C
- (void)deleteEventStream: (nonnull AWSPinpointTargetingDeleteEventStreamRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteEventStreamResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteEventStream(_ request: AWSPinpointTargetingDeleteEventStreamRequest) async throws -> AWSPinpointTargetingDeleteEventStreamResponse
Parameters
request
A container for the necessary parameters to execute the DeleteEventStream service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the GCM channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteGcmChannelRequest
See
AWSPinpointTargetingDeleteGcmChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteGcmChannel: (nonnull AWSPinpointTargetingDeleteGcmChannelRequest *)request;
Swift
func deleteGcmChannel(_ request: AWSPinpointTargetingDeleteGcmChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteGcmChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteGcmChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the GCM channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteGcmChannelRequest
See
AWSPinpointTargetingDeleteGcmChannelResponse
Declaration
Objective-C
- (void)deleteGcmChannel: (nonnull AWSPinpointTargetingDeleteGcmChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteGcmChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteGcmChannel(_ request: AWSPinpointTargetingDeleteGcmChannelRequest) async throws -> AWSPinpointTargetingDeleteGcmChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteGcmChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages sent using the in-app message channel.
See
AWSPinpointTargetingDeleteInAppTemplateRequest
See
AWSPinpointTargetingDeleteInAppTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteInAppTemplate: (nonnull AWSPinpointTargetingDeleteInAppTemplateRequest *)request;
Swift
func delete(inAppTemplate request: AWSPinpointTargetingDeleteInAppTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteInAppTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteInAppTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages sent using the in-app message channel.
See
AWSPinpointTargetingDeleteInAppTemplateRequest
See
AWSPinpointTargetingDeleteInAppTemplateResponse
Declaration
Objective-C
- (void)deleteInAppTemplate: (nonnull AWSPinpointTargetingDeleteInAppTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteInAppTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func delete(inAppTemplate request: AWSPinpointTargetingDeleteInAppTemplateRequest) async throws -> AWSPinpointTargetingDeleteInAppTemplateResponse
Parameters
request
A container for the necessary parameters to execute the DeleteInAppTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a journey from an application.
See
AWSPinpointTargetingDeleteJourneyRequest
See
AWSPinpointTargetingDeleteJourneyResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteJourney: (nonnull AWSPinpointTargetingDeleteJourneyRequest *)request;
Swift
func deleteJourney(_ request: AWSPinpointTargetingDeleteJourneyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteJourney service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteJourneyResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a journey from an application.
See
AWSPinpointTargetingDeleteJourneyRequest
See
AWSPinpointTargetingDeleteJourneyResponse
Declaration
Objective-C
- (void)deleteJourney: (nonnull AWSPinpointTargetingDeleteJourneyRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingDeleteJourneyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteJourney(_ request: AWSPinpointTargetingDeleteJourneyRequest) async throws -> AWSPinpointTargetingDeleteJourneyResponse
Parameters
request
A container for the necessary parameters to execute the DeleteJourney service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through a push notification channel.
See
AWSPinpointTargetingDeletePushTemplateRequest
See
AWSPinpointTargetingDeletePushTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)deletePushTemplate: (nonnull AWSPinpointTargetingDeletePushTemplateRequest *)request;
Swift
func deletePushTemplate(_ request: AWSPinpointTargetingDeletePushTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeletePushTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeletePushTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through a push notification channel.
See
AWSPinpointTargetingDeletePushTemplateRequest
See
AWSPinpointTargetingDeletePushTemplateResponse
Declaration
Objective-C
- (void)deletePushTemplate: (nonnull AWSPinpointTargetingDeletePushTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeletePushTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deletePushTemplate(_ request: AWSPinpointTargetingDeletePushTemplateRequest) async throws -> AWSPinpointTargetingDeletePushTemplateResponse
Parameters
request
A container for the necessary parameters to execute the DeletePushTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingDeleteRecommenderConfigurationRequest
See
AWSPinpointTargetingDeleteRecommenderConfigurationResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteRecommenderConfiguration: (nonnull AWSPinpointTargetingDeleteRecommenderConfigurationRequest *) request;
Swift
func deleteRecommenderConfiguration(_ request: AWSPinpointTargetingDeleteRecommenderConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteRecommenderConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteRecommenderConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingDeleteRecommenderConfigurationRequest
See
AWSPinpointTargetingDeleteRecommenderConfigurationResponse
Declaration
Objective-C
- (void) deleteRecommenderConfiguration: (nonnull AWSPinpointTargetingDeleteRecommenderConfigurationRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteRecommenderConfigurationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteRecommenderConfiguration(_ request: AWSPinpointTargetingDeleteRecommenderConfigurationRequest) async throws -> AWSPinpointTargetingDeleteRecommenderConfigurationResponse
Parameters
request
A container for the necessary parameters to execute the DeleteRecommenderConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a segment from an application.
See
AWSPinpointTargetingDeleteSegmentRequest
See
AWSPinpointTargetingDeleteSegmentResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteSegment: (nonnull AWSPinpointTargetingDeleteSegmentRequest *)request;
Swift
func deleteSegment(_ request: AWSPinpointTargetingDeleteSegmentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteSegment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteSegmentResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a segment from an application.
See
AWSPinpointTargetingDeleteSegmentRequest
See
AWSPinpointTargetingDeleteSegmentResponse
Declaration
Objective-C
- (void)deleteSegment: (nonnull AWSPinpointTargetingDeleteSegmentRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingDeleteSegmentResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteSegment(_ request: AWSPinpointTargetingDeleteSegmentRequest) async throws -> AWSPinpointTargetingDeleteSegmentResponse
Parameters
request
A container for the necessary parameters to execute the DeleteSegment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the SMS channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteSmsChannelRequest
See
AWSPinpointTargetingDeleteSmsChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteSmsChannel: (nonnull AWSPinpointTargetingDeleteSmsChannelRequest *)request;
Swift
func deleteSmsChannel(_ request: AWSPinpointTargetingDeleteSmsChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteSmsChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteSmsChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the SMS channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteSmsChannelRequest
See
AWSPinpointTargetingDeleteSmsChannelResponse
Declaration
Objective-C
- (void)deleteSmsChannel: (nonnull AWSPinpointTargetingDeleteSmsChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteSmsChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteSmsChannel(_ request: AWSPinpointTargetingDeleteSmsChannelRequest) async throws -> AWSPinpointTargetingDeleteSmsChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteSmsChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the SMS channel.
See
AWSPinpointTargetingDeleteSmsTemplateRequest
See
AWSPinpointTargetingDeleteSmsTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteSmsTemplate: (nonnull AWSPinpointTargetingDeleteSmsTemplateRequest *)request;
Swift
func deleteSmsTemplate(_ request: AWSPinpointTargetingDeleteSmsTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteSmsTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteSmsTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the SMS channel.
See
AWSPinpointTargetingDeleteSmsTemplateRequest
See
AWSPinpointTargetingDeleteSmsTemplateResponse
Declaration
Objective-C
- (void)deleteSmsTemplate: (nonnull AWSPinpointTargetingDeleteSmsTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteSmsTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteSmsTemplate(_ request: AWSPinpointTargetingDeleteSmsTemplateRequest) async throws -> AWSPinpointTargetingDeleteSmsTemplateResponse
Parameters
request
A container for the necessary parameters to execute the DeleteSmsTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes all the endpoints that are associated with a specific user ID.
See
AWSPinpointTargetingDeleteUserEndpointsRequest
See
AWSPinpointTargetingDeleteUserEndpointsResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteUserEndpoints: (nonnull AWSPinpointTargetingDeleteUserEndpointsRequest *)request;
Swift
func deleteUserEndpoints(_ request: AWSPinpointTargetingDeleteUserEndpointsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteUserEndpoints service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteUserEndpointsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes all the endpoints that are associated with a specific user ID.
See
AWSPinpointTargetingDeleteUserEndpointsRequest
See
AWSPinpointTargetingDeleteUserEndpointsResponse
Declaration
Objective-C
- (void)deleteUserEndpoints: (nonnull AWSPinpointTargetingDeleteUserEndpointsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteUserEndpointsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteUserEndpoints(_ request: AWSPinpointTargetingDeleteUserEndpointsRequest) async throws -> AWSPinpointTargetingDeleteUserEndpointsResponse
Parameters
request
A container for the necessary parameters to execute the DeleteUserEndpoints service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the voice channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteVoiceChannelRequest
See
AWSPinpointTargetingDeleteVoiceChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteVoiceChannel: (nonnull AWSPinpointTargetingDeleteVoiceChannelRequest *)request;
Swift
func deleteVoiceChannel(_ request: AWSPinpointTargetingDeleteVoiceChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteVoiceChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteVoiceChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Disables the voice channel for an application and deletes any existing settings for the channel.
See
AWSPinpointTargetingDeleteVoiceChannelRequest
See
AWSPinpointTargetingDeleteVoiceChannelResponse
Declaration
Objective-C
- (void)deleteVoiceChannel: (nonnull AWSPinpointTargetingDeleteVoiceChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteVoiceChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteVoiceChannel(_ request: AWSPinpointTargetingDeleteVoiceChannelRequest) async throws -> AWSPinpointTargetingDeleteVoiceChannelResponse
Parameters
request
A container for the necessary parameters to execute the DeleteVoiceChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the voice channel.
See
AWSPinpointTargetingDeleteVoiceTemplateRequest
See
AWSPinpointTargetingDeleteVoiceTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)deleteVoiceTemplate: (nonnull AWSPinpointTargetingDeleteVoiceTemplateRequest *)request;
Swift
func deleteVoiceTemplate(_ request: AWSPinpointTargetingDeleteVoiceTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteVoiceTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingDeleteVoiceTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Deletes a message template for messages that were sent through the voice channel.
See
AWSPinpointTargetingDeleteVoiceTemplateRequest
See
AWSPinpointTargetingDeleteVoiceTemplateResponse
Declaration
Objective-C
- (void)deleteVoiceTemplate: (nonnull AWSPinpointTargetingDeleteVoiceTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingDeleteVoiceTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteVoiceTemplate(_ request: AWSPinpointTargetingDeleteVoiceTemplateRequest) async throws -> AWSPinpointTargetingDeleteVoiceTemplateResponse
Parameters
request
A container for the necessary parameters to execute the DeleteVoiceTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the ADM channel for an application.
See
AWSPinpointTargetingGetAdmChannelRequest
See
AWSPinpointTargetingGetAdmChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getAdmChannel: (nonnull AWSPinpointTargetingGetAdmChannelRequest *)request;
Swift
func getAdmChannel(_ request: AWSPinpointTargetingGetAdmChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetAdmChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetAdmChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the ADM channel for an application.
See
AWSPinpointTargetingGetAdmChannelRequest
See
AWSPinpointTargetingGetAdmChannelResponse
Declaration
Objective-C
- (void)getAdmChannel: (nonnull AWSPinpointTargetingGetAdmChannelRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetAdmChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func admChannel(_ request: AWSPinpointTargetingGetAdmChannelRequest) async throws -> AWSPinpointTargetingGetAdmChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetAdmChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs channel for an application.
See
AWSPinpointTargetingGetApnsChannelRequest
See
AWSPinpointTargetingGetApnsChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApnsChannel: (nonnull AWSPinpointTargetingGetApnsChannelRequest *)request;
Swift
func getApnsChannel(_ request: AWSPinpointTargetingGetApnsChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApnsChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApnsChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs channel for an application.
See
AWSPinpointTargetingGetApnsChannelRequest
See
AWSPinpointTargetingGetApnsChannelResponse
Declaration
Objective-C
- (void)getApnsChannel: (nonnull AWSPinpointTargetingGetApnsChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApnsChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func apnsChannel(_ request: AWSPinpointTargetingGetApnsChannelRequest) async throws -> AWSPinpointTargetingGetApnsChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetApnsChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs sandbox channel for an application.
See
AWSPinpointTargetingGetApnsSandboxChannelRequest
See
AWSPinpointTargetingGetApnsSandboxChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApnsSandboxChannel: (nonnull AWSPinpointTargetingGetApnsSandboxChannelRequest *)request;
Swift
func getApnsSandboxChannel(_ request: AWSPinpointTargetingGetApnsSandboxChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApnsSandboxChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApnsSandboxChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs sandbox channel for an application.
See
AWSPinpointTargetingGetApnsSandboxChannelRequest
See
AWSPinpointTargetingGetApnsSandboxChannelResponse
Declaration
Objective-C
- (void) getApnsSandboxChannel: (nonnull AWSPinpointTargetingGetApnsSandboxChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApnsSandboxChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func apnsSandboxChannel(_ request: AWSPinpointTargetingGetApnsSandboxChannelRequest) async throws -> AWSPinpointTargetingGetApnsSandboxChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetApnsSandboxChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs VoIP channel for an application.
See
AWSPinpointTargetingGetApnsVoipChannelRequest
See
AWSPinpointTargetingGetApnsVoipChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApnsVoipChannel: (nonnull AWSPinpointTargetingGetApnsVoipChannelRequest *)request;
Swift
func getApnsVoipChannel(_ request: AWSPinpointTargetingGetApnsVoipChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApnsVoipChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApnsVoipChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs VoIP channel for an application.
See
AWSPinpointTargetingGetApnsVoipChannelRequest
See
AWSPinpointTargetingGetApnsVoipChannelResponse
Declaration
Objective-C
- (void)getApnsVoipChannel: (nonnull AWSPinpointTargetingGetApnsVoipChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApnsVoipChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func apnsVoipChannel(_ request: AWSPinpointTargetingGetApnsVoipChannelRequest) async throws -> AWSPinpointTargetingGetApnsVoipChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetApnsVoipChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
See
AWSPinpointTargetingGetApnsVoipSandboxChannelRequest
See
AWSPinpointTargetingGetApnsVoipSandboxChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApnsVoipSandboxChannel: (nonnull AWSPinpointTargetingGetApnsVoipSandboxChannelRequest *)request;
Swift
func getApnsVoipSandboxChannel(_ request: AWSPinpointTargetingGetApnsVoipSandboxChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApnsVoipSandboxChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApnsVoipSandboxChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
See
AWSPinpointTargetingGetApnsVoipSandboxChannelRequest
See
AWSPinpointTargetingGetApnsVoipSandboxChannelResponse
Declaration
Objective-C
- (void)getApnsVoipSandboxChannel: (nonnull AWSPinpointTargetingGetApnsVoipSandboxChannelRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApnsVoipSandboxChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func apnsVoipSandboxChannel(_ request: AWSPinpointTargetingGetApnsVoipSandboxChannelRequest) async throws -> AWSPinpointTargetingGetApnsVoipSandboxChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetApnsVoipSandboxChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about an application.
See
AWSPinpointTargetingGetAppRequest
See
AWSPinpointTargetingGetAppResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApp: (nonnull AWSPinpointTargetingGetAppRequest *)request;
Swift
func getApp(_ request: AWSPinpointTargetingGetAppRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApp service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetAppResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about an application.
See
AWSPinpointTargetingGetAppRequest
See
AWSPinpointTargetingGetAppResponse
Declaration
Objective-C
- (void)getApp:(nonnull AWSPinpointTargetingGetAppRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetAppResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func app(_ request: AWSPinpointTargetingGetAppRequest) async throws -> AWSPinpointTargetingGetAppResponse
Parameters
request
A container for the necessary parameters to execute the GetApp service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
See
AWSPinpointTargetingGetApplicationDateRangeKpiRequest
See
AWSPinpointTargetingGetApplicationDateRangeKpiResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApplicationDateRangeKpi: (nonnull AWSPinpointTargetingGetApplicationDateRangeKpiRequest *)request;
Swift
func getApplicationDateRangeKpi(_ request: AWSPinpointTargetingGetApplicationDateRangeKpiRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApplicationDateRangeKpi service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApplicationDateRangeKpiResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
See
AWSPinpointTargetingGetApplicationDateRangeKpiRequest
See
AWSPinpointTargetingGetApplicationDateRangeKpiResponse
Declaration
Objective-C
- (void)getApplicationDateRangeKpi: (nonnull AWSPinpointTargetingGetApplicationDateRangeKpiRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApplicationDateRangeKpiResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func applicationDateRangeKpi(_ request: AWSPinpointTargetingGetApplicationDateRangeKpiRequest) async throws -> AWSPinpointTargetingGetApplicationDateRangeKpiResponse
Parameters
request
A container for the necessary parameters to execute the GetApplicationDateRangeKpi service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the settings for an application.
See
AWSPinpointTargetingGetApplicationSettingsRequest
See
AWSPinpointTargetingGetApplicationSettingsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApplicationSettings: (nonnull AWSPinpointTargetingGetApplicationSettingsRequest *)request;
Swift
func getApplicationSettings(_ request: AWSPinpointTargetingGetApplicationSettingsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApplicationSettings service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetApplicationSettingsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the settings for an application.
See
AWSPinpointTargetingGetApplicationSettingsRequest
See
AWSPinpointTargetingGetApplicationSettingsResponse
Declaration
Objective-C
- (void) getApplicationSettings: (nonnull AWSPinpointTargetingGetApplicationSettingsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetApplicationSettingsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func applicationSettings(_ request: AWSPinpointTargetingGetApplicationSettingsRequest) async throws -> AWSPinpointTargetingGetApplicationSettingsResponse
Parameters
request
A container for the necessary parameters to execute the GetApplicationSettings service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingGetAppsRequest
See
AWSPinpointTargetingGetAppsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getApps: (nonnull AWSPinpointTargetingGetAppsRequest *)request;
Swift
func getApps(_ request: AWSPinpointTargetingGetAppsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetApps service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetAppsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingGetAppsRequest
See
AWSPinpointTargetingGetAppsResponse
Declaration
Objective-C
- (void)getApps:(nonnull AWSPinpointTargetingGetAppsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetAppsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func apps(_ request: AWSPinpointTargetingGetAppsRequest) async throws -> AWSPinpointTargetingGetAppsResponse
Parameters
request
A container for the necessary parameters to execute the GetApps service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the Baidu channel for an application.
See
AWSPinpointTargetingGetBaiduChannelRequest
See
AWSPinpointTargetingGetBaiduChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getBaiduChannel: (nonnull AWSPinpointTargetingGetBaiduChannelRequest *)request;
Swift
func getBaiduChannel(_ request: AWSPinpointTargetingGetBaiduChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetBaiduChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetBaiduChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the Baidu channel for an application.
See
AWSPinpointTargetingGetBaiduChannelRequest
See
AWSPinpointTargetingGetBaiduChannelResponse
Declaration
Objective-C
- (void)getBaiduChannel: (nonnull AWSPinpointTargetingGetBaiduChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetBaiduChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func baiduChannel(_ request: AWSPinpointTargetingGetBaiduChannelRequest) async throws -> AWSPinpointTargetingGetBaiduChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetBaiduChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a campaign.
See
AWSPinpointTargetingGetCampaignRequest
See
AWSPinpointTargetingGetCampaignResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaign: (nonnull AWSPinpointTargetingGetCampaignRequest *)request;
Swift
func getCampaign(_ request: AWSPinpointTargetingGetCampaignRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaign service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a campaign.
See
AWSPinpointTargetingGetCampaignRequest
See
AWSPinpointTargetingGetCampaignResponse
Declaration
Objective-C
- (void)getCampaign:(nonnull AWSPinpointTargetingGetCampaignRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetCampaignResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaign(_ request: AWSPinpointTargetingGetCampaignRequest) async throws -> AWSPinpointTargetingGetCampaignResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaign service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the activities for a campaign.
See
AWSPinpointTargetingGetCampaignActivitiesRequest
See
AWSPinpointTargetingGetCampaignActivitiesResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaignActivities: (nonnull AWSPinpointTargetingGetCampaignActivitiesRequest *)request;
Swift
func getCampaignActivities(_ request: AWSPinpointTargetingGetCampaignActivitiesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaignActivities service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignActivitiesResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the activities for a campaign.
See
AWSPinpointTargetingGetCampaignActivitiesRequest
See
AWSPinpointTargetingGetCampaignActivitiesResponse
Declaration
Objective-C
- (void) getCampaignActivities: (nonnull AWSPinpointTargetingGetCampaignActivitiesRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetCampaignActivitiesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaignActivities(_ request: AWSPinpointTargetingGetCampaignActivitiesRequest) async throws -> AWSPinpointTargetingGetCampaignActivitiesResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaignActivities service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
See
AWSPinpointTargetingGetCampaignDateRangeKpiRequest
See
AWSPinpointTargetingGetCampaignDateRangeKpiResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaignDateRangeKpi: (nonnull AWSPinpointTargetingGetCampaignDateRangeKpiRequest *)request;
Swift
func getCampaignDateRangeKpi(_ request: AWSPinpointTargetingGetCampaignDateRangeKpiRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaignDateRangeKpi service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignDateRangeKpiResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
See
AWSPinpointTargetingGetCampaignDateRangeKpiRequest
See
AWSPinpointTargetingGetCampaignDateRangeKpiResponse
Declaration
Objective-C
- (void)getCampaignDateRangeKpi: (nonnull AWSPinpointTargetingGetCampaignDateRangeKpiRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetCampaignDateRangeKpiResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaignDateRangeKpi(_ request: AWSPinpointTargetingGetCampaignDateRangeKpiRequest) async throws -> AWSPinpointTargetingGetCampaignDateRangeKpiResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaignDateRangeKpi service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
See
AWSPinpointTargetingGetCampaignVersionRequest
See
AWSPinpointTargetingGetCampaignVersionResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaignVersion: (nonnull AWSPinpointTargetingGetCampaignVersionRequest *)request;
Swift
func getCampaignVersion(_ request: AWSPinpointTargetingGetCampaignVersionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaignVersion service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignVersionResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
See
AWSPinpointTargetingGetCampaignVersionRequest
See
AWSPinpointTargetingGetCampaignVersionResponse
Declaration
Objective-C
- (void)getCampaignVersion: (nonnull AWSPinpointTargetingGetCampaignVersionRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetCampaignVersionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaignVersion(_ request: AWSPinpointTargetingGetCampaignVersionRequest) async throws -> AWSPinpointTargetingGetCampaignVersionResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaignVersion service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
See
AWSPinpointTargetingGetCampaignVersionsRequest
See
AWSPinpointTargetingGetCampaignVersionsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaignVersions: (nonnull AWSPinpointTargetingGetCampaignVersionsRequest *)request;
Swift
func getCampaignVersions(_ request: AWSPinpointTargetingGetCampaignVersionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaignVersions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignVersionsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all versions of a campaign.
See
AWSPinpointTargetingGetCampaignVersionsRequest
See
AWSPinpointTargetingGetCampaignVersionsResponse
Declaration
Objective-C
- (void)getCampaignVersions: (nonnull AWSPinpointTargetingGetCampaignVersionsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetCampaignVersionsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaignVersions(_ request: AWSPinpointTargetingGetCampaignVersionsRequest) async throws -> AWSPinpointTargetingGetCampaignVersionsResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaignVersions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
See
AWSPinpointTargetingGetCampaignsRequest
See
AWSPinpointTargetingGetCampaignsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getCampaigns: (nonnull AWSPinpointTargetingGetCampaignsRequest *)request;
Swift
func getCampaigns(_ request: AWSPinpointTargetingGetCampaignsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetCampaigns service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetCampaignsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
See
AWSPinpointTargetingGetCampaignsRequest
See
AWSPinpointTargetingGetCampaignsResponse
Declaration
Objective-C
- (void)getCampaigns:(nonnull AWSPinpointTargetingGetCampaignsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetCampaignsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func campaigns(_ request: AWSPinpointTargetingGetCampaignsRequest) async throws -> AWSPinpointTargetingGetCampaignsResponse
Parameters
request
A container for the necessary parameters to execute the GetCampaigns service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the history and status of each channel for an application.
See
AWSPinpointTargetingGetChannelsRequest
See
AWSPinpointTargetingGetChannelsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getChannels: (nonnull AWSPinpointTargetingGetChannelsRequest *)request;
Swift
func getChannels(_ request: AWSPinpointTargetingGetChannelsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetChannels service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetChannelsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the history and status of each channel for an application.
See
AWSPinpointTargetingGetChannelsRequest
See
AWSPinpointTargetingGetChannelsResponse
Declaration
Objective-C
- (void)getChannels:(nonnull AWSPinpointTargetingGetChannelsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetChannelsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func channels(_ request: AWSPinpointTargetingGetChannelsRequest) async throws -> AWSPinpointTargetingGetChannelsResponse
Parameters
request
A container for the necessary parameters to execute the GetChannels service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the email channel for an application.
See
AWSPinpointTargetingGetEmailChannelRequest
See
AWSPinpointTargetingGetEmailChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getEmailChannel: (nonnull AWSPinpointTargetingGetEmailChannelRequest *)request;
Swift
func getEmailChannel(_ request: AWSPinpointTargetingGetEmailChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetEmailChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetEmailChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the email channel for an application.
See
AWSPinpointTargetingGetEmailChannelRequest
See
AWSPinpointTargetingGetEmailChannelResponse
Declaration
Objective-C
- (void)getEmailChannel: (nonnull AWSPinpointTargetingGetEmailChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetEmailChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func emailChannel(_ request: AWSPinpointTargetingGetEmailChannelRequest) async throws -> AWSPinpointTargetingGetEmailChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetEmailChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the email channel.
See
AWSPinpointTargetingGetEmailTemplateRequest
See
AWSPinpointTargetingGetEmailTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)getEmailTemplate: (nonnull AWSPinpointTargetingGetEmailTemplateRequest *)request;
Swift
func getEmailTemplate(_ request: AWSPinpointTargetingGetEmailTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetEmailTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetEmailTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the email channel.
See
AWSPinpointTargetingGetEmailTemplateRequest
See
AWSPinpointTargetingGetEmailTemplateResponse
Declaration
Objective-C
- (void)getEmailTemplate: (nonnull AWSPinpointTargetingGetEmailTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetEmailTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func emailTemplate(_ request: AWSPinpointTargetingGetEmailTemplateRequest) async throws -> AWSPinpointTargetingGetEmailTemplateResponse
Parameters
request
A container for the necessary parameters to execute the GetEmailTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the settings and attributes of a specific endpoint for an application.
See
AWSPinpointTargetingGetEndpointRequest
See
AWSPinpointTargetingGetEndpointResponse
Declaration
Objective-C
- (nonnull AWSTask *)getEndpoint: (nonnull AWSPinpointTargetingGetEndpointRequest *)request;
Swift
func getEndpoint(_ request: AWSPinpointTargetingGetEndpointRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetEndpoint service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetEndpointResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the settings and attributes of a specific endpoint for an application.
See
AWSPinpointTargetingGetEndpointRequest
See
AWSPinpointTargetingGetEndpointResponse
Declaration
Objective-C
- (void)getEndpoint:(nonnull AWSPinpointTargetingGetEndpointRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetEndpointResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func endpoint(_ request: AWSPinpointTargetingGetEndpointRequest) async throws -> AWSPinpointTargetingGetEndpointResponse
Parameters
request
A container for the necessary parameters to execute the GetEndpoint service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the event stream settings for an application.
See
AWSPinpointTargetingGetEventStreamRequest
See
AWSPinpointTargetingGetEventStreamResponse
Declaration
Objective-C
- (nonnull AWSTask *)getEventStream: (nonnull AWSPinpointTargetingGetEventStreamRequest *)request;
Swift
func getEventStream(_ request: AWSPinpointTargetingGetEventStreamRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetEventStream service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetEventStreamResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the event stream settings for an application.
See
AWSPinpointTargetingGetEventStreamRequest
See
AWSPinpointTargetingGetEventStreamResponse
Declaration
Objective-C
- (void)getEventStream: (nonnull AWSPinpointTargetingGetEventStreamRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetEventStreamResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func eventStream(_ request: AWSPinpointTargetingGetEventStreamRequest) async throws -> AWSPinpointTargetingGetEventStreamResponse
Parameters
request
A container for the necessary parameters to execute the GetEventStream service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of a specific export job for an application.
See
AWSPinpointTargetingGetExportJobRequest
See
AWSPinpointTargetingGetExportJobResponse
Declaration
Objective-C
- (nonnull AWSTask *)getExportJob: (nonnull AWSPinpointTargetingGetExportJobRequest *)request;
Swift
func getExportJob(_ request: AWSPinpointTargetingGetExportJobRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetExportJob service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetExportJobResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of a specific export job for an application.
See
AWSPinpointTargetingGetExportJobRequest
See
AWSPinpointTargetingGetExportJobResponse
Declaration
Objective-C
- (void)getExportJob:(nonnull AWSPinpointTargetingGetExportJobRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetExportJobResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func exportJob(_ request: AWSPinpointTargetingGetExportJobRequest) async throws -> AWSPinpointTargetingGetExportJobResponse
Parameters
request
A container for the necessary parameters to execute the GetExportJob service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of all the export jobs for an application.
See
AWSPinpointTargetingGetExportJobsRequest
See
AWSPinpointTargetingGetExportJobsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getExportJobs: (nonnull AWSPinpointTargetingGetExportJobsRequest *)request;
Swift
func getExportJobs(_ request: AWSPinpointTargetingGetExportJobsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetExportJobs service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetExportJobsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of all the export jobs for an application.
See
AWSPinpointTargetingGetExportJobsRequest
See
AWSPinpointTargetingGetExportJobsResponse
Declaration
Objective-C
- (void)getExportJobs: (nonnull AWSPinpointTargetingGetExportJobsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetExportJobsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func exportJobs(_ request: AWSPinpointTargetingGetExportJobsRequest) async throws -> AWSPinpointTargetingGetExportJobsResponse
Parameters
request
A container for the necessary parameters to execute the GetExportJobs service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the GCM channel for an application.
See
AWSPinpointTargetingGetGcmChannelRequest
See
AWSPinpointTargetingGetGcmChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getGcmChannel: (nonnull AWSPinpointTargetingGetGcmChannelRequest *)request;
Swift
func getGcmChannel(_ request: AWSPinpointTargetingGetGcmChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetGcmChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetGcmChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the GCM channel for an application.
See
AWSPinpointTargetingGetGcmChannelRequest
See
AWSPinpointTargetingGetGcmChannelResponse
Declaration
Objective-C
- (void)getGcmChannel: (nonnull AWSPinpointTargetingGetGcmChannelRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetGcmChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func gcmChannel(_ request: AWSPinpointTargetingGetGcmChannelRequest) async throws -> AWSPinpointTargetingGetGcmChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetGcmChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of a specific import job for an application.
See
AWSPinpointTargetingGetImportJobRequest
See
AWSPinpointTargetingGetImportJobResponse
Declaration
Objective-C
- (nonnull AWSTask *)getImportJob: (nonnull AWSPinpointTargetingGetImportJobRequest *)request;
Swift
func getImportJob(_ request: AWSPinpointTargetingGetImportJobRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetImportJob service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetImportJobResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of a specific import job for an application.
See
AWSPinpointTargetingGetImportJobRequest
See
AWSPinpointTargetingGetImportJobResponse
Declaration
Objective-C
- (void)getImportJob:(nonnull AWSPinpointTargetingGetImportJobRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetImportJobResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func importJob(_ request: AWSPinpointTargetingGetImportJobRequest) async throws -> AWSPinpointTargetingGetImportJobResponse
Parameters
request
A container for the necessary parameters to execute the GetImportJob service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of all the import jobs for an application.
See
AWSPinpointTargetingGetImportJobsRequest
See
AWSPinpointTargetingGetImportJobsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getImportJobs: (nonnull AWSPinpointTargetingGetImportJobsRequest *)request;
Swift
func getImportJobs(_ request: AWSPinpointTargetingGetImportJobsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetImportJobs service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetImportJobsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of all the import jobs for an application.
See
AWSPinpointTargetingGetImportJobsRequest
See
AWSPinpointTargetingGetImportJobsResponse
Declaration
Objective-C
- (void)getImportJobs: (nonnull AWSPinpointTargetingGetImportJobsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetImportJobsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func importJobs(_ request: AWSPinpointTargetingGetImportJobsRequest) async throws -> AWSPinpointTargetingGetImportJobsResponse
Parameters
request
A container for the necessary parameters to execute the GetImportJobs service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the in-app messages targeted for the provided endpoint ID.
See
AWSPinpointTargetingGetInAppMessagesRequest
See
AWSPinpointTargetingGetInAppMessagesResponse
Declaration
Objective-C
- (nonnull AWSTask *)getInAppMessages: (nonnull AWSPinpointTargetingGetInAppMessagesRequest *)request;
Swift
func getInAppMessages(_ request: AWSPinpointTargetingGetInAppMessagesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetInAppMessages service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetInAppMessagesResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the in-app messages targeted for the provided endpoint ID.
See
AWSPinpointTargetingGetInAppMessagesRequest
See
AWSPinpointTargetingGetInAppMessagesResponse
Declaration
Objective-C
- (void)getInAppMessages: (nonnull AWSPinpointTargetingGetInAppMessagesRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetInAppMessagesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func inAppMessages(_ request: AWSPinpointTargetingGetInAppMessagesRequest) async throws -> AWSPinpointTargetingGetInAppMessagesResponse
Parameters
request
A container for the necessary parameters to execute the GetInAppMessages service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages sent through the in-app channel.
See
AWSPinpointTargetingGetInAppTemplateRequest
See
AWSPinpointTargetingGetInAppTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)getInAppTemplate: (nonnull AWSPinpointTargetingGetInAppTemplateRequest *)request;
Swift
func getInAppTemplate(_ request: AWSPinpointTargetingGetInAppTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetInAppTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetInAppTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages sent through the in-app channel.
See
AWSPinpointTargetingGetInAppTemplateRequest
See
AWSPinpointTargetingGetInAppTemplateResponse
Declaration
Objective-C
- (void)getInAppTemplate: (nonnull AWSPinpointTargetingGetInAppTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetInAppTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func inAppTemplate(_ request: AWSPinpointTargetingGetInAppTemplateRequest) async throws -> AWSPinpointTargetingGetInAppTemplateResponse
Parameters
request
A container for the necessary parameters to execute the GetInAppTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a journey.
See
AWSPinpointTargetingGetJourneyRequest
See
AWSPinpointTargetingGetJourneyResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourney: (nonnull AWSPinpointTargetingGetJourneyRequest *)request;
Swift
func getJourney(_ request: AWSPinpointTargetingGetJourneyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourney service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for a journey.
See
AWSPinpointTargetingGetJourneyRequest
See
AWSPinpointTargetingGetJourneyResponse
Declaration
Objective-C
- (void)getJourney:(nonnull AWSPinpointTargetingGetJourneyRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetJourneyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journey(_ request: AWSPinpointTargetingGetJourneyRequest) async throws -> AWSPinpointTargetingGetJourneyResponse
Parameters
request
A container for the necessary parameters to execute the GetJourney service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyDateRangeKpiRequest
See
AWSPinpointTargetingGetJourneyDateRangeKpiResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyDateRangeKpi: (nonnull AWSPinpointTargetingGetJourneyDateRangeKpiRequest *)request;
Swift
func getJourneyDateRangeKpi(_ request: AWSPinpointTargetingGetJourneyDateRangeKpiRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyDateRangeKpi service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyDateRangeKpiResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyDateRangeKpiRequest
See
AWSPinpointTargetingGetJourneyDateRangeKpiResponse
Declaration
Objective-C
- (void) getJourneyDateRangeKpi: (nonnull AWSPinpointTargetingGetJourneyDateRangeKpiRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyDateRangeKpiResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyDateRangeKpi(_ request: AWSPinpointTargetingGetJourneyDateRangeKpiRequest) async throws -> AWSPinpointTargetingGetJourneyDateRangeKpiResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyDateRangeKpi service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
See
AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest
See
AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyExecutionActivityMetrics: (nonnull AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest *) request;
Swift
func getJourneyExecutionActivityMetrics(_ request: AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyExecutionActivityMetrics service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
See
AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest
See
AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse
Declaration
Objective-C
- (void) getJourneyExecutionActivityMetrics: (nonnull AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyExecutionActivityMetrics(_ request: AWSPinpointTargetingGetJourneyExecutionActivityMetricsRequest) async throws -> AWSPinpointTargetingGetJourneyExecutionActivityMetricsResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyExecutionActivityMetrics service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyExecutionMetricsRequest
See
AWSPinpointTargetingGetJourneyExecutionMetricsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyExecutionMetrics: (nonnull AWSPinpointTargetingGetJourneyExecutionMetricsRequest *)request;
Swift
func getJourneyExecutionMetrics(_ request: AWSPinpointTargetingGetJourneyExecutionMetricsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyExecutionMetrics service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyExecutionMetricsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyExecutionMetricsRequest
See
AWSPinpointTargetingGetJourneyExecutionMetricsResponse
Declaration
Objective-C
- (void)getJourneyExecutionMetrics: (nonnull AWSPinpointTargetingGetJourneyExecutionMetricsRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyExecutionMetricsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyExecutionMetrics(_ request: AWSPinpointTargetingGetJourneyExecutionMetricsRequest) async throws -> AWSPinpointTargetingGetJourneyExecutionMetricsResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyExecutionMetrics service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
See
AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest
See
AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyRunExecutionActivityMetrics: (nonnull AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest *) request;
Swift
func getJourneyRunExecutionActivityMetrics(_ request: AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyRunExecutionActivityMetrics service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey activity.
See
AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest
See
AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse
Declaration
Objective-C
- (void) getJourneyRunExecutionActivityMetrics: (nonnull AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyRunExecutionActivityMetrics(_ request: AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsRequest) async throws -> AWSPinpointTargetingGetJourneyRunExecutionActivityMetricsResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyRunExecutionActivityMetrics service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest
See
AWSPinpointTargetingGetJourneyRunExecutionMetricsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyRunExecutionMetrics: (nonnull AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest *)request;
Swift
func getJourneyRunExecutionMetrics(_ request: AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyRunExecutionMetrics service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyRunExecutionMetricsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves (queries) pre-aggregated data for a standard run execution metric that applies to a journey.
See
AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest
See
AWSPinpointTargetingGetJourneyRunExecutionMetricsResponse
Declaration
Objective-C
- (void) getJourneyRunExecutionMetrics: (nonnull AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyRunExecutionMetricsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyRunExecutionMetrics(_ request: AWSPinpointTargetingGetJourneyRunExecutionMetricsRequest) async throws -> AWSPinpointTargetingGetJourneyRunExecutionMetricsResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyRunExecutionMetrics service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Provides information about the runs of a journey.
See
AWSPinpointTargetingGetJourneyRunsRequest
See
AWSPinpointTargetingGetJourneyRunsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getJourneyRuns: (nonnull AWSPinpointTargetingGetJourneyRunsRequest *)request;
Swift
func getJourneyRuns(_ request: AWSPinpointTargetingGetJourneyRunsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetJourneyRuns service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetJourneyRunsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Provides information about the runs of a journey.
See
AWSPinpointTargetingGetJourneyRunsRequest
See
AWSPinpointTargetingGetJourneyRunsResponse
Declaration
Objective-C
- (void)getJourneyRuns: (nonnull AWSPinpointTargetingGetJourneyRunsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetJourneyRunsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func journeyRuns(_ request: AWSPinpointTargetingGetJourneyRunsRequest) async throws -> AWSPinpointTargetingGetJourneyRunsResponse
Parameters
request
A container for the necessary parameters to execute the GetJourneyRuns service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
See
AWSPinpointTargetingGetPushTemplateRequest
See
AWSPinpointTargetingGetPushTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)getPushTemplate: (nonnull AWSPinpointTargetingGetPushTemplateRequest *)request;
Swift
func getPushTemplate(_ request: AWSPinpointTargetingGetPushTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetPushTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetPushTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
See
AWSPinpointTargetingGetPushTemplateRequest
See
AWSPinpointTargetingGetPushTemplateResponse
Declaration
Objective-C
- (void)getPushTemplate: (nonnull AWSPinpointTargetingGetPushTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetPushTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func pushTemplate(_ request: AWSPinpointTargetingGetPushTemplateRequest) async throws -> AWSPinpointTargetingGetPushTemplateResponse
Parameters
request
A container for the necessary parameters to execute the GetPushTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingGetRecommenderConfigurationRequest
See
AWSPinpointTargetingGetRecommenderConfigurationResponse
Declaration
Objective-C
- (nonnull AWSTask *)getRecommenderConfiguration: (nonnull AWSPinpointTargetingGetRecommenderConfigurationRequest *)request;
Swift
func getRecommenderConfiguration(_ request: AWSPinpointTargetingGetRecommenderConfigurationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetRecommenderConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetRecommenderConfigurationResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about an Amazon Pinpoint configuration for a recommender model.
See
AWSPinpointTargetingGetRecommenderConfigurationRequest
See
AWSPinpointTargetingGetRecommenderConfigurationResponse
Declaration
Objective-C
- (void) getRecommenderConfiguration: (nonnull AWSPinpointTargetingGetRecommenderConfigurationRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetRecommenderConfigurationResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func recommenderConfiguration(_ request: AWSPinpointTargetingGetRecommenderConfigurationRequest) async throws -> AWSPinpointTargetingGetRecommenderConfigurationResponse
Parameters
request
A container for the necessary parameters to execute the GetRecommenderConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingGetRecommenderConfigurationsRequest
See
AWSPinpointTargetingGetRecommenderConfigurationsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getRecommenderConfigurations: (nonnull AWSPinpointTargetingGetRecommenderConfigurationsRequest *)request;
Swift
func getRecommenderConfigurations(_ request: AWSPinpointTargetingGetRecommenderConfigurationsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetRecommenderConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetRecommenderConfigurationsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingGetRecommenderConfigurationsRequest
See
AWSPinpointTargetingGetRecommenderConfigurationsResponse
Declaration
Objective-C
- (void) getRecommenderConfigurations: (nonnull AWSPinpointTargetingGetRecommenderConfigurationsRequest *) request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetRecommenderConfigurationsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func recommenderConfigurations(_ request: AWSPinpointTargetingGetRecommenderConfigurationsRequest) async throws -> AWSPinpointTargetingGetRecommenderConfigurationsResponse
Parameters
request
A container for the necessary parameters to execute the GetRecommenderConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for a specific segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentRequest
See
AWSPinpointTargetingGetSegmentResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegment: (nonnull AWSPinpointTargetingGetSegmentRequest *)request;
Swift
func getSegment(_ request: AWSPinpointTargetingGetSegmentRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegment service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for a specific segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentRequest
See
AWSPinpointTargetingGetSegmentResponse
Declaration
Objective-C
- (void)getSegment:(nonnull AWSPinpointTargetingGetSegmentRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetSegmentResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segment(_ request: AWSPinpointTargetingGetSegmentRequest) async throws -> AWSPinpointTargetingGetSegmentResponse
Parameters
request
A container for the necessary parameters to execute the GetSegment service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the export jobs for a segment.
See
AWSPinpointTargetingGetSegmentExportJobsRequest
See
AWSPinpointTargetingGetSegmentExportJobsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegmentExportJobs: (nonnull AWSPinpointTargetingGetSegmentExportJobsRequest *)request;
Swift
func getSegmentExportJobs(_ request: AWSPinpointTargetingGetSegmentExportJobsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegmentExportJobs service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentExportJobsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the export jobs for a segment.
See
AWSPinpointTargetingGetSegmentExportJobsRequest
See
AWSPinpointTargetingGetSegmentExportJobsResponse
Declaration
Objective-C
- (void)getSegmentExportJobs: (nonnull AWSPinpointTargetingGetSegmentExportJobsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetSegmentExportJobsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segmentExportJobs(_ request: AWSPinpointTargetingGetSegmentExportJobsRequest) async throws -> AWSPinpointTargetingGetSegmentExportJobsResponse
Parameters
request
A container for the necessary parameters to execute the GetSegmentExportJobs service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the import jobs for a segment.
See
AWSPinpointTargetingGetSegmentImportJobsRequest
See
AWSPinpointTargetingGetSegmentImportJobsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegmentImportJobs: (nonnull AWSPinpointTargetingGetSegmentImportJobsRequest *)request;
Swift
func getSegmentImportJobs(_ request: AWSPinpointTargetingGetSegmentImportJobsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegmentImportJobs service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentImportJobsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the import jobs for a segment.
See
AWSPinpointTargetingGetSegmentImportJobsRequest
See
AWSPinpointTargetingGetSegmentImportJobsResponse
Declaration
Objective-C
- (void)getSegmentImportJobs: (nonnull AWSPinpointTargetingGetSegmentImportJobsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetSegmentImportJobsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segmentImportJobs(_ request: AWSPinpointTargetingGetSegmentImportJobsRequest) async throws -> AWSPinpointTargetingGetSegmentImportJobsResponse
Parameters
request
A container for the necessary parameters to execute the GetSegmentImportJobs service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentVersionRequest
See
AWSPinpointTargetingGetSegmentVersionResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegmentVersion: (nonnull AWSPinpointTargetingGetSegmentVersionRequest *)request;
Swift
func getSegmentVersion(_ request: AWSPinpointTargetingGetSegmentVersionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegmentVersion service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentVersionResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentVersionRequest
See
AWSPinpointTargetingGetSegmentVersionResponse
Declaration
Objective-C
- (void)getSegmentVersion: (nonnull AWSPinpointTargetingGetSegmentVersionRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetSegmentVersionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segmentVersion(_ request: AWSPinpointTargetingGetSegmentVersionRequest) async throws -> AWSPinpointTargetingGetSegmentVersionResponse
Parameters
request
A container for the necessary parameters to execute the GetSegmentVersion service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentVersionsRequest
See
AWSPinpointTargetingGetSegmentVersionsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegmentVersions: (nonnull AWSPinpointTargetingGetSegmentVersionsRequest *)request;
Swift
func getSegmentVersions(_ request: AWSPinpointTargetingGetSegmentVersionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegmentVersions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentVersionsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that’s associated with an application.
See
AWSPinpointTargetingGetSegmentVersionsRequest
See
AWSPinpointTargetingGetSegmentVersionsResponse
Declaration
Objective-C
- (void)getSegmentVersions: (nonnull AWSPinpointTargetingGetSegmentVersionsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetSegmentVersionsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segmentVersions(_ request: AWSPinpointTargetingGetSegmentVersionsRequest) async throws -> AWSPinpointTargetingGetSegmentVersionsResponse
Parameters
request
A container for the necessary parameters to execute the GetSegmentVersions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
See
AWSPinpointTargetingGetSegmentsRequest
See
AWSPinpointTargetingGetSegmentsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSegments: (nonnull AWSPinpointTargetingGetSegmentsRequest *)request;
Swift
func getSegments(_ request: AWSPinpointTargetingGetSegmentsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSegments service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSegmentsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
See
AWSPinpointTargetingGetSegmentsRequest
See
AWSPinpointTargetingGetSegmentsResponse
Declaration
Objective-C
- (void)getSegments:(nonnull AWSPinpointTargetingGetSegmentsRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetSegmentsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func segments(_ request: AWSPinpointTargetingGetSegmentsRequest) async throws -> AWSPinpointTargetingGetSegmentsResponse
Parameters
request
A container for the necessary parameters to execute the GetSegments service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the SMS channel for an application.
See
AWSPinpointTargetingGetSmsChannelRequest
See
AWSPinpointTargetingGetSmsChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSmsChannel: (nonnull AWSPinpointTargetingGetSmsChannelRequest *)request;
Swift
func getSmsChannel(_ request: AWSPinpointTargetingGetSmsChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSmsChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSmsChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the SMS channel for an application.
See
AWSPinpointTargetingGetSmsChannelRequest
See
AWSPinpointTargetingGetSmsChannelResponse
Declaration
Objective-C
- (void)getSmsChannel: (nonnull AWSPinpointTargetingGetSmsChannelRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingGetSmsChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func smsChannel(_ request: AWSPinpointTargetingGetSmsChannelRequest) async throws -> AWSPinpointTargetingGetSmsChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetSmsChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
See
AWSPinpointTargetingGetSmsTemplateRequest
See
AWSPinpointTargetingGetSmsTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)getSmsTemplate: (nonnull AWSPinpointTargetingGetSmsTemplateRequest *)request;
Swift
func getSmsTemplate(_ request: AWSPinpointTargetingGetSmsTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetSmsTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetSmsTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
See
AWSPinpointTargetingGetSmsTemplateRequest
See
AWSPinpointTargetingGetSmsTemplateResponse
Declaration
Objective-C
- (void)getSmsTemplate: (nonnull AWSPinpointTargetingGetSmsTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetSmsTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func smsTemplate(_ request: AWSPinpointTargetingGetSmsTemplateRequest) async throws -> AWSPinpointTargetingGetSmsTemplateResponse
Parameters
request
A container for the necessary parameters to execute the GetSmsTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the endpoints that are associated with a specific user ID.
See
AWSPinpointTargetingGetUserEndpointsRequest
See
AWSPinpointTargetingGetUserEndpointsResponse
Declaration
Objective-C
- (nonnull AWSTask *)getUserEndpoints: (nonnull AWSPinpointTargetingGetUserEndpointsRequest *)request;
Swift
func getUserEndpoints(_ request: AWSPinpointTargetingGetUserEndpointsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetUserEndpoints service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetUserEndpointsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the endpoints that are associated with a specific user ID.
See
AWSPinpointTargetingGetUserEndpointsRequest
See
AWSPinpointTargetingGetUserEndpointsResponse
Declaration
Objective-C
- (void)getUserEndpoints: (nonnull AWSPinpointTargetingGetUserEndpointsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetUserEndpointsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func userEndpoints(_ request: AWSPinpointTargetingGetUserEndpointsRequest) async throws -> AWSPinpointTargetingGetUserEndpointsResponse
Parameters
request
A container for the necessary parameters to execute the GetUserEndpoints service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the voice channel for an application.
See
AWSPinpointTargetingGetVoiceChannelRequest
See
AWSPinpointTargetingGetVoiceChannelResponse
Declaration
Objective-C
- (nonnull AWSTask *)getVoiceChannel: (nonnull AWSPinpointTargetingGetVoiceChannelRequest *)request;
Swift
func getVoiceChannel(_ request: AWSPinpointTargetingGetVoiceChannelRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetVoiceChannel service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetVoiceChannelResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status and settings of the voice channel for an application.
See
AWSPinpointTargetingGetVoiceChannelRequest
See
AWSPinpointTargetingGetVoiceChannelResponse
Declaration
Objective-C
- (void)getVoiceChannel: (nonnull AWSPinpointTargetingGetVoiceChannelRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetVoiceChannelResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func voiceChannel(_ request: AWSPinpointTargetingGetVoiceChannelRequest) async throws -> AWSPinpointTargetingGetVoiceChannelResponse
Parameters
request
A container for the necessary parameters to execute the GetVoiceChannel service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
See
AWSPinpointTargetingGetVoiceTemplateRequest
See
AWSPinpointTargetingGetVoiceTemplateResponse
Declaration
Objective-C
- (nonnull AWSTask *)getVoiceTemplate: (nonnull AWSPinpointTargetingGetVoiceTemplateRequest *)request;
Swift
func getVoiceTemplate(_ request: AWSPinpointTargetingGetVoiceTemplateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetVoiceTemplate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingGetVoiceTemplateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves the content and settings of a message template for messages that are sent through the voice channel.
See
AWSPinpointTargetingGetVoiceTemplateRequest
See
AWSPinpointTargetingGetVoiceTemplateResponse
Declaration
Objective-C
- (void)getVoiceTemplate: (nonnull AWSPinpointTargetingGetVoiceTemplateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingGetVoiceTemplateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func voiceTemplate(_ request: AWSPinpointTargetingGetVoiceTemplateRequest) async throws -> AWSPinpointTargetingGetVoiceTemplateResponse
Parameters
request
A container for the necessary parameters to execute the GetVoiceTemplate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
See
AWSPinpointTargetingListJourneysRequest
See
AWSPinpointTargetingListJourneysResponse
Declaration
Objective-C
- (nonnull AWSTask *)listJourneys: (nonnull AWSPinpointTargetingListJourneysRequest *)request;
Swift
func listJourneys(_ request: AWSPinpointTargetingListJourneysRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListJourneys service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingListJourneysResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
See
AWSPinpointTargetingListJourneysRequest
See
AWSPinpointTargetingListJourneysResponse
Declaration
Objective-C
- (void)listJourneys:(nonnull AWSPinpointTargetingListJourneysRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingListJourneysResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listJourneys(_ request: AWSPinpointTargetingListJourneysRequest) async throws -> AWSPinpointTargetingListJourneysResponse
Parameters
request
A container for the necessary parameters to execute the ListJourneys service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
See
AWSPinpointTargetingListTagsForResourceRequest
See
AWSPinpointTargetingListTagsForResourceResponse
Declaration
Objective-C
- (nonnull AWSTask *)listTagsForResource: (nonnull AWSPinpointTargetingListTagsForResourceRequest *)request;
Swift
func listTags(forResource request: AWSPinpointTargetingListTagsForResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListTagsForResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingListTagsForResourceResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code: . -
Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
See
AWSPinpointTargetingListTagsForResourceRequest
See
AWSPinpointTargetingListTagsForResourceResponse
Declaration
Objective-C
- (void)listTagsForResource: (nonnull AWSPinpointTargetingListTagsForResourceRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingListTagsForResourceResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listTags(forResource request: AWSPinpointTargetingListTagsForResourceRequest) async throws -> AWSPinpointTargetingListTagsForResourceResponse
Parameters
request
A container for the necessary parameters to execute the ListTagsForResource service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code: . -
Retrieves information about all the versions of a specific message template.
See
AWSPinpointTargetingListTemplateVersionsRequest
See
AWSPinpointTargetingListTemplateVersionsResponse
Declaration
Objective-C
- (nonnull AWSTask *)listTemplateVersions: (nonnull AWSPinpointTargetingListTemplateVersionsRequest *)request;
Swift
func listTemplateVersions(_ request: AWSPinpointTargetingListTemplateVersionsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListTemplateVersions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingListTemplateVersionsResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the versions of a specific message template.
See
AWSPinpointTargetingListTemplateVersionsRequest
See
AWSPinpointTargetingListTemplateVersionsResponse
Declaration
Objective-C
- (void)listTemplateVersions: (nonnull AWSPinpointTargetingListTemplateVersionsRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingListTemplateVersionsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listTemplateVersions(_ request: AWSPinpointTargetingListTemplateVersionsRequest) async throws -> AWSPinpointTargetingListTemplateVersionsResponse
Parameters
request
A container for the necessary parameters to execute the ListTemplateVersions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingListTemplatesRequest
See
AWSPinpointTargetingListTemplatesResponse
Declaration
Objective-C
- (nonnull AWSTask *)listTemplates: (nonnull AWSPinpointTargetingListTemplatesRequest *)request;
Swift
func listTemplates(_ request: AWSPinpointTargetingListTemplatesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListTemplates service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingListTemplatesResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
See
AWSPinpointTargetingListTemplatesRequest
See
AWSPinpointTargetingListTemplatesResponse
Declaration
Objective-C
- (void)listTemplates: (nonnull AWSPinpointTargetingListTemplatesRequest *)request completionHandler: (void (^_Nullable)(AWSPinpointTargetingListTemplatesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listTemplates(_ request: AWSPinpointTargetingListTemplatesRequest) async throws -> AWSPinpointTargetingListTemplatesResponse
Parameters
request
A container for the necessary parameters to execute the ListTemplates service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
,AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorForbidden
. -
Retrieves information about a phone number.
See
AWSPinpointTargetingPhoneNumberValidateRequest
See
AWSPinpointTargetingPhoneNumberValidateResponse
Declaration
Objective-C
- (nonnull AWSTask *)phoneNumberValidate: (nonnull AWSPinpointTargetingPhoneNumberValidateRequest *)request;
Swift
func phoneNumberValidate(_ request: AWSPinpointTargetingPhoneNumberValidateRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PhoneNumberValidate service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingPhoneNumberValidateResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Retrieves information about a phone number.
See
AWSPinpointTargetingPhoneNumberValidateRequest
See
AWSPinpointTargetingPhoneNumberValidateResponse
Declaration
Objective-C
- (void)phoneNumberValidate: (nonnull AWSPinpointTargetingPhoneNumberValidateRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingPhoneNumberValidateResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func phoneNumberValidate(_ request: AWSPinpointTargetingPhoneNumberValidateRequest) async throws -> AWSPinpointTargetingPhoneNumberValidateResponse
Parameters
request
A container for the necessary parameters to execute the PhoneNumberValidate service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
See
AWSPinpointTargetingPutEventStreamRequest
See
AWSPinpointTargetingPutEventStreamResponse
Declaration
Objective-C
- (nonnull AWSTask *)putEventStream: (nonnull AWSPinpointTargetingPutEventStreamRequest *)request;
Swift
func putEventStream(_ request: AWSPinpointTargetingPutEventStreamRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutEventStream service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSPinpointTargetingPutEventStreamResponse
. On failed execution,task.error
may contain anNSError
withAWSPinpointTargetingErrorDomain
domain and the following error code:AWSPinpointTargetingErrorBadRequest
,AWSPinpointTargetingErrorInternalServerError
,AWSPinpointTargetingErrorPayloadTooLarge
,AWSPinpointTargetingErrorForbidden
,AWSPinpointTargetingErrorNotFound
,AWSPinpointTargetingErrorMethodNotAllowed
,AWSPinpointTargetingErrorTooManyRequests
. -
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
See
AWSPinpointTargetingPutEventStreamRequest
See
AWSPinpointTargetingPutEventStreamResponse
Declaration
Objective-C
- (void)putEventStream: (nonnull AWSPinpointTargetingPutEventStreamRequest *)request completionHandler: (void (^_Nullable)( AWSPinpointTargetingPutEventStreamResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putEventStream(_ request: AWSPinpointTargetingPutEventStreamRequest) async throws -> AWSPinpointTargetingPutEventStreamResponse
Parameters