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

Class: Aws::Pinpoint::Types::APNSChannelRequest

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

Overview

Note:

When making an API call, you may pass APNSChannelRequest data as a hash:

{
  bundle_id: "__string",
  certificate: "__string",
  default_authentication_method: "__string",
  enabled: false,
  private_key: "__string",
  team_id: "__string",
  token_key: "__string",
  token_key_id: "__string",
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_id ⇒ String

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

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#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.

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#default_authentication_method ⇒ String

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

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether to enable the APNs channel for the application.

Returns:

  • (Boolean) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#private_key ⇒ String

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

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#team_id ⇒ String

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

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_key ⇒ String

The authentication key to use for APNs tokens.

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end

#token_key_id ⇒ 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.

Returns:

  • (String) 


318
319
320
321
322
323
324
325
326
327
328
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 318

class APNSChannelRequest < Struct.new(
  :bundle_id,
  :certificate,
  :default_authentication_method,
  :enabled,
  :private_key,
  :team_id,
  :token_key,
  :token_key_id)
  include Aws::Structure
end