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

UpdateApplication

Update the 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

Unique identifier of 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

Configurations to be changed for the OpenSearch Application.

Type: Array of AppConfig objects

Array Members: Maximum number of 200 items.

Required: No

dataSources

Data sources to be associated 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

Configurations 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

Timestamp at which the OpenSearch Application was created.

Type: Timestamp

dataSources

Data sources associated with the updated OpenSearch Application.

Type: Array of DataSource objects

iamIdentityCenterOptions

IAM Identity Center settings for the updated OpenSearch Application.

Type: IamIdentityCenterOptions object

id

Unique identifier of the updated OpenSearch Application.

Type: String

Pattern: [a-z0-9]{3,30}

lastUpdatedAt

Timestamp at which the OpenSearch Application was last updated.

Type: Timestamp

name

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