2024/10/30 - OpenSearch Service Serverless - 4 updated api methods
Changes Neo Integration via IAM Identity Center (IdC)
{'iamIdentityCenterOptions': {'groupAttribute': 'GroupId | GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId | UserName | Email'},
'type': {'iamidentitycenter'}}
Response {'securityConfigDetail': {'iamIdentityCenterOptions': {'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId '
'| '
'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId '
'| '
'UserName '
'| '
'Email'},
'type': {'iamidentitycenter'}}}
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(
clientToken='string',
description='string',
iamIdentityCenterOptions={
'groupAttribute': 'GroupId'|'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId'|'UserName'|'Email'
},
name='string',
samlOptions={
'groupAttribute': 'string',
'metadata': 'string',
'sessionTimeout': 123,
'userAttribute': 'string'
},
type='saml'|'iamidentitycenter'
)
string
Unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
string
A description of the security configuration.
dict
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.
groupAttribute (string) --
The group attribute for this IAM Identity Center integration. Defaults to GroupId .
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 .
string
[REQUIRED]
The name of the security configuration.
dict
Describes SAML options in in the form of a key-value map. This field is required if you specify saml for the type parameter.
groupAttribute (string) --
The group attribute for this SAML integration.
metadata (string) -- [REQUIRED]
The XML IdP metadata file generated from your identity provider.
sessionTimeout (integer) --
The session timeout, in minutes. Default is 60 minutes (12 hours).
userAttribute (string) --
A user attribute for this SAML integration.
string
[REQUIRED]
The type of security configuration.
dict
Response Syntax
{
'securityConfigDetail': {
'configVersion': 'string',
'createdDate': 123,
'description': 'string',
'iamIdentityCenterOptions': {
'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId'|'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId'|'UserName'|'Email'
},
'id': 'string',
'lastModifiedDate': 123,
'samlOptions': {
'groupAttribute': 'string',
'metadata': 'string',
'sessionTimeout': 123,
'userAttribute': 'string'
},
'type': 'saml'|'iamidentitycenter'
}
}
Response Structure
(dict) --
securityConfigDetail (dict) --
Details about the created security configuration.
configVersion (string) --
The version of the security configuration.
createdDate (integer) --
The date the configuration was created.
description (string) --
The description of the security configuration.
iamIdentityCenterOptions (dict) --
Describes IAM Identity Center options in the form of a key-value map.
applicationArn (string) --
The ARN 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.
applicationName (string) --
The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
groupAttribute (string) --
The group attribute for this IAM Identity Center integration. Defaults to GroupId .
instanceArn (string) --
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
id (string) --
The unique identifier of the security configuration.
lastModifiedDate (integer) --
The timestamp of when the configuration was last modified.
samlOptions (dict) --
SAML options for the security configuration in the form of a key-value map.
groupAttribute (string) --
The group attribute for this SAML integration.
metadata (string) --
The XML IdP metadata file generated from your identity provider.
sessionTimeout (integer) --
The session timeout, in minutes. Default is 60 minutes (12 hours).
userAttribute (string) --
A user attribute for this SAML integration.
type (string) --
The type of security configuration.
{'securityConfigDetail': {'iamIdentityCenterOptions': {'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId '
'| '
'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId '
'| '
'UserName '
'| '
'Email'},
'type': {'iamidentitycenter'}}}
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'
)
string
[REQUIRED]
The unique identifier of the security configuration.
dict
Response Syntax
{
'securityConfigDetail': {
'configVersion': 'string',
'createdDate': 123,
'description': 'string',
'iamIdentityCenterOptions': {
'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId'|'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId'|'UserName'|'Email'
},
'id': 'string',
'lastModifiedDate': 123,
'samlOptions': {
'groupAttribute': 'string',
'metadata': 'string',
'sessionTimeout': 123,
'userAttribute': 'string'
},
'type': 'saml'|'iamidentitycenter'
}
}
Response Structure
(dict) --
securityConfigDetail (dict) --
Details of the requested security configuration.
configVersion (string) --
The version of the security configuration.
createdDate (integer) --
The date the configuration was created.
description (string) --
The description of the security configuration.
iamIdentityCenterOptions (dict) --
Describes IAM Identity Center options in the form of a key-value map.
applicationArn (string) --
The ARN 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.
applicationName (string) --
The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
groupAttribute (string) --
The group attribute for this IAM Identity Center integration. Defaults to GroupId .
instanceArn (string) --
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
id (string) --
The unique identifier of the security configuration.
lastModifiedDate (integer) --
The timestamp of when the configuration was last modified.
samlOptions (dict) --
SAML options for the security configuration in the form of a key-value map.
groupAttribute (string) --
The group attribute for this SAML integration.
metadata (string) --
The XML IdP metadata file generated from your identity provider.
sessionTimeout (integer) --
The session timeout, in minutes. Default is 60 minutes (12 hours).
userAttribute (string) --
A user attribute for this SAML integration.
type (string) --
The type of security configuration.
{'type': {'iamidentitycenter'}}
Response {'securityConfigSummaries': {'type': {'iamidentitycenter'}}}
Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
See also: AWS API Documentation
Request Syntax
client.list_security_configs(
maxResults=123,
nextToken='string',
type='saml'|'iamidentitycenter'
)
integer
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 20.
string
If your initial ListSecurityConfigs operation returns a nextToken , you can include the returned nextToken in subsequent ListSecurityConfigs operations, which returns results in the next page.
string
[REQUIRED]
The type of security configuration.
dict
Response Syntax
{
'nextToken': 'string',
'securityConfigSummaries': [
{
'configVersion': 'string',
'createdDate': 123,
'description': 'string',
'id': 'string',
'lastModifiedDate': 123,
'type': 'saml'|'iamidentitycenter'
},
]
}
Response Structure
(dict) --
nextToken (string) --
When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
securityConfigSummaries (list) --
Details about the security configurations in your account.
(dict) --
A summary of a security configuration for OpenSearch Serverless.
configVersion (string) --
The version of the security configuration.
createdDate (integer) --
The Epoch time when the security configuration was created.
description (string) --
The description of the security configuration.
id (string) --
The unique identifier of the security configuration.
lastModifiedDate (integer) --
The timestamp of when the configuration was last modified.
type (string) --
The type of security configuration.
{'iamIdentityCenterOptionsUpdates': {'groupAttribute': 'GroupId | GroupName',
'userAttribute': 'UserId | UserName | '
'Email'}}
Response {'securityConfigDetail': {'iamIdentityCenterOptions': {'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId '
'| '
'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId '
'| '
'UserName '
'| '
'Email'},
'type': {'iamidentitycenter'}}}
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(
clientToken='string',
configVersion='string',
description='string',
iamIdentityCenterOptionsUpdates={
'groupAttribute': 'GroupId'|'GroupName',
'userAttribute': 'UserId'|'UserName'|'Email'
},
id='string',
samlOptions={
'groupAttribute': 'string',
'metadata': 'string',
'sessionTimeout': 123,
'userAttribute': 'string'
}
)
string
Unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
string
[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.
string
A description of the security configuration.
dict
Describes IAM Identity Center options in the form of a key-value map.
groupAttribute (string) --
The group attribute for this IAM Identity Center integration. Defaults to GroupId .
userAttribute (string) --
The user attribute for this IAM Identity Center integration. Defaults to UserId .
string
[REQUIRED]
The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName> . For example, saml/123456789123/OKTADev .
dict
SAML options in in the form of a key-value map.
groupAttribute (string) --
The group attribute for this SAML integration.
metadata (string) -- [REQUIRED]
The XML IdP metadata file generated from your identity provider.
sessionTimeout (integer) --
The session timeout, in minutes. Default is 60 minutes (12 hours).
userAttribute (string) --
A user attribute for this SAML integration.
dict
Response Syntax
{
'securityConfigDetail': {
'configVersion': 'string',
'createdDate': 123,
'description': 'string',
'iamIdentityCenterOptions': {
'applicationArn': 'string',
'applicationDescription': 'string',
'applicationName': 'string',
'groupAttribute': 'GroupId'|'GroupName',
'instanceArn': 'string',
'userAttribute': 'UserId'|'UserName'|'Email'
},
'id': 'string',
'lastModifiedDate': 123,
'samlOptions': {
'groupAttribute': 'string',
'metadata': 'string',
'sessionTimeout': 123,
'userAttribute': 'string'
},
'type': 'saml'|'iamidentitycenter'
}
}
Response Structure
(dict) --
securityConfigDetail (dict) --
Details about the updated security configuration.
configVersion (string) --
The version of the security configuration.
createdDate (integer) --
The date the configuration was created.
description (string) --
The description of the security configuration.
iamIdentityCenterOptions (dict) --
Describes IAM Identity Center options in the form of a key-value map.
applicationArn (string) --
The ARN 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.
applicationName (string) --
The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
groupAttribute (string) --
The group attribute for this IAM Identity Center integration. Defaults to GroupId .
instanceArn (string) --
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
id (string) --
The unique identifier of the security configuration.
lastModifiedDate (integer) --
The timestamp of when the configuration was last modified.
samlOptions (dict) --
SAML options for the security configuration in the form of a key-value map.
groupAttribute (string) --
The group attribute for this SAML integration.
metadata (string) --
The XML IdP metadata file generated from your identity provider.
sessionTimeout (integer) --
The session timeout, in minutes. Default is 60 minutes (12 hours).
userAttribute (string) --
A user attribute for this SAML integration.
type (string) --
The type of security configuration.