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.

Request Syntax

response = client.update_domain_configuration(
    domainConfigurationName='string',
    authorizerConfig={
        'defaultAuthorizerName': 'string',
        'allowAuthorizerOverride': True|False
    },
    domainConfigurationStatus='ENABLED'|'DISABLED',
    removeAuthorizerConfig=True|False
)

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.

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