Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
See also: AWS API Documentation
get-apns-voip-sandbox-channel --application-id <value> [--cli-input-json | --cli-input-yaml] [--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>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
APNSVoipSandboxChannelResponse -> (structure)
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.
ApplicationId -> (string)The unique identifier for the application that the APNs VoIP sandbox channel applies to.
CreationDate -> (string)The date and time when the APNs VoIP 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 VoIP 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 VoIP 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 VoIP sandbox channel. This property is retained only for backward compatibility.
IsArchived -> (boolean)Specifies whether the APNs VoIP sandbox channel is archived.
LastModifiedBy -> (string)The user who last modified the APNs VoIP sandbox channel.
LastModifiedDate -> (string)The date and time when the APNs VoIP sandbox channel was last modified.
Platform -> (string)The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
Version -> (integer)The current version of the APNs VoIP sandbox channel.