OpenSearchService / Client / put_default_application_setting

put_default_application_setting¶

OpenSearchService.Client.put_default_application_setting(**kwargs)¶

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

response = client.put_default_application_setting(
    applicationArn='string',
    setAsDefault=True|False
)

Parameters:

applicationArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
setAsDefault (boolean) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'applicationArn': 'string'
}

Response Structure

(dict) –
- applicationArn (string) –
  
  The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

Exceptions

OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.AccessDeniedException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException