Class: Aws::SESV2::Types::GetEmailIdentityResponse

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

Overview

Details about an email identity.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#configuration_set_nameString

The configuration set used by default when sending from this identity.

Returns:

  • (String)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#dkim_attributesTypes::DkimAttributes

An object that contains information about the DKIM attributes for the identity.



3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#feedback_forwarding_statusBoolean

The feedback forwarding configuration for the identity.

If the value is ‘true`, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the `Return-Path` header of the original email.

You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Returns:

  • (Boolean)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#identity_typeString

The email identity type. Note: the ‘MANAGED_DOMAIN` identity type is not supported.

Returns:

  • (String)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#mail_from_attributesTypes::MailFromAttributes

An object that contains information about the Mail-From attributes for the email identity.



3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#policiesHash<String,String>

A map of policy names to policies.

Returns:

  • (Hash<String,String>)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An array of objects that define the tags (keys and values) that are associated with the email identity.

Returns:



3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#verification_infoTypes::VerificationInfo

An object that contains additional information about the verification status for the identity.



3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#verification_statusString

The verification status of the identity. The status can be one of the following:

  • ‘PENDING` – The verification process was initiated, but Amazon SES hasn’t yet been able to verify the identity.

  • ‘SUCCESS` – The verification process completed successfully.

  • ‘FAILED` – The verification process failed.

  • ‘TEMPORARY_FAILURE` – A temporary issue is preventing Amazon SES from determining the verification status of the identity.

  • ‘NOT_STARTED` – The verification process hasn’t been initiated for the identity.

Returns:

  • (String)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end

#verified_for_sending_statusBoolean

Specifies whether or not the identity is verified. You can only send email from verified email addresses or domains. For more information about verifying identities, see the [Amazon Pinpoint User Guide].

[1]: docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html

Returns:

  • (Boolean)


3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
# File 'lib/aws-sdk-sesv2/types.rb', line 3803

class GetEmailIdentityResponse < Struct.new(
  :identity_type,
  :feedback_forwarding_status,
  :verified_for_sending_status,
  :dkim_attributes,
  :mail_from_attributes,
  :policies,
  :tags,
  :configuration_set_name,
  :verification_status,
  :verification_info)
  SENSITIVE = []
  include Aws::Structure
end