IoT / Client / describe_domain_configuration
describe_domain_configuration#
- IoT.Client.describe_domain_configuration(**kwargs)#
Gets summary information about a domain configuration.
Requires permission to access the DescribeDomainConfiguration action.
See also: AWS API Documentation
Request Syntax
response = client.describe_domain_configuration( domainConfigurationName='string' )
- Parameters:
domainConfigurationName (string) –
[REQUIRED]
The name of the domain configuration.
- Return type:
dict
- Returns:
Response Syntax
{ 'domainConfigurationName': 'string', 'domainConfigurationArn': 'string', 'domainName': 'string', 'serverCertificates': [ { 'serverCertificateArn': 'string', 'serverCertificateStatus': 'INVALID'|'VALID', 'serverCertificateStatusDetail': 'string' }, ], 'authorizerConfig': { 'defaultAuthorizerName': 'string', 'allowAuthorizerOverride': True|False }, 'domainConfigurationStatus': 'ENABLED'|'DISABLED', 'serviceType': 'DATA'|'CREDENTIAL_PROVIDER'|'JOBS', 'domainType': 'ENDPOINT'|'AWS_MANAGED'|'CUSTOMER_MANAGED', 'lastStatusChangeDate': datetime(2015, 1, 1), 'tlsConfig': { 'securityPolicy': 'string' } }
Response Structure
(dict) –
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.
(dict) –
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 (dict) –
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 (datetime) –
The date and time the domain configuration’s status was last changed.
tlsConfig (dict) –
An object that specifies the TLS configuration for a domain.
securityPolicy (string) –
The security policy for a domain configuration. For more information, see Security policies in the Amazon Web Services IoT Core developer guide.
Exceptions
IoT.Client.exceptions.ResourceNotFoundException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.UnauthorizedException
IoT.Client.exceptions.ServiceUnavailableException
IoT.Client.exceptions.InternalFailureException