Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. sesv2
  5. getEmailIdentity
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

aws.sesv2.getEmailIdentity

Explore with Pulumi AI

aws logo
AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-aws

    Data source for managing an AWS SESv2 (Simple Email V2) Email Identity.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.sesv2.getEmailIdentity({
    emailIdentity: "example.com",
});

    import pulumi
import pulumi_aws as aws

example = aws.sesv2.get_email_identity(email_identity="example.com")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sesv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sesv2.LookupEmailIdentity(ctx, &sesv2.LookupEmailIdentityArgs{
			EmailIdentity: "example.com",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.SesV2.GetEmailIdentity.Invoke(new()
    {
        EmailIdentity = "example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sesv2.Sesv2Functions;
import com.pulumi.aws.sesv2.inputs.GetEmailIdentityArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Sesv2Functions.getEmailIdentity(GetEmailIdentityArgs.builder()
            .emailIdentity("example.com")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:sesv2:getEmailIdentity
      arguments:
        emailIdentity: example.com

    Using getEmailIdentity

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEmailIdentity(args: GetEmailIdentityArgs, opts?: InvokeOptions): Promise<GetEmailIdentityResult>
function getEmailIdentityOutput(args: GetEmailIdentityOutputArgs, opts?: InvokeOptions): Output<GetEmailIdentityResult>
    def get_email_identity(email_identity: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetEmailIdentityResult
def get_email_identity_output(email_identity: Optional[pulumi.Input[str]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetEmailIdentityResult]
    func LookupEmailIdentity(ctx *Context, args *LookupEmailIdentityArgs, opts ...InvokeOption) (*LookupEmailIdentityResult, error)
func LookupEmailIdentityOutput(ctx *Context, args *LookupEmailIdentityOutputArgs, opts ...InvokeOption) LookupEmailIdentityResultOutput

    > Note: This function is named LookupEmailIdentity in the Go SDK.

    public static class GetEmailIdentity 
{
    public static Task<GetEmailIdentityResult> InvokeAsync(GetEmailIdentityArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailIdentityResult> Invoke(GetEmailIdentityInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEmailIdentityResult> getEmailIdentity(GetEmailIdentityArgs args, InvokeOptions options)
public static Output<GetEmailIdentityResult> getEmailIdentity(GetEmailIdentityArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:sesv2/getEmailIdentity:getEmailIdentity
  arguments:
    # arguments dictionary

    The following arguments are supported:

    EmailIdentity string
    The name of the email identity.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags.
    EmailIdentity string
    The name of the email identity.
    Tags map[string]string
    Key-value mapping of resource tags.
    emailIdentity String
    The name of the email identity.
    tags Map<String,String>
    Key-value mapping of resource tags.
    emailIdentity string
    The name of the email identity.
    tags {[key: string]: string}
    Key-value mapping of resource tags.
    email_identity str
    The name of the email identity.
    tags Mapping[str, str]
    Key-value mapping of resource tags.
    emailIdentity String
    The name of the email identity.
    tags Map<String>
    Key-value mapping of resource tags.

    getEmailIdentity Result

    The following output properties are available:

    Arn string
    ARN of the Email Identity.
    ConfigurationSetName string
    DkimSigningAttributes List<GetEmailIdentityDkimSigningAttribute>
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    EmailIdentity string
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags.
    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    Arn string
    ARN of the Email Identity.
    ConfigurationSetName string
    DkimSigningAttributes []GetEmailIdentityDkimSigningAttribute
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    EmailIdentity string
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    Tags map[string]string
    Key-value mapping of resource tags.
    VerifiedForSendingStatus bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    configurationSetName String
    dkimSigningAttributes List<GetEmailIdentityDkimSigningAttribute>
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    emailIdentity String
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Map<String,String>
    Key-value mapping of resource tags.
    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.
    arn string
    ARN of the Email Identity.
    configurationSetName string
    dkimSigningAttributes GetEmailIdentityDkimSigningAttribute[]
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    emailIdentity string
    id string
    The provider-assigned unique ID for this managed resource.
    identityType string
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags {[key: string]: string}
    Key-value mapping of resource tags.
    verifiedForSendingStatus boolean
    Specifies whether or not the identity is verified.
    arn str
    ARN of the Email Identity.
    configuration_set_name str
    dkim_signing_attributes Sequence[GetEmailIdentityDkimSigningAttribute]
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    email_identity str
    id str
    The provider-assigned unique ID for this managed resource.
    identity_type str
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Mapping[str, str]
    Key-value mapping of resource tags.
    verified_for_sending_status bool
    Specifies whether or not the identity is verified.
    arn String
    ARN of the Email Identity.
    configurationSetName String
    dkimSigningAttributes List<Property Map>
    A list of objects that contains at most one element with information about the private key and selector that you want to use to configure DKIM for the identity for Bring Your Own DKIM (BYODKIM) for the identity, or, configures the key length to be used for Easy DKIM.
    emailIdentity String
    id String
    The provider-assigned unique ID for this managed resource.
    identityType String
    The email identity type. Valid values: EMAIL_ADDRESS, DOMAIN.
    tags Map<String>
    Key-value mapping of resource tags.
    verifiedForSendingStatus Boolean
    Specifies whether or not the identity is verified.

    Supporting Types

    GetEmailIdentityDkimSigningAttribute

    CurrentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    DomainSigningPrivateKey string
    DomainSigningSelector string
    LastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    NextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    SigningAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    Status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    Tokens List<string>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    CurrentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    DomainSigningPrivateKey string
    DomainSigningSelector string
    LastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    NextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    SigningAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    Status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    Tokens []string
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength String
    [Easy DKIM] The key length of the DKIM key pair in use.
    domainSigningPrivateKey String
    domainSigningSelector String
    lastKeyGenerationTimestamp String
    [Easy DKIM] The last time a key pair was generated for this identity.
    nextSigningKeyLength String
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    signingAttributesOrigin String
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status String
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens List<String>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength string
    [Easy DKIM] The key length of the DKIM key pair in use.
    domainSigningPrivateKey string
    domainSigningSelector string
    lastKeyGenerationTimestamp string
    [Easy DKIM] The last time a key pair was generated for this identity.
    nextSigningKeyLength string
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    signingAttributesOrigin string
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status string
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens string[]
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    current_signing_key_length str
    [Easy DKIM] The key length of the DKIM key pair in use.
    domain_signing_private_key str
    domain_signing_selector str
    last_key_generation_timestamp str
    [Easy DKIM] The last time a key pair was generated for this identity.
    next_signing_key_length str
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    signing_attributes_origin str
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status str
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens Sequence[str]
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.
    currentSigningKeyLength String
    [Easy DKIM] The key length of the DKIM key pair in use.
    domainSigningPrivateKey String
    domainSigningSelector String
    lastKeyGenerationTimestamp String
    [Easy DKIM] The last time a key pair was generated for this identity.
    nextSigningKeyLength String
    [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.
    signingAttributesOrigin String
    A string that indicates how DKIM was configured for the identity. AWS_SES indicates that DKIM was configured for the identity by using Easy DKIM. EXTERNAL indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).
    status String
    Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. See the AWS SES API v2 Reference for supported statuses.
    tokens List<String>
    If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.73.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-aws