Skip to content

get_security_policy

get_security_policy(
    type: SecurityPolicyType,
    name: PolicyName,
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> GetSecurityPolicyResponse

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

Parameters:

Raises:

Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
def get_security_policy(
    self,
    type: "capo_opensearchserverless.types.security_policy_type.SecurityPolicyType",
    name: "capo_opensearchserverless.types.policy_name.PolicyName",
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> "capo_opensearchserverless.types.get_security_policy_response.GetSecurityPolicyResponse":
    """<p>Returns information about a configured OpenSearch Serverless security policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html">Network access for Amazon OpenSearch Serverless</a> and <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html">Encryption at rest for Amazon OpenSearch Serverless</a>.</p>

    Args:
        type: <p>The type of security policy.</p>
        name: <p>The name of the security policy.</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_policy_request.GetSecurityPolicyRequest]",
    ) -> OperationResponse[
        "capo_opensearchserverless.types.get_security_policy_response.GetSecurityPolicyResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.get_security_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSecurityPolicy")
    )
    input_: capo_opensearchserverless.types.get_security_policy_request.GetSecurityPolicyRequest = {
        "type": type,
        "name": name,
    }

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