aws-sdk-sagemaker 1.140.0 → 1.141.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 183a3d0710845a318335195f1df77b55daec4ac09cce10e3f8d78aa502900df8
-  data.tar.gz: c52b1b8802e3bb268c7461a679e8a40621c2a987889458371e59595708deadbc
+  metadata.gz: fa806301ee5af4611d77037dbabd58326f29f5462b6078710e1d96c0182e7e54
+  data.tar.gz: b7547e74552a45ecf1e5f44843f7d1ee42763ad20ce122c1940f0a41253de5bd
 SHA512:
-  metadata.gz: 272cc69827d58efd70a692bd40bfbae65b89fd7e21db5e817ad9fa26785b2001d616a9797c720a7ab88ae5e32b07bd9237edd5dfc8800227d6d4d8385f98ef73
-  data.tar.gz: 87c6ec30a6c56ae2f46ad9ae99f26aded31705b658d707917940ba61a5b90c9423ebf890cf7bf3084fc1e48e763145c911b7094de28cbf259fb8b994a1781063
+  metadata.gz: e467497b42ff52757c11137af235ee5b9a650dd1d594e9f216761fa70b4c1728172f3eaac0027fcc94ec045dd90066403f70eb7521606e8e848023b0a9392770
+  data.tar.gz: d9bd4f710541f6f7f2543c86aed8dd03249b1eefd367cb40751a822ebabc7a8d43261d7b320e9c3d6d6fd2d7546d789ea20f5c2003e01c15b84e0da7bbf8e384

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.141.0 (2022-09-21)
+------------------
+
+* Feature - SageMaker now allows customization on Canvas Application settings, including enabling/disabling time-series forecasting and specifying an Amazon Forecast execution role at both the Domain and UserProfile levels.
+
 1.140.0 (2022-09-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.140.0
+1.141.0

data/lib/aws-sdk-sagemaker/client.rb

@@ -1959,6 +1959,12 @@ module Aws::SageMaker
     #           },
     #         ],
     #       },
+    #       canvas_app_settings: {
+    #         time_series_forecasting_settings: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #           amazon_forecast_role_arn: "RoleArn",
+    #         },
+    #       },
     #     },
     #     subnet_ids: ["SubnetId"], # required
     #     vpc_id: "VpcId", # required
@@ -6664,8 +6670,8 @@ module Aws::SageMaker
     # a domain, and is the main way to reference a "person" for the
     # purposes of sharing, reporting, and other user-oriented features. This
     # entity is created when a user onboards to Amazon SageMaker Studio. If
-    # an administrator invites a person by email or imports them from Amazon
-    # Web Services SSO, a user profile is automatically created. A user
+    # an administrator invites a person by email or imports them from IAM
+    # Identity Center, a user profile is automatically created. A user
     # profile is the primary holder of settings for an individual user and
     # has a reference to the user's private Amazon Elastic File System
     # (EFS) home directory.
@@ -6679,16 +6685,16 @@ module Aws::SageMaker
     # @option params [String] :single_sign_on_user_identifier
     #   A specifier for the type of value specified in SingleSignOnUserValue.
     #   Currently, the only supported value is "UserName". If the Domain's
-    #   AuthMode is Amazon Web Services SSO, this field is required. If the
-    #   Domain's AuthMode is not Amazon Web Services SSO, this field cannot
-    #   be specified.
+    #   AuthMode is IAM Identity Center, this field is required. If the
+    #   Domain's AuthMode is not IAM Identity Center, this field cannot be
+    #   specified.
     #
     # @option params [String] :single_sign_on_user_value
     #   The username of the associated Amazon Web Services Single Sign-On User
-    #   for this UserProfile. If the Domain's AuthMode is Amazon Web Services
-    #   SSO, this field is required, and must match a valid username of a user
-    #   in your directory. If the Domain's AuthMode is not Amazon Web
-    #   Services SSO, this field cannot be specified.
+    #   for this UserProfile. If the Domain's AuthMode is IAM Identity
+    #   Center, this field is required, and must match a valid username of a
+    #   user in your directory. If the Domain's AuthMode is not IAM Identity
+    #   Center, this field cannot be specified.
     #
     # @option params [Array<Types::Tag>] :tags
     #   Each tag consists of a key and an optional value. Tag keys must be
@@ -6777,6 +6783,12 @@ module Aws::SageMaker
     #           },
     #         ],
     #       },
+    #       canvas_app_settings: {
+    #         time_series_forecasting_settings: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #           amazon_forecast_role_arn: "RoleArn",
+    #         },
+    #       },
     #     },
     #   })
     #
@@ -7287,8 +7299,8 @@ module Aws::SageMaker
     end
 
     # Used to delete a domain. If you onboarded with IAM mode, you will need
-    # to delete your domain to onboard again using Amazon Web Services SSO.
-    # Use with caution. All of the members of the domain will lose access to
+    # to delete your domain to onboard again using IAM Identity Center. Use
+    # with caution. All of the members of the domain will lose access to
     # their EFS volume, including data, notebooks, and other artifacts.
     #
     # @option params [required, String] :domain_id
@@ -9080,6 +9092,8 @@ module Aws::SageMaker
     #   resp.default_user_settings.r_session_app_settings.custom_images[0].image_name #=> String
     #   resp.default_user_settings.r_session_app_settings.custom_images[0].image_version_number #=> Integer
     #   resp.default_user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
+    #   resp.default_user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
+    #   resp.default_user_settings.canvas_app_settings.time_series_forecasting_settings.amazon_forecast_role_arn #=> String
     #   resp.app_network_access_type #=> String, one of "PublicInternetOnly", "VpcOnly"
     #   resp.home_efs_file_system_kms_key_id #=> String
     #   resp.subnet_ids #=> Array
@@ -11980,6 +11994,8 @@ module Aws::SageMaker
     #   resp.user_settings.r_session_app_settings.custom_images[0].image_name #=> String
     #   resp.user_settings.r_session_app_settings.custom_images[0].image_version_number #=> Integer
     #   resp.user_settings.r_session_app_settings.custom_images[0].app_image_config_name #=> String
+    #   resp.user_settings.canvas_app_settings.time_series_forecasting_settings.status #=> String, one of "ENABLED", "DISABLED"
+    #   resp.user_settings.canvas_app_settings.time_series_forecasting_settings.amazon_forecast_role_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeUserProfile AWS API Documentation
     #
@@ -19165,6 +19181,12 @@ module Aws::SageMaker
     #           },
     #         ],
     #       },
+    #       canvas_app_settings: {
+    #         time_series_forecasting_settings: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #           amazon_forecast_role_arn: "RoleArn",
+    #         },
+    #       },
     #     },
     #     domain_settings_for_update: {
     #       r_studio_server_pro_domain_settings_for_update: {
@@ -20354,6 +20376,12 @@ module Aws::SageMaker
     #           },
     #         ],
     #       },
+    #       canvas_app_settings: {
+    #         time_series_forecasting_settings: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #           amazon_forecast_role_arn: "RoleArn",
+    #         },
+    #       },
     #     },
     #   })
     #
@@ -20604,7 +20632,7 @@ module Aws::SageMaker
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-sagemaker'
-      context[:gem_version] = '1.140.0'
+      context[:gem_version] = '1.141.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-sagemaker/client_api.rb

@@ -160,6 +160,7 @@ module Aws::SageMaker
     CandidateStepName = Shapes::StringShape.new(name: 'CandidateStepName')
     CandidateStepType = Shapes::StringShape.new(name: 'CandidateStepType')
     CandidateSteps = Shapes::ListShape.new(name: 'CandidateSteps')
+    CanvasAppSettings = Shapes::StructureShape.new(name: 'CanvasAppSettings')
     CapacitySize = Shapes::StructureShape.new(name: 'CapacitySize')
     CapacitySizeType = Shapes::StringShape.new(name: 'CapacitySizeType')
     CapacitySizeValue = Shapes::IntegerShape.new(name: 'CapacitySizeValue')
@@ -675,6 +676,7 @@ module Aws::SageMaker
     FeatureParameterRemovals = Shapes::ListShape.new(name: 'FeatureParameterRemovals')
     FeatureParameterValue = Shapes::StringShape.new(name: 'FeatureParameterValue')
     FeatureParameters = Shapes::ListShape.new(name: 'FeatureParameters')
+    FeatureStatus = Shapes::StringShape.new(name: 'FeatureStatus')
     FeatureType = Shapes::StringShape.new(name: 'FeatureType')
     FileSource = Shapes::StructureShape.new(name: 'FileSource')
     FileSystemAccessMode = Shapes::StringShape.new(name: 'FileSystemAccessMode')
@@ -1534,6 +1536,7 @@ module Aws::SageMaker
     TenthFractionsOfACent = Shapes::IntegerShape.new(name: 'TenthFractionsOfACent')
     TerminationWaitInSeconds = Shapes::IntegerShape.new(name: 'TerminationWaitInSeconds')
     ThingName = Shapes::StringShape.new(name: 'ThingName')
+    TimeSeriesForecastingSettings = Shapes::StructureShape.new(name: 'TimeSeriesForecastingSettings')
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     TrafficDurationInSeconds = Shapes::IntegerShape.new(name: 'TrafficDurationInSeconds')
     TrafficPattern = Shapes::StructureShape.new(name: 'TrafficPattern')
@@ -2049,6 +2052,9 @@ module Aws::SageMaker
 
     CandidateSteps.member = Shapes::ShapeRef.new(shape: AutoMLCandidateStep)
 
+    CanvasAppSettings.add_member(:time_series_forecasting_settings, Shapes::ShapeRef.new(shape: TimeSeriesForecastingSettings, location_name: "TimeSeriesForecastingSettings"))
+    CanvasAppSettings.struct_class = Types::CanvasAppSettings
+
     CapacitySize.add_member(:type, Shapes::ShapeRef.new(shape: CapacitySizeType, required: true, location_name: "Type"))
     CapacitySize.add_member(:value, Shapes::ShapeRef.new(shape: CapacitySizeValue, required: true, location_name: "Value"))
     CapacitySize.struct_class = Types::CapacitySize
@@ -6910,6 +6916,10 @@ module Aws::SageMaker
     TensorBoardOutputConfig.add_member(:s3_output_path, Shapes::ShapeRef.new(shape: S3Uri, required: true, location_name: "S3OutputPath"))
     TensorBoardOutputConfig.struct_class = Types::TensorBoardOutputConfig
 
+    TimeSeriesForecastingSettings.add_member(:status, Shapes::ShapeRef.new(shape: FeatureStatus, location_name: "Status"))
+    TimeSeriesForecastingSettings.add_member(:amazon_forecast_role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "AmazonForecastRoleArn"))
+    TimeSeriesForecastingSettings.struct_class = Types::TimeSeriesForecastingSettings
+
     TrafficPattern.add_member(:traffic_type, Shapes::ShapeRef.new(shape: TrafficType, location_name: "TrafficType"))
     TrafficPattern.add_member(:phases, Shapes::ShapeRef.new(shape: Phases, location_name: "Phases"))
     TrafficPattern.struct_class = Types::TrafficPattern
@@ -7477,6 +7487,7 @@ module Aws::SageMaker
     UserSettings.add_member(:tensor_board_app_settings, Shapes::ShapeRef.new(shape: TensorBoardAppSettings, location_name: "TensorBoardAppSettings"))
     UserSettings.add_member(:r_studio_server_pro_app_settings, Shapes::ShapeRef.new(shape: RStudioServerProAppSettings, location_name: "RStudioServerProAppSettings"))
     UserSettings.add_member(:r_session_app_settings, Shapes::ShapeRef.new(shape: RSessionAppSettings, location_name: "RSessionAppSettings"))
+    UserSettings.add_member(:canvas_app_settings, Shapes::ShapeRef.new(shape: CanvasAppSettings, location_name: "CanvasAppSettings"))
     UserSettings.struct_class = Types::UserSettings
 
     VariantProperty.add_member(:variant_property_type, Shapes::ShapeRef.new(shape: VariantPropertyType, required: true, location_name: "VariantPropertyType"))

data/lib/aws-sdk-sagemaker/types.rb

@@ -2058,11 +2058,33 @@ module Aws::SageMaker
     #
     # @!attribute [rw] feature_specification_s3_uri
     #   A URL to the Amazon S3 data source containing selected features from
-    #   the input data source to run an Autopilot job (optional). This file
-    #   should be in json format as shown below:
+    #   the input data source to run an Autopilot job. You can input
+    #   `FeatureAttributeNames` (optional) in JSON format as shown below:
     #
     #   `\{ "FeatureAttributeNames":["col1", "col2", ...] \}`.
     #
