Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
Request SyntaxGET /domainConfigurations/domainConfigurationName
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
The name of the domain configuration.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w.:-]+
Required: Yes
The request does not have a request body.
Response SyntaxHTTP/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.
An enumerated string that speciï¬es the application-layer protocol.
SECURE_MQTT
- MQTT over TLS.
MQTT_WSS
- MQTT over WebSocket.
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
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.
AWS_X509
- Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.
DEFAULT
- Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.
Type: String
Valid Values: CUSTOM_AUTH_X509 | CUSTOM_AUTH | AWS_X509 | AWS_SIGV4 | DEFAULT
An object that specifies the authorization service for a domain.
Type: AuthorizerConfig object
An object that speciï¬es the client certificate conï¬guration for a domain.
Type: ClientCertificateConfig object
The ARN of the domain configuration.
Type: String
The name of the domain configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: [\w.:-]+
A Boolean value that specifies the current state of the domain configuration.
Type: String
Valid Values: ENABLED | DISABLED
The name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern: [\s\S]*
The type of the domain.
Type: String
Valid Values: ENDPOINT | AWS_MANAGED | CUSTOMER_MANAGED
The date and time the domain configuration's status was last changed.
Type: Timestamp
The server certificate configuration.
Type: ServerCertificateConfig object
A list containing summary information about the server certificate included in the domain configuration.
Type: Array of ServerCertificateSummary objects
The type of service delivered by the endpoint.
Type: String
Valid Values: DATA | CREDENTIAL_PROVIDER | JOBS
An object that specifies the TLS configuration for a domain.
Type: TlsConfig object
An unexpected error has occurred.
HTTP Status Code: 500
The request is not valid.
HTTP Status Code: 400
The specified resource does not exist.
HTTP Status Code: 404
The service is temporarily unavailable.
HTTP Status Code: 503
The rate exceeds the limit.
HTTP Status Code: 400
You are not authorized to perform this operation.
HTTP Status Code: 401
For more information about using this API in one of the language-specific AWS SDKs, see the following:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4