OpenSearch Service Serverless

{'samlOptions': {'openSearchServerlessEntityId': 'string'}}

{'securityConfigDetail': {'samlOptions': {'openSearchServerlessEntityId': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

client.create_security_config(
    type='saml'|'iamidentitycenter',
    name='string',
    description='string',
    samlOptions={
        'metadata': 'string',
        'userAttribute': 'string',
        'groupAttribute': 'string',
        'openSearchServerlessEntityId': 'string',
        'sessionTimeout': 123
    },
    iamIdentityCenterOptions={
        'instanceArn': 'string',
        'userAttribute': 'UserId'|'UserName'|'Email',
        'groupAttribute': 'GroupId'|'GroupName'
    },
    clientToken='string'
)

type type:

string

param type:

[REQUIRED]

The type of security configuration.

type name:

string

param name:

[REQUIRED]

The name of the security configuration.

type description:

string

param description:

A description of the security configuration.

type samlOptions:

dict

param 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.

• metadata (string) -- [REQUIRED]

  The XML IdP metadata file generated from your identity provider.

• userAttribute (string) --

  A user attribute for this SAML integration.

• groupAttribute (string) --

  The group attribute for this SAML integration.

• openSearchServerlessEntityId (string) --

  Custom entity id attribute to override default entity id for this saml integration.

• sessionTimeout (integer) --

  The session timeout, in minutes. Default is 60 minutes (12 hours).

type iamIdentityCenterOptions:

dict

param 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.

• instanceArn (string) -- [REQUIRED]

  The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

• userAttribute (string) --

  The user attribute for this IAM Identity Center integration. Defaults to UserId.

• groupAttribute (string) --

  The group attribute for this IAM Identity Center integration. Defaults to GroupId.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'securityConfigDetail': {
        'id': 'string',
        'type': 'saml'|'iamidentitycenter',
        'configVersion': 'string',
        'description': 'string',
        'samlOptions': {
            'metadata': 'string',
            'userAttribute': 'string',
            'groupAttribute': 'string',
            'openSearchServerlessEntityId': 'string',
            'sessionTimeout': 123
        },
        'iamIdentityCenterOptions': {
            'instanceArn': 'string',
            'applicationArn': 'string',
            'applicationName': 'string',
            'applicationDescription': 'string',
            'userAttribute': 'UserId'|'UserName'|'Email',
            'groupAttribute': 'GroupId'|'GroupName'
        },
        'createdDate': 123,
        'lastModifiedDate': 123
    }
}

Response Structure

• (dict) --

  • securityConfigDetail (dict) --

    Details about the created security configuration.

    • id (string) --

      The unique identifier of the security configuration.

    • type (string) --

      The type of security configuration.

    • configVersion (string) --

      The version of the security configuration.

    • description (string) --

      The description of the security configuration.

    • samlOptions (dict) --

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

      • metadata (string) --

        The XML IdP metadata file generated from your identity provider.

      • userAttribute (string) --

        A user attribute for this SAML integration.

      • groupAttribute (string) --

        The group attribute for this SAML integration.

      • openSearchServerlessEntityId (string) --

        Custom entity id attribute to override default entity id for this saml integration.

      • sessionTimeout (integer) --

        The session timeout, in minutes. Default is 60 minutes (12 hours).

    • iamIdentityCenterOptions (dict) --

      Describes IAM Identity Center options in the form of a key-value map.

      • instanceArn (string) --

        The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

      • applicationArn (string) --

        The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationName (string) --

        The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationDescription (string) --

        The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • userAttribute (string) --

        The user attribute for this IAM Identity Center integration. Defaults to UserId

      • groupAttribute (string) --

        The group attribute for this IAM Identity Center integration. Defaults to GroupId.

    • createdDate (integer) --

      The date the configuration was created.

    • lastModifiedDate (integer) --

      The timestamp of when the configuration was last modified.

{'securityConfigDetail': {'samlOptions': {'openSearchServerlessEntityId': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

client.get_security_config(
    id='string'
)

type id:

string

param id:

[REQUIRED]

The unique identifier of the security configuration.

rtype:

dict

returns:

Response Syntax

{
    'securityConfigDetail': {
        'id': 'string',
        'type': 'saml'|'iamidentitycenter',
        'configVersion': 'string',
        'description': 'string',
        'samlOptions': {
            'metadata': 'string',
            'userAttribute': 'string',
            'groupAttribute': 'string',
            'openSearchServerlessEntityId': 'string',
            'sessionTimeout': 123
        },
        'iamIdentityCenterOptions': {
            'instanceArn': 'string',
            'applicationArn': 'string',
            'applicationName': 'string',
            'applicationDescription': 'string',
            'userAttribute': 'UserId'|'UserName'|'Email',
            'groupAttribute': 'GroupId'|'GroupName'
        },
        'createdDate': 123,
        'lastModifiedDate': 123
    }
}

Response Structure

• (dict) --

  • securityConfigDetail (dict) --

    Details of the requested security configuration.

    • id (string) --

      The unique identifier of the security configuration.

    • type (string) --

      The type of security configuration.

    • configVersion (string) --

      The version of the security configuration.

    • description (string) --

      The description of the security configuration.

    • samlOptions (dict) --

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

      • metadata (string) --

        The XML IdP metadata file generated from your identity provider.

      • userAttribute (string) --

        A user attribute for this SAML integration.

      • groupAttribute (string) --

        The group attribute for this SAML integration.

      • openSearchServerlessEntityId (string) --

        Custom entity id attribute to override default entity id for this saml integration.

      • sessionTimeout (integer) --

        The session timeout, in minutes. Default is 60 minutes (12 hours).

    • iamIdentityCenterOptions (dict) --

      Describes IAM Identity Center options in the form of a key-value map.

      • instanceArn (string) --

        The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

      • applicationArn (string) --

        The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationName (string) --

        The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationDescription (string) --

        The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • userAttribute (string) --

        The user attribute for this IAM Identity Center integration. Defaults to UserId

      • groupAttribute (string) --

        The group attribute for this IAM Identity Center integration. Defaults to GroupId.

    • createdDate (integer) --

      The date the configuration was created.

    • lastModifiedDate (integer) --

      The timestamp of when the configuration was last modified.

{'samlOptions': {'openSearchServerlessEntityId': 'string'}}

{'securityConfigDetail': {'samlOptions': {'openSearchServerlessEntityId': 'string'}}}

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

See also: AWS API Documentation

Request Syntax

client.update_security_config(
    id='string',
    configVersion='string',
    description='string',
    samlOptions={
        'metadata': 'string',
        'userAttribute': 'string',
        'groupAttribute': 'string',
        'openSearchServerlessEntityId': 'string',
        'sessionTimeout': 123
    },
    iamIdentityCenterOptionsUpdates={
        'userAttribute': 'UserId'|'UserName'|'Email',
        'groupAttribute': 'GroupId'|'GroupName'
    },
    clientToken='string'
)

type id:

string

param id:

[REQUIRED]

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

type configVersion:

string

param configVersion:

[REQUIRED]

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 description:

string

param description:

A description of the security configuration.

type samlOptions:

dict

param samlOptions:

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

• metadata (string) -- [REQUIRED]

  The XML IdP metadata file generated from your identity provider.

• userAttribute (string) --

  A user attribute for this SAML integration.

• groupAttribute (string) --

  The group attribute for this SAML integration.

• openSearchServerlessEntityId (string) --

  Custom entity id attribute to override default entity id for this saml integration.

• sessionTimeout (integer) --

  The session timeout, in minutes. Default is 60 minutes (12 hours).

type iamIdentityCenterOptionsUpdates:

dict

param iamIdentityCenterOptionsUpdates:

Describes IAM Identity Center options in the form of a key-value map.

• userAttribute (string) --

  The user attribute for this IAM Identity Center integration. Defaults to UserId.

• groupAttribute (string) --

  The group attribute for this IAM Identity Center integration. Defaults to GroupId.

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'securityConfigDetail': {
        'id': 'string',
        'type': 'saml'|'iamidentitycenter',
        'configVersion': 'string',
        'description': 'string',
        'samlOptions': {
            'metadata': 'string',
            'userAttribute': 'string',
            'groupAttribute': 'string',
            'openSearchServerlessEntityId': 'string',
            'sessionTimeout': 123
        },
        'iamIdentityCenterOptions': {
            'instanceArn': 'string',
            'applicationArn': 'string',
            'applicationName': 'string',
            'applicationDescription': 'string',
            'userAttribute': 'UserId'|'UserName'|'Email',
            'groupAttribute': 'GroupId'|'GroupName'
        },
        'createdDate': 123,
        'lastModifiedDate': 123
    }
}

Response Structure

• (dict) --

  • securityConfigDetail (dict) --

    Details about the updated security configuration.

    • id (string) --

      The unique identifier of the security configuration.

    • type (string) --

      The type of security configuration.

    • configVersion (string) --

      The version of the security configuration.

    • description (string) --

      The description of the security configuration.

    • samlOptions (dict) --

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

      • metadata (string) --

        The XML IdP metadata file generated from your identity provider.

      • userAttribute (string) --

        A user attribute for this SAML integration.

      • groupAttribute (string) --

        The group attribute for this SAML integration.

      • openSearchServerlessEntityId (string) --

        Custom entity id attribute to override default entity id for this saml integration.

      • sessionTimeout (integer) --

        The session timeout, in minutes. Default is 60 minutes (12 hours).

    • iamIdentityCenterOptions (dict) --

      Describes IAM Identity Center options in the form of a key-value map.

      • instanceArn (string) --

        The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

      • applicationArn (string) --

        The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationName (string) --

        The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • applicationDescription (string) --

        The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

      • userAttribute (string) --

        The user attribute for this IAM Identity Center integration. Defaults to UserId

      • groupAttribute (string) --

        The group attribute for this IAM Identity Center integration. Defaults to GroupId.

    • createdDate (integer) --

      The date the configuration was created.

    • lastModifiedDate (integer) --

      The timestamp of when the configuration was last modified.