+    #   You can also specify the data type of the feature (optional) in the
+    #   format shown below:
+    #
+    #   `\{ "FeatureDataTypes":\{"col1":"numeric", "col2":"categorical" ...
+    #   \} \}`
+    #
+    #   <note markdown="1"> These column keys may not include the target column.
+    #
+    #    </note>
+    #
+    #   In ensembling mode, Autopilot will only support the following data
+    #   types: `numeric`, `categorical`, `text` and `datetime`. In HPO mode,
+    #   Autopilot can support `numeric`, `categorical`, `text`, `datetime`
+    #   and `sequence`.
+    #
+    #   If only `FeatureDataTypes` is provided, the column keys (`col1`,
+    #   `col2`,..) should be a subset of the column names in the input data.
+    #
+    #   If both `FeatureDataTypes` and `FeatureAttributeNames` are provided,
+    #   then the column keys should be a subset of the column names provided
+    #   in `FeatureAttributeNames`.
+    #
     #   The key name `FeatureAttributeNames` is fixed. The values listed in
     #   `["col1", "col2", ...]` is case sensitive and should be a list of
     #   strings containing unique values that are a subset of the column
@@ -2986,6 +3008,30 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
+    # The SageMaker Canvas app settings.
+    #
+    # @note When making an API call, you may pass CanvasAppSettings
+    #   data as a hash:
+    #
+    #       {
+    #         time_series_forecasting_settings: {
+    #           status: "ENABLED", # accepts ENABLED, DISABLED
+    #           amazon_forecast_role_arn: "RoleArn",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] time_series_forecasting_settings
+    #   Time series forecast settings for the Canvas app.
+    #   @return [Types::TimeSeriesForecastingSettings]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CanvasAppSettings AWS API Documentation
+    #
+    class CanvasAppSettings < Struct.new(
+      :time_series_forecasting_settings)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the endpoint capacity to activate for production.
     #
     # @note When making an API call, you may pass CapacitySize
