Skip to content

get_access_policy

get_access_policy(
    type: AccessPolicyType,
    name: PolicyName,
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> GetAccessPolicyResponse

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Parameters:

  • type (AccessPolicyType) –

    Tye type of policy. Currently, the only supported value is data.

  • name (PolicyName) –

    The name of the access policy.

Raises:

Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
def get_access_policy(
    self,
    type: "capo_opensearchserverless.types.access_policy_type.AccessPolicyType",
    name: "capo_opensearchserverless.types.policy_name.PolicyName",
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
) -> "capo_opensearchserverless.types.get_access_policy_response.GetAccessPolicyResponse":
    """<p>Returns an OpenSearch Serverless access policy. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html">Data access control for Amazon OpenSearch Serverless</a>.</p>

    Args:
        type: <p>Tye type of policy. Currently, the only supported value is <code>data</code>.</p>
        name: <p>The name of the access 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_access_policy_request.GetAccessPolicyRequest]",
    ) -> OperationResponse[
        "capo_opensearchserverless.types.get_access_policy_response.GetAccessPolicyResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.get_access_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAccessPolicy")
    )
    input_: capo_opensearchserverless.types.get_access_policy_request.GetAccessPolicyRequest = {
        "type": type,
        "name": name,
    }

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