Class: Aws::CognitoIdentityProvider::Types::MessageTemplateType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

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

{
  sms_message: "SmsVerificationMessageType",
  email_message: "EmailVerificationMessageType",
  email_subject: "EmailVerificationSubjectType",
}

The message template structure.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#email_message ⇒ String

The message template for email messages. EmailMessage is allowed only if [EmailSendingAccount] is DEVELOPER.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount

Returns:

  • (String) 


6974
6975
6976
6977
6978
6979
6980
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6974

class MessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject)
  SENSITIVE = []
  include Aws::Structure
end

#email_subject ⇒ String

The subject line for email messages. EmailSubject is allowed only if

EmailSendingAccount][1

is DEVELOPER.

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount

Returns:

  • (String) 


6974
6975
6976
6977
6978
6979
6980
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6974

class MessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject)
  SENSITIVE = []
  include Aws::Structure
end

#sms_message ⇒ String

The message template for SMS messages.

Returns:

  • (String) 


6974
6975
6976
6977
6978
6979
6980
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6974

class MessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject)
  SENSITIVE = []
  include Aws::Structure
end