@@ -5298,6 +5344,12 @@ module Aws::SageMaker
     #               },
     #             ],
     #           },
+    #           canvas_app_settings: {
+    #             time_series_forecasting_settings: {
+    #               status: "ENABLED", # accepts ENABLED, DISABLED
+    #               amazon_forecast_role_arn: "RoleArn",
+    #             },
+    #           },
     #         },
     #         subnet_ids: ["SubnetId"], # required
     #         vpc_id: "VpcId", # required
@@ -10157,6 +10209,12 @@ module Aws::SageMaker
     #               },
     #             ],
     #           },
+    #           canvas_app_settings: {
+    #             time_series_forecasting_settings: {
+    #               status: "ENABLED", # accepts ENABLED, DISABLED
+    #               amazon_forecast_role_arn: "RoleArn",
+    #             },
+    #           },
     #         },
     #       }
     #
@@ -10171,17 +10229,17 @@ module Aws::SageMaker
     # @!attribute [rw] single_sign_on_user_identifier
     #   A specifier for the type of value specified in
     #   SingleSignOnUserValue. Currently, the only supported value is
-    #   "UserName". If the Domain's AuthMode is Amazon Web Services SSO,
-    #   this field is required. If the Domain's AuthMode is not Amazon Web
-    #   Services SSO, this field cannot be specified.
+    #   "UserName". If the Domain's AuthMode is IAM Identity Center, this
+    #   field is required. If the Domain's AuthMode is not IAM Identity
+    #   Center, this field cannot be specified.
     #   @return [String]
     #
     # @!attribute [rw] single_sign_on_user_value
     #   The username of the associated Amazon Web Services Single Sign-On
-    #   User for this UserProfile. If the Domain's AuthMode is Amazon Web
-    #   Services SSO, this field is required, and must match a valid
-    #   username of a user in your directory. If the Domain's AuthMode is
-    #   not Amazon Web Services SSO, this field cannot be specified.
+    #   User for this UserProfile. If the Domain's AuthMode is IAM Identity
+    #   Center, this field is required, and must match a valid username of a
+    #   user in your directory. If the Domain's AuthMode is not IAM
+    #   Identity Center, this field cannot be specified.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -13430,7 +13488,7 @@ module Aws::SageMaker
     #   @return [String]
     #
     # @!attribute [rw] single_sign_on_managed_application_instance_id
-    #   The Amazon Web Services SSO managed application instance ID.
+    #   The IAM Identity Center managed application instance ID.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -17232,11 +17290,11 @@ module Aws::SageMaker
     #   @return [String]
     #
     # @!attribute [rw] single_sign_on_user_identifier
-    #   The Amazon Web Services SSO user identifier.
+    #   The IAM Identity Center user identifier.
     #   @return [String]
     #
     # @!attribute [rw] single_sign_on_user_value
