OpenSearchServiceServerless / Client / list_security_configs

list_security_configs#

OpenSearchServiceServerless.Client.list_security_configs(**kwargs)#

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

response = client.list_security_configs(
    maxResults=123,
    nextToken='string',
    type='saml'
)
Parameters:

  • maxResults (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.

  • nextToken (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.

  • type (string) –

    [REQUIRED]

    The type of security configuration.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'securityConfigSummaries': [
        {
            'configVersion': 'string',
            'createdDate': 123,
            'description': 'string',
            'id': 'string',
            'lastModifiedDate': 123,
            'type': 'saml'
        },
    ]
}

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.

Exceptions

  • OpenSearchServiceServerless.Client.exceptions.InternalServerException

  • OpenSearchServiceServerless.Client.exceptions.ValidationException