create_access_policy ¶

def create_access_policy(
    self,
    type: "capo_opensearchserverless.types.access_policy_type.AccessPolicyType",
    name: "capo_opensearchserverless.types.policy_name.PolicyName",
    policy: "capo_opensearchserverless.types.policy_document.PolicyDocument",
    *,
    config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
    description: Optional[
        "capo_opensearchserverless.types.policy_description.PolicyDescription"
    ] = None,
    client_token: Optional[
        "capo_opensearchserverless.types.client_token.ClientToken"
    ] = None,
) -> "capo_opensearchserverless.types.create_access_policy_response.CreateAccessPolicyResponse":
    """<p>Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. 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>The type of policy.</p>
        name: <p>The name of the policy.</p>
        description: <p>A description of the policy. Typically used to store information about the permissions defined in the policy.</p>
        policy: <p>The JSON policy document to use as the content for the policy.</p>
        client_token: <p>Unique, case-sensitive identifier to ensure idempotency of the request.</p>

    Raises:
        capo_opensearchserverless.errors.conflict_exception.ConflictException: <p>When creating a resource, thrown when a resource with the same name already exists or is being created. When deleting a resource, thrown when the resource is not in the ACTIVE, FAILED, or UPDATE_FAILED state.</p>
        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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Thrown when you attempt to create more resources than the service allows based on service quotas.</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.create_access_policy_request.CreateAccessPolicyRequest]",
    ) -> OperationResponse[
        "capo_opensearchserverless.types.create_access_policy_response.CreateAccessPolicyResponse"
    ]:
        import capo_opensearchserverless._operations.open_search_serverless.create_access_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAccessPolicy")
    )
    input_: capo_opensearchserverless.types.create_access_policy_request.CreateAccessPolicyRequest = {
        "type": type,
        "name": name,
        "policy": policy,
    }
    if description is not None:
        input_["description"] = description
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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