-    #   The Amazon Web Services SSO user value.
+    #   The IAM Identity Center user value.
     #   @return [String]
     #
     # @!attribute [rw] user_settings
@@ -22005,8 +22063,12 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
-    # An entity having characteristics over which a user can search for a
-    # hyperparameter tuning job.
+    # An entity returned by the [SearchRecord][1] API containing the
+    # properties of a hyperparameter tuning job.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SearchRecord.html
     #
     # @!attribute [rw] hyper_parameter_tuning_job_name
     #   The name of a hyperparameter tuning job.
@@ -38448,6 +38510,46 @@ module Aws::SageMaker
       include Aws::Structure
     end
 
+    # Time series forecast settings for the SageMaker Canvas app.
+    #
+    # @note When making an API call, you may pass TimeSeriesForecastingSettings
+    #   data as a hash:
+    #
+    #       {
+    #         status: "ENABLED", # accepts ENABLED, DISABLED
+    #         amazon_forecast_role_arn: "RoleArn",
+    #       }
+    #
+    # @!attribute [rw] status
+    #   Describes whether time series forecasting is enabled or disabled in
+    #   the Canvas app.
+    #   @return [String]
+    #
+    # @!attribute [rw] amazon_forecast_role_arn
+    #   The IAM role that Canvas passes to Amazon Forecast for time series
+    #   forecasting. By default, Canvas uses the execution role specified in
+    #   the `UserProfile` that launches the Canvas app. If an execution role
+    #   is not specified in the `UserProfile`, Canvas uses the execution
+    #   role specified in the Domain that owns the `UserProfile`. To allow
+    #   time series forecasting, this IAM role should have the [
+    #   AmazonSageMakerCanvasForecastAccess][1] policy attached and
+    #   `forecast.amazonaws.com` added in the trust relationship as a
+    #   service principal.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TimeSeriesForecastingSettings AWS API Documentation
+    #
+    class TimeSeriesForecastingSettings < Struct.new(
+      :status,
+      :amazon_forecast_role_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Defines the traffic pattern of the load test.
     #
     # @note When making an API call, you may pass TrafficPattern
@@ -41097,6 +41199,12 @@ module Aws::SageMaker
     #               },
     #             ],
     #           },
+    #           canvas_app_settings: {
+    #             time_series_forecasting_settings: {
+    #               status: "ENABLED", # accepts ENABLED, DISABLED
+    #               amazon_forecast_role_arn: "RoleArn",
+    #             },
+    #           },
     #         },
     #         domain_settings_for_update: {
     #           r_studio_server_pro_domain_settings_for_update: {
@@ -42420,6 +42528,12 @@ module Aws::SageMaker
     #               },
     #             ],
     #           },
+    #           canvas_app_settings: {
+    #             time_series_forecasting_settings: {
+    #               status: "ENABLED", # accepts ENABLED, DISABLED
+    #               amazon_forecast_role_arn: "RoleArn",
+    #             },
+    #           },
     #         },
     #       }
     #
@@ -42761,6 +42875,12 @@ module Aws::SageMaker
     #             },
     #           ],
     #         },
+    #         canvas_app_settings: {
+    #           time_series_forecasting_settings: {
+    #             status: "ENABLED", # accepts ENABLED, DISABLED
+    #             amazon_forecast_role_arn: "RoleArn",
+    #           },
+    #         },
     #       }
     #
     # @!attribute [rw] execution_role
@@ -42807,6 +42927,10 @@ module Aws::SageMaker
     #   A collection of settings that configure the `RSessionGateway` app.
     #   @return [Types::RSessionAppSettings]
     #
+    # @!attribute [rw] canvas_app_settings
+    #   The Canvas app settings.
+    #   @return [Types::CanvasAppSettings]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/UserSettings AWS API Documentation
     #
     class UserSettings < Struct.new(
@@ -42817,7 +42941,8 @@ module Aws::SageMaker
       :kernel_gateway_app_settings,
       :tensor_board_app_settings,
       :r_studio_server_pro_app_settings,
-      :r_session_app_settings)
+      :r_session_app_settings,
+      :canvas_app_settings)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-sagemaker.rb

@@ -49,6 +49,6 @@ require_relative 'aws-sdk-sagemaker/customizations'
 # @!group service
 module Aws::SageMaker
 
-  GEM_VERSION = '1.140.0'
+  GEM_VERSION = '1.141.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-sagemaker
 version: !ruby/object:Gem::Version
-  version: 1.140.0
+  version: 1.141.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core