You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Pinpoint::Types::APNSVoipSandboxChannelResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#creation_dateString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#default_authentication_methodString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#enabledBoolean

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

Returns:

  • (Boolean)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#has_credentialBoolean

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

Returns:

  • (Boolean)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#has_token_keyBoolean

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.

Returns:

  • (Boolean)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#idString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#is_archivedBoolean

Specifies whether the APNs VoIP sandbox channel is archived.

Returns:

  • (Boolean)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#last_modified_byString

The user who last modified the APNs VoIP sandbox channel.

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#last_modified_dateString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#platformString

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

Returns:

  • (String)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end

#versionInteger

The current version of the APNs VoIP sandbox channel.

Returns:

  • (Integer)


1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1026

class APNSVoipSandboxChannelResponse < Struct.new(
  :application_id,
  :creation_date,
  :default_authentication_method,
  :enabled,
  :has_credential,
  :has_token_key,
  :id,
  :is_archived,
  :last_modified_by,
  :last_modified_date,
  :platform,
  :version)
  include Aws::Structure
end