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.

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'
    },
    'serverCertificateConfig': {
        'enableOCSPCheck': True|False,
        'ocspLambdaArn': 'string',
        'ocspAuthorizedResponderArn': 'string'
    },
    'authenticationType': 'CUSTOM_AUTH_X509'|'CUSTOM_AUTH'|'AWS_X509'|'AWS_SIGV4'|'DEFAULT',
    'applicationProtocol': 'SECURE_MQTT'|'MQTT_WSS'|'HTTPS'|'DEFAULT',
    'clientCertificateConfig': {
        'clientCertificateCallbackArn': '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.
- serverCertificateConfig (dict) –
  
  The server certificate configuration.
  - enableOCSPCheck (boolean) –
    
    A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.
    
    For more information, see Server certificate configuration for OCSP stapling from Amazon Web Services IoT Core Developer Guide.
  - ocspLambdaArn (string) –
    
    The Amazon Resource Name (ARN) for a Lambda function that acts as a Request for Comments (RFC) 6960-compliant Online Certificate Status Protocol (OCSP) responder, supporting basic OCSP responses. The Lambda function accepts a base64-encoding of the OCSP request in the Distinguished Encoding Rules (DER) format. The Lambda function’s response is also a base64-encoded OCSP response in the DER format. The response size must not exceed 4 kilobytes (KiB). The Lambda function must be in the same Amazon Web Services account and region as the domain configuration. For more information, see Configuring server certificate OCSP for private endpoints in Amazon Web Services IoT Core from the Amazon Web Services IoT Core developer guide.
  - ocspAuthorizedResponderArn (string) –
    
    The Amazon Resource Name (ARN) for an X.509 certificate stored in Amazon Web Services Certificate Manager (ACM). If provided, Amazon Web Services IoT Core will use this certificate to validate the signature of the received OCSP response. The OCSP responder must sign responses using either this authorized responder certificate or the issuing certificate, depending on whether the ARN is provided or not. The certificate must be in the same Amazon Web Services account and region as the domain configuration.
- authenticationType (string) –
  
  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 Amazon Web Services 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.
- applicationProtocol (string) –
  
  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.
- clientCertificateConfig (dict) –
  
  An object that speciﬁes the client certificate conﬁguration for a domain.
  - clientCertificateCallbackArn (string) –
    
    The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.

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