Class EmailChannelResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EmailChannelResponse.Builder,
EmailChannelResponse>
Provides information about the status and settings of the email channel for an application.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the application that the email channel applies to.static EmailChannelResponse.Builder
builder()
final String
The Amazon SES configuration set that's applied to messages that are sent through the channel.final String
The date and time, in ISO 8601 format, when the email channel was enabled.final Boolean
enabled()
Specifies whether the email channel is enabled for the application.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The verified email address that email is sent from when you send email through the channel.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final Boolean
(Not used) This property is retained only for backward compatibility.final int
hashCode()
final String
id()
(Deprecated) An identifier for the email channel.final String
identity()
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.final Boolean
Specifies whether the email channel is archived.final String
The user who last modified the email channel.final String
The date and time, in ISO 8601 format, when the email channel was last modified.final Integer
The maximum number of emails that can be sent through the channel each second.final String
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.final String
platform()
The type of messaging or notification platform for the channel.final String
roleArn()
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.static Class
<? extends EmailChannelResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
version()
The current version of the email channel.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The unique identifier for the application that the email channel applies to.
- Returns:
- The unique identifier for the application that the email channel applies to.
-
configurationSet
The Amazon SES configuration set that's applied to messages that are sent through the channel.
- Returns:
- The Amazon SES configuration set that's applied to messages that are sent through the channel.
-
creationDate
The date and time, in ISO 8601 format, when the email channel was enabled.
- Returns:
- The date and time, in ISO 8601 format, when the email channel was enabled.
-
enabled
Specifies whether the email channel is enabled for the application.
- Returns:
- Specifies whether the email channel is enabled for the application.
-
fromAddress
The verified email address that email is sent from when you send email through the channel.
- Returns:
- The verified email address that email is sent from when you send email through the channel.
-
hasCredential
(Not used) This property is retained only for backward compatibility.
- Returns:
- (Not used) This property is retained only for backward compatibility.
-
id
(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
- Returns:
- (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
-
identity
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
- Returns:
The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
-
isArchived
Specifies whether the email channel is archived.
- Returns:
- Specifies whether the email channel is archived.
-
lastModifiedBy
The user who last modified the email channel.
- Returns:
- The user who last modified the email channel.
-
lastModifiedDate
The date and time, in ISO 8601 format, when the email channel was last modified.
- Returns:
- The date and time, in ISO 8601 format, when the email channel was last modified.
-
messagesPerSecond
The maximum number of emails that can be sent through the channel each second.
- Returns:
- The maximum number of emails that can be sent through the channel each second.
-
platform
The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
- Returns:
- The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
-
roleArn
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
- Returns:
The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
-
orchestrationSendingRoleArn
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
- Returns:
- The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
-
version
The current version of the email channel.
- Returns:
- The current version of the email channel.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EmailChannelResponse.Builder,
EmailChannelResponse> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-