AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . pinpoint ]

update-apns-channel

Description

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

See also: AWS API Documentation

Synopsis

  update-apns-channel
--apns-channel-request <value>
--application-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--apns-channel-request (structure)

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

BundleId -> (string)

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

Certificate -> (string)

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

DefaultAuthenticationMethod -> (string)

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

Enabled -> (boolean)

Specifies whether to enable the APNs channel for the application.

PrivateKey -> (string)

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

TeamId -> (string)

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

TokenKey -> (string)

The authentication key to use for APNs tokens.

TokenKeyId -> (string)

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

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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

APNSChannelResponse -> (structure)

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

ApplicationId -> (string)

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

CreationDate -> (string)

The date and time when the APNs channel was enabled.

DefaultAuthenticationMethod -> (string)

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

Enabled -> (boolean)

Specifies whether the APNs channel is enabled for the application.

HasCredential -> (boolean)

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

HasTokenKey -> (boolean)

Specifies whether the APNs 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 channel. This property is retained only for backward compatibility.

IsArchived -> (boolean)

Specifies whether the APNs channel is archived.

LastModifiedBy -> (string)

The user who last modified the APNs channel.

LastModifiedDate -> (string)

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

Platform -> (string)

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

Version -> (integer)

The current version of the APNs channel.