Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-14207

FLE Code examples are a bit missleading

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major - P3
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
    • Last comment by Customer:
      true
    • Story Points:
      1
    • Sprint:
      DevEd Q1S2 Great Basin 02/16

      Description

      Description

      Hello,

      For AWS examples there is a python command that does not add up for example:

      client_encryption = pymongo.encryption.ClientEncryption(
         {
           "aws": {
             "accessKeyId": "<IAM User Access Key ID>",
             "secretAccessKey": "<IAM User Secret Access Key>"
           }
         },
         key_vault_namespace,
         client,
         CodecOptions(uuid_representation=STANDARD)
      )
      data_key_id = client_encryption.create_data_key("aws")

      The "client" is never defined no where, and the client_encryption.create_data_key("aws") expects to get actually a master_key parameter, eg:

      data_key_id = client_encryption.create_data_key(kms_provider="aws",master_key = { "region": "eu-west-1","key": "arn:aws:kms:eu-west-1:..."})

      I think those are critical for people to onboard FLE succesfully.

      FYI

      Scope of changes

      As a user, I understand where variables are defined that are used in examples.

      Refer to the companion project and the other languages in the guide for context on this project.

      Impact to Other Docs

      MVP (Work and Date)

      Resources (Scope or Design Docs, Invision, etc.)

        Attachments

          Activity

            People

            Assignee:
            kailie.yuan Kailie Yuan
            Reporter:
            pavel.duchovny Pavel Duchovny
            Participants:
            Last commenter:
            Steven Vannelli Steven Vannelli
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Days since reply:
              34 weeks, 5 days ago
              Date of 1st Reply: