Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Parameters:
-
type
(SecurityConfigType)
–
The type of security configuration.
-
next_token
(Optional[str], default:
None
)
–
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.
-
max_results
(Optional[int], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_opensearchserverless/_services/async_open_search_serverless.py
| async def list_security_configs(
self,
type: "capo_opensearchserverless.types.security_config_type.SecurityConfigType",
*,
config_overrides: Optional[AsyncOpenSearchServerlessClientConfig] = None,
next_token: Optional[str] = None,
max_results: Optional[int] = None,
) -> "capo_opensearchserverless.types.list_security_configs_response.ListSecurityConfigsResponse":
"""<p>Returns information about configured OpenSearch Serverless security configurations. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html">SAML authentication for Amazon OpenSearch Serverless</a>.</p>
Args:
type: <p>The type of security configuration.</p>
next_token: <p>If your initial <code>ListSecurityConfigs</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListSecurityConfigs</code> operations, which returns results in the next page.</p>
max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p>
Raises:
capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_opensearchserverless.types.list_security_configs_request.ListSecurityConfigsRequest]",
) -> AsyncOperationResponse[
"capo_opensearchserverless.types.list_security_configs_response.ListSecurityConfigsResponse"
]:
import capo_opensearchserverless._operations.open_search_serverless.list_security_configs
(
output,
http_response,
) = await capo_opensearchserverless._operations.open_search_serverless.list_security_configs.async_list_security_configs(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSecurityConfigs")
)
input_: capo_opensearchserverless.types.list_security_configs_request.ListSecurityConfigsRequest = {
"type": type
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|