DeletePlatformApplicationCommand

Suggest an Edit

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SNSClient, DeletePlatformApplicationCommand } from "@aws-sdk/client-sns"; // ES Modules import
// const { SNSClient, DeletePlatformApplicationCommand } = require("@aws-sdk/client-sns"); // CommonJS import
const client = new SNSClient(config);
const input = { // DeletePlatformApplicationInput
  PlatformApplicationArn: "STRING_VALUE", // required
};
const command = new DeletePlatformApplicationCommand(input);
const response = await client.send(command);
// {};

DeletePlatformApplicationCommand Input

See DeletePlatformApplicationCommandInput for more details

Parameter
Type
Description
PlatformApplicationArn
Required
string | undefined

PlatformApplicationArn of platform application object to delete.

DeletePlatformApplicationCommand Output

See DeletePlatformApplicationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AuthorizationErrorException
client

Indicates that the user has been denied access to the requested resource.

InternalErrorException
server

Indicates an internal service error.

InvalidParameterException
client

Indicates that a request parameter does not comply with the associated constraints.

SNSServiceException
Base exception class for all service exceptions from SNS service.