amazonka-pinpoint-2.0: Amazon Pinpoint SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Description

 
Synopsis

Documentation

data APNSVoipChannelRequest Source #

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

See: newAPNSVoipChannelRequest smart constructor.

Constructors

APNSVoipChannelRequest' 

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 VoIP 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

Instances details
ToJSON APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Generic APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Associated Types

type Rep APNSVoipChannelRequest :: Type -> Type #

Read APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Show APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

NFData APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Methods

rnf :: APNSVoipChannelRequest -> () #

Eq APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

Hashable APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

type Rep APNSVoipChannelRequest Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.APNSVoipChannelRequest

type Rep APNSVoipChannelRequest = D1 ('MetaData "APNSVoipChannelRequest" "Amazonka.Pinpoint.Types.APNSVoipChannelRequest" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "APNSVoipChannelRequest'" '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))))))

newAPNSVoipChannelRequest :: APNSVoipChannelRequest Source #

Create a value of APNSVoipChannelRequest 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:APNSVoipChannelRequest', aPNSVoipChannelRequest_bundleId - The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

$sel:certificate:APNSVoipChannelRequest', aPNSVoipChannelRequest_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:APNSVoipChannelRequest', aPNSVoipChannelRequest_defaultAuthenticationMethod - The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

$sel:enabled:APNSVoipChannelRequest', aPNSVoipChannelRequest_enabled - Specifies whether to enable the APNs VoIP channel for the application.

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

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

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

$sel:tokenKeyId:APNSVoipChannelRequest', aPNSVoipChannelRequest_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.

aPNSVoipChannelRequest_bundleId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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

aPNSVoipChannelRequest_certificate :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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

aPNSVoipChannelRequest_defaultAuthenticationMethod :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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

aPNSVoipChannelRequest_enabled :: Lens' APNSVoipChannelRequest (Maybe Bool) Source #

Specifies whether to enable the APNs VoIP channel for the application.

aPNSVoipChannelRequest_privateKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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

aPNSVoipChannelRequest_teamId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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

aPNSVoipChannelRequest_tokenKey :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

The authentication key to use for APNs tokens.

aPNSVoipChannelRequest_tokenKeyId :: Lens' APNSVoipChannelRequest (Maybe Text) Source #

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