UpdateApplication
Updates the configuration and settings of an existing OpenSearch application.
Request Syntax
PUT /2021-01-01/opensearch/application/id HTTP/1.1
Content-type: application/json
{
"appConfigs": [
{
"key": "string",
"value": "string"
}
],
"dataSources": [
{
"dataSourceArn": "string",
"dataSourceDescription": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- id
-
The unique identifier for the OpenSearch application to be updated.
Pattern:
[a-z0-9]{3,30}Required: Yes
Request Body
The request accepts the following data in JSON format.
- appConfigs
-
The configuration settings to modify for the OpenSearch application.
Type: Array of AppConfig objects
Array Members: Maximum number of 200 items.
Required: No
- dataSources
-
The data sources to associate with the OpenSearch application.
Type: Array of DataSource objects
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"appConfigs": [
{
"key": "string",
"value": "string"
}
],
"arn": "string",
"createdAt": number,
"dataSources": [
{
"dataSourceArn": "string",
"dataSourceDescription": "string"
}
],
"iamIdentityCenterOptions": {
"enabled": boolean,
"iamIdentityCenterApplicationArn": "string",
"iamIdentityCenterInstanceArn": "string",
"iamRoleForIdentityCenterApplicationArn": "string"
},
"id": "string",
"lastUpdatedAt": number,
"name": "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.
- appConfigs
-
The configuration settings for the updated OpenSearch application.
Type: Array of AppConfig objects
Array Members: Maximum number of 200 items.
- arn
-
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:
.* - createdAt
-
The timestamp when the OpenSearch application was originally created.
Type: Timestamp
- dataSources
-
The data sources associated with the updated OpenSearch application.
Type: Array of DataSource objects
- iamIdentityCenterOptions
-
The IAM Identity Center configuration for the updated OpenSearch application.
Type: IamIdentityCenterOptions object
- id
-
The unique identifier of the updated OpenSearch application.
Type: String
Pattern:
[a-z0-9]{3,30} - lastUpdatedAt
-
The timestamp when the OpenSearch application was last updated.
Type: Timestamp
- name
-
The name of the updated OpenSearch application.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 30.
Pattern:
[a-z][a-z0-9\-]+
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
- BaseException
-
An error occurred while processing the request.
HTTP Status Code: 400
- ConflictException
-
An error occurred because the client attempts to remove a resource that is currently in use.
HTTP Status Code: 409
- DisabledOperationException
-
An error occured because the client wanted to access an unsupported operation.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
