Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . pinpoint ]

update-apns-sandbox-channel

Description

Updates the APNs sandbox channel settings for an application.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-apns-sandbox-channel
--apns-sandbox-channel-request <value>
--application-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--apns-sandbox-channel-request (structure)

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

Shorthand Syntax:

BundleId=string,Certificate=string,DefaultAuthenticationMethod=string,Enabled=boolean,PrivateKey=string,TeamId=string,TokenKey=string,TokenKeyId=string

JSON Syntax:

{
  "BundleId": "string",
  "Certificate": "string",
  "DefaultAuthenticationMethod": "string",
  "Enabled": true|false,
  "PrivateKey": "string",
  "TeamId": "string",
  "TokenKey": "string",
  "TokenKeyId": "string"
}

--application-id (string)

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

APNSSandboxChannelResponse -> (structure)

Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

ApplicationId -> (string)

The unique identifier for the application that the APNs sandbox channel applies to.

CreationDate -> (string)

The date and time when the APNs sandbox channel was enabled.

DefaultAuthenticationMethod -> (string)

The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

Enabled -> (boolean)

Specifies whether the APNs sandbox channel is enabled for the application.

HasCredential -> (boolean)

(Not used) This property is retained only for backward compatibility.

HasTokenKey -> (boolean)

Specifies whether the APNs sandbox 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 -> (string)

(Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the APNs sandbox channel is archived.

LastModifiedBy -> (string)

The user who last modified the APNs sandbox channel.

LastModifiedDate -> (string)

The date and time when the APNs sandbox channel was last modified.

Platform -> (string)

The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

Version -> (integer)

The current version of the APNs sandbox channel.