Amazonka.SNS.CreatePlatformApplication

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

• For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
• For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
• For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
• For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.
• For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.
• For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
• For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

Creating a Request

data CreatePlatformApplication

Input for CreatePlatformApplication action.

See: newCreatePlatformApplication smart constructor.

Constructors

CreatePlatformApplication'

Fields

• name :: Text

  Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

• platform :: Text

  The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

• attributes :: HashMap Text Text

  For a list of attributes, see SetPlatformApplicationAttributes.

Instances

ToHeaders CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

toHeaders :: CreatePlatformApplication -> [Header]

ToPath CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

toPath :: CreatePlatformApplication -> ByteString

ToQuery CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

toQuery :: CreatePlatformApplication -> QueryString

AWSRequest CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Associated Types

type AWSResponse CreatePlatformApplication

Methods

request :: (Service -> Service) -> CreatePlatformApplication -> Request CreatePlatformApplication

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreatePlatformApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreatePlatformApplication)))

Generic CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Associated Types

type Rep CreatePlatformApplication :: Type -> Type

Methods

from :: CreatePlatformApplication -> Rep CreatePlatformApplication x

to :: Rep CreatePlatformApplication x -> CreatePlatformApplication

Read CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

readsPrec :: Int -> ReadS CreatePlatformApplication

readList :: ReadS [CreatePlatformApplication]

readPrec :: ReadPrec CreatePlatformApplication

readListPrec :: ReadPrec [CreatePlatformApplication]

Show CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

showsPrec :: Int -> CreatePlatformApplication -> ShowS

show :: CreatePlatformApplication -> String

showList :: [CreatePlatformApplication] -> ShowS

NFData CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

rnf :: CreatePlatformApplication -> ()

Eq CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

(==) :: CreatePlatformApplication -> CreatePlatformApplication -> Bool

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

Hashable CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

hashWithSalt :: Int -> CreatePlatformApplication -> Int

hash :: CreatePlatformApplication -> Int

type AWSResponse CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

type AWSResponse CreatePlatformApplication = CreatePlatformApplicationResponse

type Rep CreatePlatformApplication

Defined in Amazonka.SNS.CreatePlatformApplication

type Rep CreatePlatformApplication = D1 ('MetaData "CreatePlatformApplication" "Amazonka.SNS.CreatePlatformApplication" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "CreatePlatformApplication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text)))))

newCreatePlatformApplication

Arguments

:: Text

$sel:name:CreatePlatformApplication'

-> Text

$sel:platform:CreatePlatformApplication'

-> CreatePlatformApplication

Create a value of CreatePlatformApplication 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:name:CreatePlatformApplication', createPlatformApplication_name - Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

$sel:platform:CreatePlatformApplication', createPlatformApplication_platform - The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

CreatePlatformApplication, createPlatformApplication_attributes - For a list of attributes, see SetPlatformApplicationAttributes.

Request Lenses

createPlatformApplication_name :: Lens' CreatePlatformApplication Text

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

createPlatformApplication_platform :: Lens' CreatePlatformApplication Text

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

createPlatformApplication_attributes :: Lens' CreatePlatformApplication (HashMap Text Text)

For a list of attributes, see SetPlatformApplicationAttributes.

Destructuring the Response

data CreatePlatformApplicationResponse

Response from CreatePlatformApplication action.

See: newCreatePlatformApplicationResponse smart constructor.

Constructors

CreatePlatformApplicationResponse'

Fields

• platformApplicationArn :: Maybe Text

  PlatformApplicationArn is returned.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

Associated Types

type Rep CreatePlatformApplicationResponse :: Type -> Type

Methods

from :: CreatePlatformApplicationResponse -> Rep CreatePlatformApplicationResponse x

to :: Rep CreatePlatformApplicationResponse x -> CreatePlatformApplicationResponse

Read CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

readsPrec :: Int -> ReadS CreatePlatformApplicationResponse

readList :: ReadS [CreatePlatformApplicationResponse]

readPrec :: ReadPrec CreatePlatformApplicationResponse

readListPrec :: ReadPrec [CreatePlatformApplicationResponse]

Show CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

showsPrec :: Int -> CreatePlatformApplicationResponse -> ShowS

show :: CreatePlatformApplicationResponse -> String

showList :: [CreatePlatformApplicationResponse] -> ShowS

NFData CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

rnf :: CreatePlatformApplicationResponse -> ()

Eq CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

Methods

(==) :: CreatePlatformApplicationResponse -> CreatePlatformApplicationResponse -> Bool

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

type Rep CreatePlatformApplicationResponse

Defined in Amazonka.SNS.CreatePlatformApplication

type Rep CreatePlatformApplicationResponse = D1 ('MetaData "CreatePlatformApplicationResponse" "Amazonka.SNS.CreatePlatformApplication" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "CreatePlatformApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "platformApplicationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePlatformApplicationResponse

Arguments

:: Int

$sel:httpStatus:CreatePlatformApplicationResponse'

-> CreatePlatformApplicationResponse

Create a value of CreatePlatformApplicationResponse 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:

CreatePlatformApplicationResponse, createPlatformApplicationResponse_platformApplicationArn - PlatformApplicationArn is returned.

$sel:httpStatus:CreatePlatformApplicationResponse', createPlatformApplicationResponse_httpStatus - The response's http status code.

Response Lenses

createPlatformApplicationResponse_platformApplicationArn :: Lens' CreatePlatformApplicationResponse (Maybe Text)

PlatformApplicationArn is returned.

createPlatformApplicationResponse_httpStatus :: Lens' CreatePlatformApplicationResponse Int

The response's http status code.