Amazonka.Pinpoint.Types.APNSChannelRequest

Documentation

data APNSChannelRequest

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

See: newAPNSChannelRequest smart constructor.

Constructors

APNSChannelRequest'

Fields

• bundleId :: Maybe Text

  The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

• certificate :: Maybe Text

  The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

• defaultAuthenticationMethod :: Maybe Text

  The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

• enabled :: Maybe Bool

  Specifies whether to enable the APNs channel for the application.

• privateKey :: Maybe Text

  The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

• teamId :: Maybe Text

  The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

• tokenKey :: Maybe Text

  The authentication key to use for APNs tokens.

• tokenKeyId :: Maybe Text

  The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

Instances

ToJSON APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

toJSON :: APNSChannelRequest -> Value

toEncoding :: APNSChannelRequest -> Encoding

toJSONList :: [APNSChannelRequest] -> Value

toEncodingList :: [APNSChannelRequest] -> Encoding

Generic APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Associated Types

type Rep APNSChannelRequest :: Type -> Type

Methods

from :: APNSChannelRequest -> Rep APNSChannelRequest x

to :: Rep APNSChannelRequest x -> APNSChannelRequest

Read APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

readsPrec :: Int -> ReadS APNSChannelRequest

readList :: ReadS [APNSChannelRequest]

readPrec :: ReadPrec APNSChannelRequest

readListPrec :: ReadPrec [APNSChannelRequest]

Show APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

showsPrec :: Int -> APNSChannelRequest -> ShowS

show :: APNSChannelRequest -> String

showList :: [APNSChannelRequest] -> ShowS

NFData APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

rnf :: APNSChannelRequest -> ()

Eq APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

(==) :: APNSChannelRequest -> APNSChannelRequest -> Bool

(/=) :: APNSChannelRequest -> APNSChannelRequest -> Bool

Hashable APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

Methods

hashWithSalt :: Int -> APNSChannelRequest -> Int

hash :: APNSChannelRequest -> Int

type Rep APNSChannelRequest

Defined in Amazonka.Pinpoint.Types.APNSChannelRequest

type Rep APNSChannelRequest = D1 ('MetaData "APNSChannelRequest" "Amazonka.Pinpoint.Types.APNSChannelRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "APNSChannelRequest'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bundleId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "defaultAuthenticationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "privateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "teamId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tokenKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tokenKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSChannelRequest :: APNSChannelRequest

Create a value of APNSChannelRequest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:bundleId:APNSChannelRequest', aPNSChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:certificate:APNSChannelRequest', aPNSChannelRequest_certificate - The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

$sel:defaultAuthenticationMethod:APNSChannelRequest', aPNSChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

$sel:enabled:APNSChannelRequest', aPNSChannelRequest_enabled - Specifies whether to enable the APNs channel for the application.

$sel:privateKey:APNSChannelRequest', aPNSChannelRequest_privateKey - The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

$sel:teamId:APNSChannelRequest', aPNSChannelRequest_teamId - The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

$sel:tokenKey:APNSChannelRequest', aPNSChannelRequest_tokenKey - The authentication key to use for APNs tokens.

$sel:tokenKeyId:APNSChannelRequest', aPNSChannelRequest_tokenKeyId - The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

aPNSChannelRequest_bundleId :: Lens' APNSChannelRequest (Maybe Text)

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

aPNSChannelRequest_certificate :: Lens' APNSChannelRequest (Maybe Text)

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

aPNSChannelRequest_defaultAuthenticationMethod :: Lens' APNSChannelRequest (Maybe Text)

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

aPNSChannelRequest_enabled :: Lens' APNSChannelRequest (Maybe Bool)

Specifies whether to enable the APNs channel for the application.

aPNSChannelRequest_privateKey :: Lens' APNSChannelRequest (Maybe Text)

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

aPNSChannelRequest_teamId :: Lens' APNSChannelRequest (Maybe Text)

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

aPNSChannelRequest_tokenKey :: Lens' APNSChannelRequest (Maybe Text)

The authentication key to use for APNs tokens.

aPNSChannelRequest_tokenKeyId :: Lens' APNSChannelRequest (Maybe Text)

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.