IoT / Client / update_domain_configuration

update_domain_configuration#

IoT.Client.update_domain_configuration(**kwargs)#

Updates values stored in the domain configuration. Domain configurations for default endpoints can’t be updated.

Requires permission to access the UpdateDomainConfiguration action.

See also: AWS API Documentation

Request Syntax

response = client.update_domain_configuration(
    domainConfigurationName='string',
    authorizerConfig={
        'defaultAuthorizerName': 'string',
        'allowAuthorizerOverride': True|False
    },
    domainConfigurationStatus='ENABLED'|'DISABLED',
    removeAuthorizerConfig=True|False,
    tlsConfig={
        'securityPolicy': 'string'
    },
    serverCertificateConfig={
        'enableOCSPCheck': True|False
    },
    authenticationType='CUSTOM_AUTH_X509'|'CUSTOM_AUTH'|'AWS_X509'|'AWS_SIGV4'|'DEFAULT',
    applicationProtocol='SECURE_MQTT'|'MQTT_WSS'|'HTTPS'|'DEFAULT',
    clientCertificateConfig={
        'clientCertificateCallbackArn': 'string'
    }
)
Parameters:

  • domainConfigurationName (string) –

    [REQUIRED]

    The name of the domain configuration to be updated.

  • 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) – The status to which the domain configuration should be updated.

  • removeAuthorizerConfig (boolean) – Removes the authorization configuration from a domain.

  • 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.

  • authenticationType (string) –

    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.

    • 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 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.

  • clientCertificateConfig (dict) –

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

    • clientCertificateCallbackArn (string) –

      The ARN of the Lambda function that IoT invokes after mutual TLS authentication during the connection.

Return type:

dict

Returns:

Response Syntax

{
    'domainConfigurationName': 'string',
    'domainConfigurationArn': 'string'
}

Response Structure

  • (dict) –

    • domainConfigurationName (string) –

      The name of the domain configuration that was updated.

    • domainConfigurationArn (string) –

      The ARN of the domain configuration that was updated.

Exceptions

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.CertificateValidationException

  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.UnauthorizedException

  • IoT.Client.exceptions.ServiceUnavailableException

  • IoT.Client.exceptions.InternalFailureException