Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetSecurityConfig

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Request Syntax


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

id

The unique identifier of the security configuration.

Type: String

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

Required: Yes

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 of the requested security configuration.

Type: SecurityConfigDetail object

Errors

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

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