UpdateDomainConfiguration - AWS IoT (original) (raw)
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
PUT /domainConfigurations/domainConfigurationName HTTP/1.1
Content-type: application/json
{
"applicationProtocol": "string",
"authenticationType": "string",
"authorizerConfig": {
"allowAuthorizerOverride": boolean,
"defaultAuthorizerName": "string"
},
"clientCertificateConfig": {
"clientCertificateCallbackArn": "string"
},
"domainConfigurationStatus": "string",
"removeAuthorizerConfig": boolean,
"serverCertificateConfig": {
"enableOCSPCheck": boolean,
"ocspAuthorizedResponderArn": "string",
"ocspLambdaArn": "string"
},
"tlsConfig": {
"securityPolicy": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
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.
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.
Type: String
Valid Values: SECURE_MQTT | MQTT_WSS | HTTPS | DEFAULT
Required: No
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 AWS 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.
Type: String
Valid Values: CUSTOM_AUTH_X509 | CUSTOM_AUTH | AWS_X509 | AWS_SIGV4 | DEFAULT
Required: No
An object that specifies the authorization service for a domain.
Type: AuthorizerConfig object
Required: No
An object that specifies the client certificate configuration for a domain.
Type: ClientCertificateConfig object
Required: No
The status to which the domain configuration should be updated.
Type: String
Valid Values: ENABLED | DISABLED
Required: No
Removes the authorization configuration from a domain.
Type: Boolean
Required: No
The server certificate configuration.
Type: ServerCertificateConfig object
Required: No
An object that specifies the TLS configuration for a domain.
Type: TlsConfig object
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.
The ARN of the domain configuration that was updated.
Type: String
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: