/domainConfigurations/{domainConfigurationName}

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

Requires permission to access the UpdateDomainConfiguration action.

curl --location -g --request PUT 'https://api.iotwireless.{region}.amazonaws.com/domainConfigurations/' \ --header 'Content-Type: application/json' \ --data-raw '{ "authorizerConfig": { "defaultAuthorizerName": "string", "allowAuthorizerOverride": true }, "domainConfigurationStatus": "ENABLED", "removeAuthorizerConfig": true }'

Request

Path Params

domainConfigurationName

string

required

The name of the domain configuration to be updated.

Body Params application/json

authorizerConfig

object

optional

An object that specifies the authorization service for a domain.

defaultAuthorizerName

string

optional

The name of the authorization service for a domain configuration.

>= 1 characters<= 128 characters

Match pattern:

[\w=,@-]+

allowAuthorizerOverride

boolean

optional

A Boolean that specifies whether the domain configuration's authorization service can be overridden.

domainConfigurationStatus

enum<string>

optional

The status to which the domain configuration should be updated.

Allowed values:

ENABLEDDISABLED

removeAuthorizerConfig

boolean

optional

Removes the authorization configuration from a domain.

Examples

Responses

🟢200Success

application/json

Body

domainConfigurationName

string

optional

The name of the domain configuration that was updated.

>= 1 characters<= 128 characters

Match pattern:

[\w.:-]+

domainConfigurationArn

string

optional

The ARN of the domain configuration that was updated.

🟠480ResourceNotFoundException

🟠481CertificateValidationException

🟠482InvalidRequestException

🟠483ThrottlingException

🟠484UnauthorizedException

🟠485ServiceUnavailableException

🟠486InternalFailureException