amazon-pinpoint/json-schema/amazon-pinpoint-apns-voip-channel-request-schema.json at main · api-evangelist/amazon-pinpoint · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
  "$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-voip-channel-request-schema.json",
  "title": "APNSVoipChannelRequest",
  "description": "Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.",
  "type": "object",
  "properties": {
    "BundleId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens."
        }
      ]
    },
    "Certificate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate."
        }
      ]
    },
    "DefaultAuthenticationMethod": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate."
        }
      ]
    },
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether to enable the APNs VoIP channel for the application."
        }
      ]
    },
    "PrivateKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs."
        }
      ]
    },
    "TeamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens."
        }
      ]
    },
    "TokenKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The authentication key to use for APNs tokens."
        }
      ]
    },
    "TokenKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens."
        }
      ]
    }
  }
}