[ aws . acm ]

describe-acme-domain-validation

Description

Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.

See also: AWS API Documentation

Synopsis

  describe-acme-domain-validation
--acme-domain-validation-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--acme-domain-validation-arn (string) [required]

The Amazon Resource Name (ARN) of the ACME domain validation.

Constraints:

• min: 1
• max: 200
• pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream
• off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

Output

AcmeDomainValidation -> (structure)

The ACME domain validation details.

AcmeDomainValidationArn -> (string)

The Amazon Resource Name (ARN) of the ACME domain validation.

Constraints:

• min: 1
• max: 200
• pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+/acme-domain-validation/[a-zA-Z0-9-]+

AcmeEndpointArn -> (string)

The Amazon Resource Name (ARN) of the ACME endpoint.

Constraints:

• min: 1
• max: 200
• pattern: arn:aws[a-z-]*:acm:[a-z0-9-]+:[0-9]{12}:acme-endpoint/[a-zA-Z0-9-]+

DomainName -> (string)

The domain name being validated.

Constraints:

• min: 1
• max: 253
• pattern: ([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)*[a-z0-9]([a-z0-9-]*[a-z0-9])?

PrevalidationType -> (string)

The type of prevalidation used.

Possible values:

• DNS_PREVALIDATION

PrevalidationDetails -> (tagged union structure)

Details about the prevalidation configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DnsPrevalidation.

DnsPrevalidation -> (structure)

DNS-based prevalidation details.

DomainScope -> (structure)

The scope of domains covered by this prevalidation.

ExactDomain -> (string)

Whether validation applies to the exact domain.

Possible values:

• ENABLED
• DISABLED

Subdomains -> (string)

Whether validation applies to subdomains.

Possible values:

• ENABLED
• DISABLED

Wildcards -> (string)

Whether validation applies to wildcard domains.

Possible values:

• ENABLED
• DISABLED

HostedZoneId -> (string)

The Route 53 hosted zone ID for DNS validation.

Constraints:

• min: 1
• max: 32
• pattern: Z[A-Z0-9]+

ResourceRecord -> (structure)

The DNS resource record to create for domain validation.

Name -> (string) [required]

The name of the DNS record to create in your domain. This is supplied by ACM.

Type -> (string) [required]

The type of DNS record. Currently this can be CNAME .

Possible values:

• CNAME

Value -> (string) [required]

The value of the CNAME record to add to your DNS database. This is supplied by ACM.

Status -> (string)

The status of the domain validation.

Possible values:

• VALIDATING
• VALID
• INVALID
• DELETING

FailureDetails -> (structure)

Details about the failure, if the validation failed.

Reason -> (string)

The reason for the failure.

Possible values:

• ACCESS_DENIED
• DOMAIN_MISMATCH
• DOMAIN_NOT_ALLOWED
• ENDPOINT_NOT_ACTIVE
• HOSTED_ZONE_NOT_FOUND
• INTERNAL_FAILURE
• INVALID_CHANGE_BATCH
• INVALID_PUBLIC_DOMAIN
• TIMED_OUT

Message -> (string)

A message describing the failure.

CreatedAt -> (timestamp)

The time at which the domain validation was created.

UpdatedAt -> (timestamp)

The time at which the domain validation was last updated.