Amazon Pinpoint · Schema
APNSChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics
Properties
| Name | Type | Description |
|---|---|---|
| ApplicationId | object | |
| CreationDate | object | |
| DefaultAuthenticationMethod | object | |
| Enabled | object | |
| HasCredential | object | |
| HasTokenKey | object | |
| Id | object | |
| IsArchived | object | |
| LastModifiedBy | object | |
| LastModifiedDate | object | |
| Platform | object | |
| Version | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-apns-channel-response-schema.json",
"title": "APNSChannelResponse",
"description": "Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.",
"type": "object",
"properties": {
"ApplicationId": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The unique identifier for the application that the APNs channel applies to."
}
]
},
"CreationDate": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The date and time when the APNs channel was enabled."
}
]
},
"DefaultAuthenticationMethod": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate."
}
]
},
"Enabled": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "Specifies whether the APNs channel is enabled for the application."
}
]
},
"HasCredential": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "(Not used) This property is retained only for backward compatibility."
}
]
},
"HasTokenKey": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel."
}
]
},
"Id": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility."
}
]
},
"IsArchived": {
"allOf": [
{
"$ref": "#/components/schemas/__boolean"
},
{
"description": "Specifies whether the APNs channel is archived."
}
]
},
"LastModifiedBy": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The user who last modified the APNs channel."
}
]
},
"LastModifiedDate": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": "The date and time when the APNs channel was last modified."
}
]
},
"Platform": {
"allOf": [
{
"$ref": "#/components/schemas/__string"
},
{
"description": " <p>The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.</p>"
}
]
},
"Version": {
"allOf": [
{
"$ref": "#/components/schemas/__integer"
},
{
"description": "The current version of the APNs channel."
}
]
}
},
"required": [
"Platform"
]
}