Skip to content

get_security_config

get_security_config(
    id: SecurityConfigId,
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> GetSecurityConfigResponse

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

Parameters:

  • id (SecurityConfigId) –

    The unique identifier of the security configuration.

Raises:

Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
def get_security_config(
    self,
    id: "capo_opensearchserverless.types.security_config_id.SecurityConfigId",
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> "capo_opensearchserverless.types.get_security_config_response.GetSecurityConfigResponse":
    """<p>Returns information about an OpenSearch Serverless security configuration. 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:
        id: <p>The unique identifier of the security configuration.</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.resource_not_found_exception.ResourceNotFoundException: <p>Thrown when accessing or deleting a resource that does not exist.</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.
    """

    def _handler(
        req: "OperationRequest[capo_opensearchserverless.types.get_security_config_request.GetSecurityConfigRequest]",
    ) -> OperationResponse[
        "capo_opensearchserverless.types.get_security_config_response.GetSecurityConfigResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.get_security_config

        output, http_response = (
            capo_opensearchserverless._operations.open_search_serverless.get_security_config.get_security_config(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSecurityConfig")
    )
    input_: capo_opensearchserverless.types.get_security_config_request.GetSecurityConfigRequest = {
        "id": id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output