Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutDefaultApplicationSetting

Sets the default application to the application with the specified ARN.

To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.

Request Syntax


PUT /2021-01-01/opensearch/defaultApplicationSetting HTTP/1.1
Content-type: application/json

{
   "applicationArn": "string",
   "setAsDefault": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applicationArn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*

Required: Yes

setAsDefault

Set to true to set the specified ARN as the default application. Set to false to clear the default application.

Type: Boolean

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "applicationArn": "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.

applicationArn

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An error occurred because you don't have permissions to access the resource.

HTTP Status Code: 403

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400