Skip to content

DescribeDomainConfigurationResponse

Source code in docs_src/capo_iot/types/describe_domain_configuration_response.py
class DescribeDomainConfigurationResponse(TypedDict, closed=True):
    domain_configuration_name: NotRequired[
        "capo_iot.types.reserved_domain_configuration_name.ReservedDomainConfigurationName"
    ]
    """<p>The name of the domain configuration.</p>"""
    domain_configuration_arn: NotRequired[
        "capo_iot.types.domain_configuration_arn.DomainConfigurationArn"
    ]
    """<p>The ARN of the domain configuration.</p>"""
    domain_name: NotRequired["capo_iot.types.domain_name.DomainName"]
    """<p>The name of the domain.</p>"""
    server_certificates: NotRequired[
        "capo_iot.types.server_certificates.ServerCertificates"
    ]
    """<p>A list containing summary information about the server certificate included in the domain configuration.</p>"""
    authorizer_config: NotRequired["capo_iot.types.authorizer_config.AuthorizerConfig"]
    """<p>An object that specifies the authorization service for a domain.</p>"""
    domain_configuration_status: NotRequired[
        "capo_iot.types.domain_configuration_status.DomainConfigurationStatus"
    ]
    """<p>A Boolean value that specifies the current state of the domain configuration.</p>"""
    service_type: NotRequired["capo_iot.types.service_type.ServiceType"]
    """<p>The type of service delivered by the endpoint.</p>"""
    domain_type: NotRequired["capo_iot.types.domain_type.DomainType"]
    """<p>The type of the domain.</p>"""
    last_status_change_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The date and time the domain configuration's status was last changed.</p>"""
    tls_config: NotRequired["capo_iot.types.tls_config.TlsConfig"]
    """<p>An object that specifies the TLS configuration for a domain.</p>"""
    server_certificate_config: NotRequired[
        "capo_iot.types.server_certificate_config.ServerCertificateConfig"
    ]
    """<p>The server certificate configuration.</p>"""
    authentication_type: NotRequired[
        "capo_iot.types.authentication_type.AuthenticationType"
    ]
    """<p>An enumerated string that specifies the authentication type.</p> <ul> <li> <p> <code>CUSTOM_AUTH_X509</code> - Use custom authentication and authorization with additional details from the X.509 client certificate.</p> </li> </ul> <ul> <li> <p> <code>CUSTOM_AUTH</code> - Use custom authentication and authorization. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html">Custom authentication and authorization</a>.</p> </li> </ul> <ul> <li> <p> <code>AWS_X509</code> - Use X.509 client certificates without custom authentication and authorization. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/x509-client-certs.html">X.509 client certificates</a>.</p> </li> </ul> <ul> <li> <p> <code>AWS_SIGV4</code> - Use Amazon Web Services Signature Version 4. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/custom-authentication.html">IAM users, groups, and roles</a>.</p> </li> </ul> <ul> <li> <p> <code>DEFAULT</code> - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html">Device communication protocols</a>.</p> </li> </ul>"""
    application_protocol: NotRequired[
        "capo_iot.types.application_protocol.ApplicationProtocol"
    ]
    """<p>An enumerated string that specifies the application-layer protocol.</p> <ul> <li> <p> <code>SECURE_MQTT</code> - MQTT over TLS.</p> </li> </ul> <ul> <li> <p> <code>MQTT_WSS</code> - MQTT over WebSocket.</p> </li> </ul> <ul> <li> <p> <code>HTTPS</code> - HTTP over TLS.</p> </li> </ul> <ul> <li> <p> <code>DEFAULT</code> - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/protocols.html">Device communication protocols</a>.</p> </li> </ul>"""
    client_certificate_config: NotRequired[
        "capo_iot.types.client_certificate_config.ClientCertificateConfig"
    ]
    """<p>An object that specifies the client certificate configuration for a domain.</p>"""

application_protocol instance-attribute

application_protocol: NotRequired[ApplicationProtocol]

An enumerated string that specifies 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.

authentication_type instance-attribute

authentication_type: NotRequired[AuthenticationType]

An enumerated string that specifies 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.

authorizer_config instance-attribute

authorizer_config: NotRequired[AuthorizerConfig]

An object that specifies the authorization service for a domain.

client_certificate_config instance-attribute

client_certificate_config: NotRequired[ClientCertificateConfig]

An object that specifies the client certificate configuration for a domain.

domain_configuration_arn instance-attribute

domain_configuration_arn: NotRequired[DomainConfigurationArn]

The ARN of the domain configuration.

domain_configuration_name instance-attribute

domain_configuration_name: NotRequired[ReservedDomainConfigurationName]

The name of the domain configuration.

domain_configuration_status instance-attribute

domain_configuration_status: NotRequired[DomainConfigurationStatus]

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

domain_name instance-attribute

domain_name: NotRequired[DomainName]

The name of the domain.

domain_type instance-attribute

domain_type: NotRequired[DomainType]

The type of the domain.

last_status_change_date instance-attribute

last_status_change_date: NotRequired[DateType]

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

server_certificate_config instance-attribute

server_certificate_config: NotRequired[ServerCertificateConfig]

The server certificate configuration.

server_certificates instance-attribute

server_certificates: NotRequired[ServerCertificates]

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

service_type instance-attribute

service_type: NotRequired[ServiceType]

The type of service delivered by the endpoint.

tls_config instance-attribute

tls_config: NotRequired[TlsConfig]

An object that specifies the TLS configuration for a domain.