Skip to content

documentation: Info about offline s3 bucket key when creating feature group #2646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 21, 2021
Merged

documentation: Info about offline s3 bucket key when creating feature group #2646

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc52505
Add documentation for offline s3 bucket key when creating feature group
can-sun Sep 20, 2021
6267185
Reformat the comment
can-sun Sep 20, 2021
2b2ddd4
Resolve comments by refining the wordings
can-sun Sep 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/sagemaker/feature_store/feature_group.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,12 @@ def create(
online_store_kms_key_id (str): KMS key id for online store.
enable_online_store (bool): whether to enable online store or not.
offline_store_kms_key_id (str): KMS key id for offline store.
If KMS encryption key is not specified, by default we encrypt all data at
rest using AWS KMS key. By defining your bucket-level key for SSE, you can
reduce AWS KMS requests costs by up to 99 percent.
For more information, see the S3 documentation for
`Bucket Key
<https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AWS KMS key ID for offline store.
If a KMS encryption key is not specified, SageMaker encrypts all data at
rest using the default AWS KMS key. By defining your bucket-level key for SSE, you can
reduce the cost of AWS KMS requests.
For more information, see
Bucket Key <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html>_
in the Amazon S3 User Guide.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(You should not use any marketing words in the sdk docstrings.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised according to your comments, thanks!

disable_glue_table_creation (bool): whether to turn off Glue table creation no not.
data_catalog_config (DataCatalogConfig): configuration for Metadata store.
description (str): description of the FeatureGroup.
Expand Down