put-email-identity-dkim-signing-attributes¶
Description¶
Used to configure or change the DKIM authentication settings for an email domain identity. You can use this operation to do any of the following:
Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
Update the key length that should be used for Easy DKIM.
Change from using no DKIM authentication to using Easy DKIM.
Change from using no DKIM authentication to using BYODKIM.
Change from using Easy DKIM to using BYODKIM.
Change from using BYODKIM to using Easy DKIM.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
put-email-identity-dkim-signing-attributes
--email-identity <value>
--signing-attributes-origin <value>
[--signing-attributes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--email-identity (string)
The email identity.
--signing-attributes-origin (string)
The method to use to configure DKIM for the identity. There are the following possible values:
AWS_SES– Configure DKIM for the identity by using Easy DKIM .
EXTERNAL– Configure DKIM for the identity by using Bring Your Own DKIM (BYODKIM).Possible values:
AWS_SES
EXTERNAL
--signing-attributes (structure)
An object that contains 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 .
DomainSigningSelector -> (string)
[Bring Your Own DKIM] A string that’s used to identify a public key in the DNS configuration for a domain.
DomainSigningPrivateKey -> (string)
[Bring Your Own DKIM] A private key that’s used to generate a DKIM signature.
The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding.
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.
Shorthand Syntax:
DomainSigningSelector=string,DomainSigningPrivateKey=string,NextSigningKeyLength=string
JSON Syntax:
{
"DomainSigningSelector": "string",
"DomainSigningPrivateKey": "string",
"NextSigningKeyLength": "RSA_1024_BIT"|"RSA_2048_BIT"
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
DkimStatus -> (string)
The DKIM authentication status of the identity. Amazon SES determines the authentication status by searching for specific records in the DNS configuration for your domain. If you used Easy DKIM to set up DKIM authentication, Amazon SES tries to find three unique CNAME records in the DNS configuration for your domain.
If you provided a public key to perform DKIM authentication, Amazon SES tries to find a TXT record that uses the selector that you specified. The value of the TXT record must be a public key that’s paired with the private key that you specified in the process of creating the identity.
The status can be one of the following:
PENDING– The verification process was initiated, but Amazon SES hasn’t yet detected the DKIM records in the DNS configuration for the domain.
SUCCESS– The verification process completed successfully.
FAILED– The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.
TEMPORARY_FAILURE– A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.
NOT_STARTED– The DKIM verification process hasn’t been initiated for the domain.
DkimTokens -> (list)
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 that’s associated with your public key.
Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.
(string)