DescribeDomainConfiguration - AWS IoT (original) (raw)

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

Request Syntax

GET /domainConfigurations/domainConfigurationName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainConfigurationName

The name of the domain configuration.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w.:-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "applicationProtocol": "string",
   "authenticationType": "string",
   "authorizerConfig": { 
      "allowAuthorizerOverride": boolean,
      "defaultAuthorizerName": "string"
   },
   "clientCertificateConfig": { 
      "clientCertificateCallbackArn": "string"
   },
   "domainConfigurationArn": "string",
   "domainConfigurationName": "string",
   "domainConfigurationStatus": "string",
   "domainName": "string",
   "domainType": "string",
   "lastStatusChangeDate": number,
   "serverCertificateConfig": { 
      "enableOCSPCheck": boolean,
      "ocspAuthorizedResponderArn": "string",
      "ocspLambdaArn": "string"
   },
   "serverCertificates": [ 
      { 
         "serverCertificateArn": "string",
         "serverCertificateStatus": "string",
         "serverCertificateStatusDetail": "string"
      }
   ],
   "serviceType": "string",
   "tlsConfig": { 
      "securityPolicy": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

applicationProtocol

An enumerated string that speciﬁes the application-layer protocol.

SECURE_MQTT - MQTT over TLS.
MQTT_WSS - MQTT over WebSocket.
HTTPS - HTTP over TLS.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

Type: String

Valid Values: SECURE_MQTT | MQTT_WSS | HTTPS | DEFAULT

authenticationType

An enumerated string that speciﬁes the authentication type.

CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.
CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.
AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
AWS_SIGV4 - Use AWS Signature Version 4. For more information, see IAM users, groups, and roles.
DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.