UpdateDomainConfiguration - AWS IoT
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

UpdateDomainConfiguration

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

Note

The domain configuration feature is in public preview and is subject to change.

Request Syntax

PUT /domainConfigurations/domainConfigurationName HTTP/1.1 Content-type: application/json { "authorizerConfig": { "allowAuthorizerOverride": boolean, "defaultAuthorizerName": "string" }, "domainConfigurationStatus": "string", "removeAuthorizerConfig": boolean }

URI Request Parameters

The request uses the following URI parameters.

domainConfigurationName

The name of the domain configuration to be updated.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w.:-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

authorizerConfig

An object that specifies the authorization service for a domain.

Type: AuthorizerConfig object

Required: No

domainConfigurationStatus

The status to which the domain configuration should be updated.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

removeAuthorizerConfig

Removes the authorization configuration from a domain.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "domainConfigurationArn": "string", "domainConfigurationName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

domainConfigurationArn

The ARN of the domain configuration that was updated.

Type: String

domainConfigurationName

The name of the domain configuration that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w.:-]+

Errors

CertificateValidationException

The certificate is invalid.

HTTP Status Code: 400

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: