/domainConfigurations/{domainConfigurationName}

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

{ "domainConfigurationName": "string", "domainConfigurationArn": "string", "domainName": "string", "serverCertificates": [], "authorizerConfig": { "defaultAuthorizerName": "string", "allowAuthorizerOverride": true }, "domainConfigurationStatus": "ENABLED", "serviceType": "DATA", "domainType": "ENDPOINT", "lastStatusChangeDate": "string" }

Responses

🟢200Success

application/json

Body

domainConfigurationName

string

optional

The name of the domain configuration.

>= 1 characters<= 128 characters

Match pattern:

[\w.:-]+

domainConfigurationArn

string

optional

The ARN of the domain configuration.

domainName

string

optional

The name of the domain.

>= 1 characters<= 253 characters

serverCertificates

array[object (ServerCertificateSummary) {3}]

optional

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

serverCertificateArn

string

optional

The ARN of the server certificate.

>= 1 characters<= 2048 characters

Match pattern:

arn:aws(-cn|-us-gov|-iso-b|-iso)?:acm:[a-z]{2}-(gov-|iso-|isob-)?[a-z]{4,9}-\d{1}:\d{12}:certificate/[a-zA-Z0-9/-]+

serverCertificateStatus

enum<string>

optional

The status of the server certificate.

Allowed values:

INVALIDVALID

serverCertificateStatusDetail

string

optional

Details that explain the status of the server certificate.

authorizerConfig

object

optional

An object that specifies the authorization service for a domain.

defaultAuthorizerName

string

optional

The name of the authorization service for a domain configuration.

>= 1 characters<= 128 characters

Match pattern:

[\w=,@-]+

allowAuthorizerOverride

boolean

optional

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

domainConfigurationStatus

enum<string>

optional

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

Allowed values:

ENABLEDDISABLED

serviceType

enum<string>

optional

The type of service delivered by the endpoint.

Allowed values:

DATACREDENTIAL_PROVIDERJOBS

domainType

enum<string>

optional

The type of the domain.

Allowed values:

ENDPOINTAWS_MANAGEDCUSTOMER_MANAGED

lastStatusChangeDate

string <date-time>

optional

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

🟠480ResourceNotFoundException

🟠481ThrottlingException

🟠482InvalidRequestException

🟠483UnauthorizedException

🟠484ServiceUnavailableException

🟠485InternalFailureException