Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateSecurityConfig

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Request Syntax


{
   "clientToken": "string",
   "configVersion": "string",
   "description": "string",
   "id": "string",
   "samlOptions": { 
      "groupAttribute": "string",
      "metadata": "string",
      "sessionTimeout": number,
      "userAttribute": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

configVersion

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

Type: String

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

Pattern: ^([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?$

Required: Yes

description

A description of the security configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

id

The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

samlOptions

SAML options in in the form of a key-value map.

Type: SamlConfigOptions object

Required: No

Response Syntax


{
   "securityConfigDetail": { 
      "configVersion": "string",
      "createdDate": number,
      "description": "string",
      "id": "string",
      "lastModifiedDate": number,
      "samlOptions": { 
         "groupAttribute": "string",
         "metadata": "string",
         "sessionTimeout": number,
         "userAttribute": "string"
      },
      "type": "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.

securityConfigDetail

Details about the updated security configuration.

Type: SecurityConfigDetail object

Errors

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

ConflictException

When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.

HTTP Status Code: 400

InternalServerException

Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Thrown when accessing or deleting a resource that does not exist.

HTTP Status Code: 400

ValidationException

Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400