Skip to content

Returns information about an OpenSearch Serverless security configuration

Description

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

Usage

opensearchserviceserverless_get_security_config(id)

Arguments

  • id

    [required] The unique identifier of the security configuration.

Value

A list with the following syntax:

list(
  securityConfigDetail = list(
    id = "string",
    type = "saml"|"iamidentitycenter"|"iamfederation",
    configVersion = "string",
    description = "string",
    samlOptions = list(
      metadata = "string",
      userAttribute = "string",
      groupAttribute = "string",
      openSearchServerlessEntityId = "string",
      sessionTimeout = 123
    ),
    iamIdentityCenterOptions = list(
      instanceArn = "string",
      applicationArn = "string",
      applicationName = "string",
      applicationDescription = "string",
      userAttribute = "UserId"|"UserName"|"Email",
      groupAttribute = "GroupId"|"GroupName"
    ),
    iamFederationOptions = list(
      groupAttribute = "string",
      userAttribute = "string"
    ),
    createdDate = 123,
    lastModifiedDate = 123
  )
)

Request syntax

svc$get_security_config(
  id = "string"
)