DescribeDomainConfiguration
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
{
"authorizerConfig": {
"allowAuthorizerOverride": boolean,
"defaultAuthorizerName": "string"
},
"domainConfigurationArn": "string",
"domainConfigurationName": "string",
"domainConfigurationStatus": "string",
"domainName": "string",
"domainType": "string",
"lastStatusChangeDate": number,
"serverCertificateConfig": {
"enableOCSPCheck": boolean
},
"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 object that specifies the authorization service for a domain.
Type: AuthorizerConfig object
- domainConfigurationArn
-
The ARN of the domain configuration.
Type: String
- domainConfigurationName
-
The name of the domain configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w.:-]+ - domainConfigurationStatus
-
A Boolean value that specifies the current state of the domain configuration.
Type: String
Valid Values:
ENABLED | DISABLED - domainName
-
The name of the domain.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
[\s\S]* - domainType
-
The type of the domain.
Type: String
Valid Values:
ENDPOINT | AWS_MANAGED | CUSTOMER_MANAGED - lastStatusChangeDate
-
The date and time the domain configuration's status was last changed.
Type: Timestamp
- serverCertificateConfig
-
The server certificate configuration.
Type: ServerCertificateConfig object
- serverCertificates
-
A list containing summary information about the server certificate included in the domain configuration.
Type: Array of ServerCertificateSummary objects
- serviceType
-
The type of service delivered by the endpoint.
Type: String
Valid Values:
DATA | CREDENTIAL_PROVIDER | JOBS - tlsConfig
-
An object that specifies the TLS configuration for a domain.
Type: TlsConfig object
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ServiceUnavailableException
-
The service is temporarily unavailable.
HTTP Status Code: 503
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- UnauthorizedException
-
You are not authorized to perform this operation.
HTTP Status Code: 401
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: