UpdateApnsChannelCommand

Suggest an Edit

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

Example Syntax

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

import { PinpointClient, UpdateApnsChannelCommand } from "@aws-sdk/client-pinpoint"; // ES Modules import
// const { PinpointClient, UpdateApnsChannelCommand } = require("@aws-sdk/client-pinpoint"); // CommonJS import
const client = new PinpointClient(config);
const input = { // UpdateApnsChannelRequest
  APNSChannelRequest: { // APNSChannelRequest
    BundleId: "STRING_VALUE",
    Certificate: "STRING_VALUE",
    DefaultAuthenticationMethod: "STRING_VALUE",
    Enabled: true || false,
    PrivateKey: "STRING_VALUE",
    TeamId: "STRING_VALUE",
    TokenKey: "STRING_VALUE",
    TokenKeyId: "STRING_VALUE",
  },
  ApplicationId: "STRING_VALUE", // required
};
const command = new UpdateApnsChannelCommand(input);
const response = await client.send(command);
// { // UpdateApnsChannelResponse
//   APNSChannelResponse: { // APNSChannelResponse
//     ApplicationId: "STRING_VALUE",
//     CreationDate: "STRING_VALUE",
//     DefaultAuthenticationMethod: "STRING_VALUE",
//     Enabled: true || false,
//     HasCredential: true || false,
//     HasTokenKey: true || false,
//     Id: "STRING_VALUE",
//     IsArchived: true || false,
//     LastModifiedBy: "STRING_VALUE",
//     LastModifiedDate: "STRING_VALUE",
//     Platform: "STRING_VALUE", // required
//     Version: Number("int"),
//   },
// };

UpdateApnsChannelCommand Input

See UpdateApnsChannelCommandInput for more details

Parameter
Type
Description
APNSChannelRequest
Required
APNSChannelRequest | undefined

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

ApplicationId
Required
string | undefined

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

UpdateApnsChannelCommand Output

See UpdateApnsChannelCommandOutput for details

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

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

Throws

Name
Fault
Details
BadRequestException
client

Provides information about an API request or response.

ForbiddenException
client

Provides information about an API request or response.

InternalServerErrorException
server

Provides information about an API request or response.

MethodNotAllowedException
client

Provides information about an API request or response.

NotFoundException
client

Provides information about an API request or response.

PayloadTooLargeException
client

Provides information about an API request or response.

TooManyRequestsException
client

Provides information about an API request or response.

PinpointServiceException
Base exception class for all service exceptions from Pinpoint service.