[ aws . iot ]

describe-domain-configuration

Description

Gets summary information about a domain configuration.

Note

The domain configuration feature is in public preview and is subject to change.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-domain-configuration
--domain-configuration-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-configuration-name (string)

The name of the domain configuration.

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

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a domain configuration

The following describe-domain-configuration example displays details about the specified domain configuration.

aws iot describe-domain-configuration \
    --domain-configuration-name "additionalDataDomain"

Output:

{
    "domainConfigurationName": "additionalDataDomain",
    "domainConfigurationArn": "arn:aws:iot:us-east-1:758EXAMPLE143:domainconfiguration/additionalDataDomain/norpw",
    "domainName": "d055exampleed74y71zfd-ats.beta.us-east-1.iot.amazonaws.com",
    "serverCertificates": [],
    "domainConfigurationStatus": "ENABLED",
    "serviceType": "DATA",
    "domainType": "AWS_MANAGED",
    "lastStatusChangeDate": 1601923783.774
}

For more information, see Configurable Endpoints in the AWS IoT Developer Guide.

Output

domainConfigurationName -> (string)

The name of the domain configuration.

domainConfigurationArn -> (string)

The ARN of the domain configuration.

domainName -> (string)

The name of the domain.

serverCertificates -> (list)

A list containing summary information about the server certificate included in the domain configuration.

(structure)

An object that contains information about a server certificate.

serverCertificateArn -> (string)

The ARN of the server certificate.

serverCertificateStatus -> (string)

The status of the server certificate.

serverCertificateStatusDetail -> (string)

Details that explain the status of the server certificate.

authorizerConfig -> (structure)

An object that specifies the authorization service for a domain.

defaultAuthorizerName -> (string)

The name of the authorization service for a domain configuration.

allowAuthorizerOverride -> (boolean)

A Boolean that specifies whether the domain configuration’s authorization service can be overridden.

domainConfigurationStatus -> (string)

A Boolean value that specifies the current state of the domain configuration.

serviceType -> (string)

The type of service delivered by the endpoint.

domainType -> (string)

The type of the domain.

lastStatusChangeDate -> (timestamp)

The date and time the domain configuration’s status was last changed.