CreateSecurityConfig - Amazon OpenSearch Serverless (original) (raw)

Specifies a security configuration for OpenSearch Serverless. For more information, seeSAML authentication for Amazon OpenSearch Serverless.

Request Syntax

{
   "clientToken": "string",
   "description": "string",
   "iamIdentityCenterOptions": { 
      "groupAttribute": "string",
      "instanceArn": "string",
      "userAttribute": "string"
   },
   "name": "string",
   "samlOptions": { 
      "groupAttribute": "string",
      "metadata": "string",
      "openSearchServerlessEntityId": "string",
      "sessionTimeout": number,
      "userAttribute": "string"
   },
   "type": "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

description

A description of the security configuration.

Type: String

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

Required: No

iamIdentityCenterOptions

Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

Type: CreateIamIdentityCenterConfigOptions object

Required: No

name

The name of the security configuration.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]+

Required: Yes

samlOptions

Describes SAML options in in the form of a key-value map. This field is required if you specify SAML for the type parameter.

Type: SamlConfigOptions object

Required: No

type

The type of security configuration.

Type: String

Valid Values: saml | iamidentitycenter

Required: Yes

Response Syntax

{
   "securityConfigDetail": { 
      "configVersion": "string",
      "createdDate": number,
      "description": "string",
      "iamIdentityCenterOptions": { 
         "applicationArn": "string",
         "applicationDescription": "string",
         "applicationName": "string",
         "groupAttribute": "string",
         "instanceArn": "string",
         "userAttribute": "string"
      },
      "id": "string",
      "lastModifiedDate": number,
      "samlOptions": { 
         "groupAttribute": "string",
         "metadata": "string",
         "openSearchServerlessEntityId": "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.

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

ServiceQuotaExceededException

Thrown when you attempt to create more resources than the service allows based on service quotas.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: