aws-sdk-datazone 1.76.0 → 1.77.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datazone/client.rb +654 -16
- data/lib/aws-sdk-datazone/client_api.rb +353 -0
- data/lib/aws-sdk-datazone/types.rb +1104 -149
- data/lib/aws-sdk-datazone.rb +1 -1
- data/sig/client.rbs +199 -0
- data/sig/types.rbs +242 -0
- metadata +1 -1
|
@@ -3676,6 +3676,118 @@ module Aws::DataZone
|
|
|
3676
3676
|
req.send_request(options)
|
|
3677
3677
|
end
|
|
3678
3678
|
|
|
3679
|
+
# Creates a [notebook][1] in Amazon SageMaker Unified Studio. A notebook
|
|
3680
|
+
# is a collaborative document within a project that contains code cells
|
|
3681
|
+
# for interactive computing.
|
|
3682
|
+
#
|
|
3683
|
+
#
|
|
3684
|
+
#
|
|
3685
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
3686
|
+
#
|
|
3687
|
+
# @option params [required, String] :domain_identifier
|
|
3688
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
3689
|
+
# to create the notebook.
|
|
3690
|
+
#
|
|
3691
|
+
# @option params [required, String] :owning_project_identifier
|
|
3692
|
+
# The identifier of the project that owns the notebook.
|
|
3693
|
+
#
|
|
3694
|
+
# @option params [required, String] :name
|
|
3695
|
+
# The name of the notebook. The name must be between 1 and 256
|
|
3696
|
+
# characters.
|
|
3697
|
+
#
|
|
3698
|
+
# @option params [String] :description
|
|
3699
|
+
# The description of the notebook.
|
|
3700
|
+
#
|
|
3701
|
+
# @option params [Hash<String,String>] :metadata
|
|
3702
|
+
# The metadata for the notebook, specified as key-value pairs. You can
|
|
3703
|
+
# specify up to 50 entries, with keys up to 128 characters and values up
|
|
3704
|
+
# to 1024 characters.
|
|
3705
|
+
#
|
|
3706
|
+
# @option params [Hash<String,String>] :parameters
|
|
3707
|
+
# The sensitive parameters for the notebook, specified as key-value
|
|
3708
|
+
# pairs. You can specify up to 50 entries, with keys up to 128
|
|
3709
|
+
# characters and values up to 1024 characters.
|
|
3710
|
+
#
|
|
3711
|
+
# @option params [String] :client_token
|
|
3712
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
|
3713
|
+
# request. This field is automatically populated if not provided.
|
|
3714
|
+
#
|
|
3715
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
3716
|
+
# not need to pass this option.**
|
|
3717
|
+
#
|
|
3718
|
+
# @return [Types::CreateNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3719
|
+
#
|
|
3720
|
+
# * {Types::CreateNotebookOutput#id #id} => String
|
|
3721
|
+
# * {Types::CreateNotebookOutput#name #name} => String
|
|
3722
|
+
# * {Types::CreateNotebookOutput#owning_project_id #owning_project_id} => String
|
|
3723
|
+
# * {Types::CreateNotebookOutput#domain_id #domain_id} => String
|
|
3724
|
+
# * {Types::CreateNotebookOutput#cell_order #cell_order} => Array<Types::CellInformation>
|
|
3725
|
+
# * {Types::CreateNotebookOutput#status #status} => String
|
|
3726
|
+
# * {Types::CreateNotebookOutput#description #description} => String
|
|
3727
|
+
# * {Types::CreateNotebookOutput#created_at #created_at} => Time
|
|
3728
|
+
# * {Types::CreateNotebookOutput#created_by #created_by} => String
|
|
3729
|
+
# * {Types::CreateNotebookOutput#updated_at #updated_at} => Time
|
|
3730
|
+
# * {Types::CreateNotebookOutput#updated_by #updated_by} => String
|
|
3731
|
+
# * {Types::CreateNotebookOutput#locked_by #locked_by} => String
|
|
3732
|
+
# * {Types::CreateNotebookOutput#locked_at #locked_at} => Time
|
|
3733
|
+
# * {Types::CreateNotebookOutput#lock_expires_at #lock_expires_at} => Time
|
|
3734
|
+
# * {Types::CreateNotebookOutput#compute_id #compute_id} => String
|
|
3735
|
+
# * {Types::CreateNotebookOutput#metadata #metadata} => Hash<String,String>
|
|
3736
|
+
# * {Types::CreateNotebookOutput#parameters #parameters} => Hash<String,String>
|
|
3737
|
+
# * {Types::CreateNotebookOutput#environment_configuration #environment_configuration} => Types::EnvironmentConfig
|
|
3738
|
+
# * {Types::CreateNotebookOutput#error #error} => Types::NotebookError
|
|
3739
|
+
#
|
|
3740
|
+
# @example Request syntax with placeholder values
|
|
3741
|
+
#
|
|
3742
|
+
# resp = client.create_notebook({
|
|
3743
|
+
# domain_identifier: "DomainId", # required
|
|
3744
|
+
# owning_project_identifier: "ProjectId", # required
|
|
3745
|
+
# name: "NotebookName", # required
|
|
3746
|
+
# description: "Description",
|
|
3747
|
+
# metadata: {
|
|
3748
|
+
# "MetadataKey" => "MetadataValue",
|
|
3749
|
+
# },
|
|
3750
|
+
# parameters: {
|
|
3751
|
+
# "ParameterKey" => "ParameterValue",
|
|
3752
|
+
# },
|
|
3753
|
+
# client_token: "ClientToken",
|
|
3754
|
+
# })
|
|
3755
|
+
#
|
|
3756
|
+
# @example Response structure
|
|
3757
|
+
#
|
|
3758
|
+
# resp.id #=> String
|
|
3759
|
+
# resp.name #=> String
|
|
3760
|
+
# resp.owning_project_id #=> String
|
|
3761
|
+
# resp.domain_id #=> String
|
|
3762
|
+
# resp.cell_order #=> Array
|
|
3763
|
+
# resp.status #=> String, one of "ACTIVE", "ARCHIVED"
|
|
3764
|
+
# resp.description #=> String
|
|
3765
|
+
# resp.created_at #=> Time
|
|
3766
|
+
# resp.created_by #=> String
|
|
3767
|
+
# resp.updated_at #=> Time
|
|
3768
|
+
# resp.updated_by #=> String
|
|
3769
|
+
# resp.locked_by #=> String
|
|
3770
|
+
# resp.locked_at #=> Time
|
|
3771
|
+
# resp.lock_expires_at #=> Time
|
|
3772
|
+
# resp.compute_id #=> String
|
|
3773
|
+
# resp.metadata #=> Hash
|
|
3774
|
+
# resp.metadata["MetadataKey"] #=> String
|
|
3775
|
+
# resp.parameters #=> Hash
|
|
3776
|
+
# resp.parameters["ParameterKey"] #=> String
|
|
3777
|
+
# resp.environment_configuration.image_version #=> String
|
|
3778
|
+
# resp.environment_configuration.package_config.package_manager #=> String, one of "UV"
|
|
3779
|
+
# resp.environment_configuration.package_config.package_specification #=> String
|
|
3780
|
+
# resp.error.message #=> String
|
|
3781
|
+
#
|
|
3782
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateNotebook AWS API Documentation
|
|
3783
|
+
#
|
|
3784
|
+
# @overload create_notebook(params = {})
|
|
3785
|
+
# @param [Hash] params ({})
|
|
3786
|
+
def create_notebook(params = {}, options = {})
|
|
3787
|
+
req = build_request(:create_notebook, params)
|
|
3788
|
+
req.send_request(options)
|
|
3789
|
+
end
|
|
3790
|
+
|
|
3679
3791
|
# Creates an Amazon DataZone project.
|
|
3680
3792
|
#
|
|
3681
3793
|
# @option params [required, String] :domain_identifier
|
|
@@ -5310,6 +5422,37 @@ module Aws::DataZone
|
|
|
5310
5422
|
req.send_request(options)
|
|
5311
5423
|
end
|
|
5312
5424
|
|
|
5425
|
+
# Deletes a [notebook][1] in Amazon SageMaker Unified Studio.
|
|
5426
|
+
#
|
|
5427
|
+
#
|
|
5428
|
+
#
|
|
5429
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
5430
|
+
#
|
|
5431
|
+
# @option params [required, String] :domain_identifier
|
|
5432
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
5433
|
+
# the notebook exists.
|
|
5434
|
+
#
|
|
5435
|
+
# @option params [required, String] :identifier
|
|
5436
|
+
# The identifier of the notebook to delete.
|
|
5437
|
+
#
|
|
5438
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
5439
|
+
#
|
|
5440
|
+
# @example Request syntax with placeholder values
|
|
5441
|
+
#
|
|
5442
|
+
# resp = client.delete_notebook({
|
|
5443
|
+
# domain_identifier: "DomainId", # required
|
|
5444
|
+
# identifier: "NotebookId", # required
|
|
5445
|
+
# })
|
|
5446
|
+
#
|
|
5447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteNotebook AWS API Documentation
|
|
5448
|
+
#
|
|
5449
|
+
# @overload delete_notebook(params = {})
|
|
5450
|
+
# @param [Hash] params ({})
|
|
5451
|
+
def delete_notebook(params = {}, options = {})
|
|
5452
|
+
req = build_request(:delete_notebook, params)
|
|
5453
|
+
req.send_request(options)
|
|
5454
|
+
end
|
|
5455
|
+
|
|
5313
5456
|
# Deletes a project in Amazon DataZone.
|
|
5314
5457
|
#
|
|
5315
5458
|
# @option params [required, String] :domain_identifier
|
|
@@ -7621,11 +7764,148 @@ module Aws::DataZone
|
|
|
7621
7764
|
req.send_request(options)
|
|
7622
7765
|
end
|
|
7623
7766
|
|
|
7624
|
-
# Gets the details of a notebook
|
|
7767
|
+
# Gets the details of a [notebook][1] in Amazon SageMaker Unified
|
|
7768
|
+
# Studio.
|
|
7769
|
+
#
|
|
7770
|
+
#
|
|
7771
|
+
#
|
|
7772
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
7625
7773
|
#
|
|
7626
7774
|
# @option params [required, String] :domain_identifier
|
|
7627
|
-
# The identifier of the Amazon
|
|
7628
|
-
# exists.
|
|
7775
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
7776
|
+
# the notebook exists.
|
|
7777
|
+
#
|
|
7778
|
+
# @option params [required, String] :identifier
|
|
7779
|
+
# The identifier of the notebook.
|
|
7780
|
+
#
|
|
7781
|
+
# @return [Types::GetNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7782
|
+
#
|
|
7783
|
+
# * {Types::GetNotebookOutput#id #id} => String
|
|
7784
|
+
# * {Types::GetNotebookOutput#name #name} => String
|
|
7785
|
+
# * {Types::GetNotebookOutput#owning_project_id #owning_project_id} => String
|
|
7786
|
+
# * {Types::GetNotebookOutput#domain_id #domain_id} => String
|
|
7787
|
+
# * {Types::GetNotebookOutput#cell_order #cell_order} => Array<Types::CellInformation>
|
|
7788
|
+
# * {Types::GetNotebookOutput#status #status} => String
|
|
7789
|
+
# * {Types::GetNotebookOutput#description #description} => String
|
|
7790
|
+
# * {Types::GetNotebookOutput#created_at #created_at} => Time
|
|
7791
|
+
# * {Types::GetNotebookOutput#created_by #created_by} => String
|
|
7792
|
+
# * {Types::GetNotebookOutput#updated_at #updated_at} => Time
|
|
7793
|
+
# * {Types::GetNotebookOutput#updated_by #updated_by} => String
|
|
7794
|
+
# * {Types::GetNotebookOutput#locked_by #locked_by} => String
|
|
7795
|
+
# * {Types::GetNotebookOutput#locked_at #locked_at} => Time
|
|
7796
|
+
# * {Types::GetNotebookOutput#lock_expires_at #lock_expires_at} => Time
|
|
7797
|
+
# * {Types::GetNotebookOutput#compute_id #compute_id} => String
|
|
7798
|
+
# * {Types::GetNotebookOutput#metadata #metadata} => Hash<String,String>
|
|
7799
|
+
# * {Types::GetNotebookOutput#parameters #parameters} => Hash<String,String>
|
|
7800
|
+
# * {Types::GetNotebookOutput#environment_configuration #environment_configuration} => Types::EnvironmentConfig
|
|
7801
|
+
# * {Types::GetNotebookOutput#error #error} => Types::NotebookError
|
|
7802
|
+
#
|
|
7803
|
+
# @example Request syntax with placeholder values
|
|
7804
|
+
#
|
|
7805
|
+
# resp = client.get_notebook({
|
|
7806
|
+
# domain_identifier: "DomainId", # required
|
|
7807
|
+
# identifier: "NotebookId", # required
|
|
7808
|
+
# })
|
|
7809
|
+
#
|
|
7810
|
+
# @example Response structure
|
|
7811
|
+
#
|
|
7812
|
+
# resp.id #=> String
|
|
7813
|
+
# resp.name #=> String
|
|
7814
|
+
# resp.owning_project_id #=> String
|
|
7815
|
+
# resp.domain_id #=> String
|
|
7816
|
+
# resp.cell_order #=> Array
|
|
7817
|
+
# resp.status #=> String, one of "ACTIVE", "ARCHIVED"
|
|
7818
|
+
# resp.description #=> String
|
|
7819
|
+
# resp.created_at #=> Time
|
|
7820
|
+
# resp.created_by #=> String
|
|
7821
|
+
# resp.updated_at #=> Time
|
|
7822
|
+
# resp.updated_by #=> String
|
|
7823
|
+
# resp.locked_by #=> String
|
|
7824
|
+
# resp.locked_at #=> Time
|
|
7825
|
+
# resp.lock_expires_at #=> Time
|
|
7826
|
+
# resp.compute_id #=> String
|
|
7827
|
+
# resp.metadata #=> Hash
|
|
7828
|
+
# resp.metadata["MetadataKey"] #=> String
|
|
7829
|
+
# resp.parameters #=> Hash
|
|
7830
|
+
# resp.parameters["ParameterKey"] #=> String
|
|
7831
|
+
# resp.environment_configuration.image_version #=> String
|
|
7832
|
+
# resp.environment_configuration.package_config.package_manager #=> String, one of "UV"
|
|
7833
|
+
# resp.environment_configuration.package_config.package_specification #=> String
|
|
7834
|
+
# resp.error.message #=> String
|
|
7835
|
+
#
|
|
7836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetNotebook AWS API Documentation
|
|
7837
|
+
#
|
|
7838
|
+
# @overload get_notebook(params = {})
|
|
7839
|
+
# @param [Hash] params ({})
|
|
7840
|
+
def get_notebook(params = {}, options = {})
|
|
7841
|
+
req = build_request(:get_notebook, params)
|
|
7842
|
+
req.send_request(options)
|
|
7843
|
+
end
|
|
7844
|
+
|
|
7845
|
+
# Gets the details of a notebook export in Amazon SageMaker Unified
|
|
7846
|
+
# Studio.
|
|
7847
|
+
#
|
|
7848
|
+
# @option params [required, String] :domain_identifier
|
|
7849
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
7850
|
+
# the notebook export exists.
|
|
7851
|
+
#
|
|
7852
|
+
# @option params [required, String] :identifier
|
|
7853
|
+
# The identifier of the notebook export.
|
|
7854
|
+
#
|
|
7855
|
+
# @return [Types::GetNotebookExportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
7856
|
+
#
|
|
7857
|
+
# * {Types::GetNotebookExportOutput#id #id} => String
|
|
7858
|
+
# * {Types::GetNotebookExportOutput#domain_id #domain_id} => String
|
|
7859
|
+
# * {Types::GetNotebookExportOutput#owning_project_id #owning_project_id} => String
|
|
7860
|
+
# * {Types::GetNotebookExportOutput#notebook_id #notebook_id} => String
|
|
7861
|
+
# * {Types::GetNotebookExportOutput#file_format #file_format} => String
|
|
7862
|
+
# * {Types::GetNotebookExportOutput#status #status} => String
|
|
7863
|
+
# * {Types::GetNotebookExportOutput#output_location #output_location} => Types::OutputLocation
|
|
7864
|
+
# * {Types::GetNotebookExportOutput#error #error} => Types::NotebookExportError
|
|
7865
|
+
# * {Types::GetNotebookExportOutput#completed_at #completed_at} => Time
|
|
7866
|
+
# * {Types::GetNotebookExportOutput#created_at #created_at} => Time
|
|
7867
|
+
# * {Types::GetNotebookExportOutput#created_by #created_by} => String
|
|
7868
|
+
#
|
|
7869
|
+
# @example Request syntax with placeholder values
|
|
7870
|
+
#
|
|
7871
|
+
# resp = client.get_notebook_export({
|
|
7872
|
+
# domain_identifier: "DomainId", # required
|
|
7873
|
+
# identifier: "ExportId", # required
|
|
7874
|
+
# })
|
|
7875
|
+
#
|
|
7876
|
+
# @example Response structure
|
|
7877
|
+
#
|
|
7878
|
+
# resp.id #=> String
|
|
7879
|
+
# resp.domain_id #=> String
|
|
7880
|
+
# resp.owning_project_id #=> String
|
|
7881
|
+
# resp.notebook_id #=> String
|
|
7882
|
+
# resp.file_format #=> String, one of "PDF", "IPYNB"
|
|
7883
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
7884
|
+
# resp.output_location.s3.uri #=> String
|
|
7885
|
+
# resp.error.message #=> String
|
|
7886
|
+
# resp.completed_at #=> Time
|
|
7887
|
+
# resp.created_at #=> Time
|
|
7888
|
+
# resp.created_by #=> String
|
|
7889
|
+
#
|
|
7890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetNotebookExport AWS API Documentation
|
|
7891
|
+
#
|
|
7892
|
+
# @overload get_notebook_export(params = {})
|
|
7893
|
+
# @param [Hash] params ({})
|
|
7894
|
+
def get_notebook_export(params = {}, options = {})
|
|
7895
|
+
req = build_request(:get_notebook_export, params)
|
|
7896
|
+
req.send_request(options)
|
|
7897
|
+
end
|
|
7898
|
+
|
|
7899
|
+
# Gets the details of a [notebook run][1] in Amazon SageMaker Unified
|
|
7900
|
+
# Studio.
|
|
7901
|
+
#
|
|
7902
|
+
#
|
|
7903
|
+
#
|
|
7904
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
7905
|
+
#
|
|
7906
|
+
# @option params [required, String] :domain_identifier
|
|
7907
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
7908
|
+
# the notebook run exists.
|
|
7629
7909
|
#
|
|
7630
7910
|
# @option params [required, String] :identifier
|
|
7631
7911
|
# The identifier of the notebook run.
|
|
@@ -10066,11 +10346,15 @@ module Aws::DataZone
|
|
|
10066
10346
|
req.send_request(options)
|
|
10067
10347
|
end
|
|
10068
10348
|
|
|
10069
|
-
# Lists notebook runs in
|
|
10349
|
+
# Lists [notebook runs][1] in Amazon SageMaker Unified Studio.
|
|
10350
|
+
#
|
|
10351
|
+
#
|
|
10352
|
+
#
|
|
10353
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
10070
10354
|
#
|
|
10071
10355
|
# @option params [required, String] :domain_identifier
|
|
10072
|
-
# The identifier of the Amazon
|
|
10073
|
-
# runs.
|
|
10356
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
10357
|
+
# to list notebook runs.
|
|
10074
10358
|
#
|
|
10075
10359
|
# @option params [required, String] :owning_project_identifier
|
|
10076
10360
|
# The identifier of the project that owns the notebook runs.
|
|
@@ -10148,6 +10432,84 @@ module Aws::DataZone
|
|
|
10148
10432
|
req.send_request(options)
|
|
10149
10433
|
end
|
|
10150
10434
|
|
|
10435
|
+
# Lists [notebooks][1] in Amazon SageMaker Unified Studio.
|
|
10436
|
+
#
|
|
10437
|
+
#
|
|
10438
|
+
#
|
|
10439
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
10440
|
+
#
|
|
10441
|
+
# @option params [required, String] :domain_identifier
|
|
10442
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
10443
|
+
# to list notebooks.
|
|
10444
|
+
#
|
|
10445
|
+
# @option params [required, String] :owning_project_identifier
|
|
10446
|
+
# The identifier of the project that owns the notebooks.
|
|
10447
|
+
#
|
|
10448
|
+
# @option params [Integer] :max_results
|
|
10449
|
+
# The maximum number of notebooks to return in a single call. When the
|
|
10450
|
+
# number of notebooks exceeds the value of `MaxResults`, the response
|
|
10451
|
+
# contains a `NextToken` value.
|
|
10452
|
+
#
|
|
10453
|
+
# @option params [String] :sort_order
|
|
10454
|
+
# The sort order for the results.
|
|
10455
|
+
#
|
|
10456
|
+
# @option params [String] :sort_by
|
|
10457
|
+
# The field to sort the results by.
|
|
10458
|
+
#
|
|
10459
|
+
# @option params [String] :status
|
|
10460
|
+
# The status to filter notebooks by.
|
|
10461
|
+
#
|
|
10462
|
+
# @option params [String] :next_token
|
|
10463
|
+
# When the number of notebooks is greater than the default value for the
|
|
10464
|
+
# `MaxResults` parameter, or if you explicitly specify a value for
|
|
10465
|
+
# `MaxResults` that is less than the number of notebooks, the response
|
|
10466
|
+
# includes a pagination token named `NextToken`. You can specify this
|
|
10467
|
+
# `NextToken` value in a subsequent call to `ListNotebooks` to list the
|
|
10468
|
+
# next set of notebooks.
|
|
10469
|
+
#
|
|
10470
|
+
# @return [Types::ListNotebooksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10471
|
+
#
|
|
10472
|
+
# * {Types::ListNotebooksOutput#items #items} => Array<Types::NotebookSummary>
|
|
10473
|
+
# * {Types::ListNotebooksOutput#next_token #next_token} => String
|
|
10474
|
+
#
|
|
10475
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
10476
|
+
#
|
|
10477
|
+
# @example Request syntax with placeholder values
|
|
10478
|
+
#
|
|
10479
|
+
# resp = client.list_notebooks({
|
|
10480
|
+
# domain_identifier: "DomainId", # required
|
|
10481
|
+
# owning_project_identifier: "ProjectId", # required
|
|
10482
|
+
# max_results: 1,
|
|
10483
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
|
10484
|
+
# sort_by: "CREATED_AT", # accepts CREATED_AT, UPDATED_AT
|
|
10485
|
+
# status: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
|
10486
|
+
# next_token: "PaginationToken",
|
|
10487
|
+
# })
|
|
10488
|
+
#
|
|
10489
|
+
# @example Response structure
|
|
10490
|
+
#
|
|
10491
|
+
# resp.items #=> Array
|
|
10492
|
+
# resp.items[0].id #=> String
|
|
10493
|
+
# resp.items[0].name #=> String
|
|
10494
|
+
# resp.items[0].owning_project_id #=> String
|
|
10495
|
+
# resp.items[0].domain_id #=> String
|
|
10496
|
+
# resp.items[0].status #=> String, one of "ACTIVE", "ARCHIVED"
|
|
10497
|
+
# resp.items[0].description #=> String
|
|
10498
|
+
# resp.items[0].created_at #=> Time
|
|
10499
|
+
# resp.items[0].created_by #=> String
|
|
10500
|
+
# resp.items[0].updated_at #=> Time
|
|
10501
|
+
# resp.items[0].updated_by #=> String
|
|
10502
|
+
# resp.next_token #=> String
|
|
10503
|
+
#
|
|
10504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListNotebooks AWS API Documentation
|
|
10505
|
+
#
|
|
10506
|
+
# @overload list_notebooks(params = {})
|
|
10507
|
+
# @param [Hash] params ({})
|
|
10508
|
+
def list_notebooks(params = {}, options = {})
|
|
10509
|
+
req = build_request(:list_notebooks, params)
|
|
10510
|
+
req.send_request(options)
|
|
10511
|
+
end
|
|
10512
|
+
|
|
10151
10513
|
# Lists all Amazon DataZone notifications.
|
|
10152
10514
|
#
|
|
10153
10515
|
# @option params [required, String] :domain_identifier
|
|
@@ -12986,14 +13348,159 @@ module Aws::DataZone
|
|
|
12986
13348
|
req.send_request(options)
|
|
12987
13349
|
end
|
|
12988
13350
|
|
|
12989
|
-
# Starts a notebook
|
|
12990
|
-
#
|
|
12991
|
-
#
|
|
12992
|
-
#
|
|
13351
|
+
# Starts a notebook export in Amazon SageMaker Unified Studio. This
|
|
13352
|
+
# operation exports a notebook to a specified file format and stores the
|
|
13353
|
+
# output in Amazon Simple Storage Service.
|
|
13354
|
+
#
|
|
13355
|
+
# @option params [required, String] :domain_identifier
|
|
13356
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
13357
|
+
# to export the notebook.
|
|
13358
|
+
#
|
|
13359
|
+
# @option params [required, String] :notebook_identifier
|
|
13360
|
+
# The identifier of the notebook to export.
|
|
13361
|
+
#
|
|
13362
|
+
# @option params [required, String] :owning_project_identifier
|
|
13363
|
+
# The identifier of the project that owns the notebook.
|
|
13364
|
+
#
|
|
13365
|
+
# @option params [required, String] :file_format
|
|
13366
|
+
# The file format for the notebook export. Valid values are `PDF` and
|
|
13367
|
+
# `IPYNB`.
|
|
13368
|
+
#
|
|
13369
|
+
# @option params [String] :client_token
|
|
13370
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
|
13371
|
+
# request. This field is automatically populated if not provided.
|
|
13372
|
+
#
|
|
13373
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
13374
|
+
# not need to pass this option.**
|
|
13375
|
+
#
|
|
13376
|
+
# @return [Types::StartNotebookExportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13377
|
+
#
|
|
13378
|
+
# * {Types::StartNotebookExportOutput#id #id} => String
|
|
13379
|
+
# * {Types::StartNotebookExportOutput#domain_id #domain_id} => String
|
|
13380
|
+
# * {Types::StartNotebookExportOutput#owning_project_id #owning_project_id} => String
|
|
13381
|
+
# * {Types::StartNotebookExportOutput#notebook_id #notebook_id} => String
|
|
13382
|
+
# * {Types::StartNotebookExportOutput#file_format #file_format} => String
|
|
13383
|
+
# * {Types::StartNotebookExportOutput#status #status} => String
|
|
13384
|
+
# * {Types::StartNotebookExportOutput#created_at #created_at} => Time
|
|
13385
|
+
# * {Types::StartNotebookExportOutput#created_by #created_by} => String
|
|
13386
|
+
#
|
|
13387
|
+
# @example Request syntax with placeholder values
|
|
13388
|
+
#
|
|
13389
|
+
# resp = client.start_notebook_export({
|
|
13390
|
+
# domain_identifier: "DomainId", # required
|
|
13391
|
+
# notebook_identifier: "NotebookId", # required
|
|
13392
|
+
# owning_project_identifier: "ProjectId", # required
|
|
13393
|
+
# file_format: "PDF", # required, accepts PDF, IPYNB
|
|
13394
|
+
# client_token: "ClientToken",
|
|
13395
|
+
# })
|
|
13396
|
+
#
|
|
13397
|
+
# @example Response structure
|
|
13398
|
+
#
|
|
13399
|
+
# resp.id #=> String
|
|
13400
|
+
# resp.domain_id #=> String
|
|
13401
|
+
# resp.owning_project_id #=> String
|
|
13402
|
+
# resp.notebook_id #=> String
|
|
13403
|
+
# resp.file_format #=> String, one of "PDF", "IPYNB"
|
|
13404
|
+
# resp.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
13405
|
+
# resp.created_at #=> Time
|
|
13406
|
+
# resp.created_by #=> String
|
|
13407
|
+
#
|
|
13408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/StartNotebookExport AWS API Documentation
|
|
13409
|
+
#
|
|
13410
|
+
# @overload start_notebook_export(params = {})
|
|
13411
|
+
# @param [Hash] params ({})
|
|
13412
|
+
def start_notebook_export(params = {}, options = {})
|
|
13413
|
+
req = build_request(:start_notebook_export, params)
|
|
13414
|
+
req.send_request(options)
|
|
13415
|
+
end
|
|
13416
|
+
|
|
13417
|
+
# Starts a notebook import in Amazon SageMaker Unified Studio. This
|
|
13418
|
+
# operation imports a notebook from an Amazon Simple Storage Service
|
|
13419
|
+
# location into a project.
|
|
13420
|
+
#
|
|
13421
|
+
# @option params [required, String] :domain_identifier
|
|
13422
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
13423
|
+
# to import the notebook.
|
|
13424
|
+
#
|
|
13425
|
+
# @option params [required, String] :owning_project_identifier
|
|
13426
|
+
# The identifier of the project that will own the imported notebook.
|
|
13427
|
+
#
|
|
13428
|
+
# @option params [required, Types::SourceLocation] :source_location
|
|
13429
|
+
# The source location of the notebook to import. This specifies the
|
|
13430
|
+
# Amazon Simple Storage Service URI of the notebook file.
|
|
13431
|
+
#
|
|
13432
|
+
# @option params [required, String] :name
|
|
13433
|
+
# The name of the imported notebook. The name must be between 1 and 256
|
|
13434
|
+
# characters.
|
|
13435
|
+
#
|
|
13436
|
+
# @option params [String] :description
|
|
13437
|
+
# The description of the imported notebook.
|
|
13438
|
+
#
|
|
13439
|
+
# @option params [String] :client_token
|
|
13440
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
|
13441
|
+
# request. This field is automatically populated if not provided.
|
|
13442
|
+
#
|
|
13443
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
13444
|
+
# not need to pass this option.**
|
|
13445
|
+
#
|
|
13446
|
+
# @return [Types::StartNotebookImportOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
13447
|
+
#
|
|
13448
|
+
# * {Types::StartNotebookImportOutput#notebook_id #notebook_id} => String
|
|
13449
|
+
# * {Types::StartNotebookImportOutput#status #status} => String
|
|
13450
|
+
# * {Types::StartNotebookImportOutput#domain_id #domain_id} => String
|
|
13451
|
+
# * {Types::StartNotebookImportOutput#owning_project_id #owning_project_id} => String
|
|
13452
|
+
# * {Types::StartNotebookImportOutput#name #name} => String
|
|
13453
|
+
# * {Types::StartNotebookImportOutput#description #description} => String
|
|
13454
|
+
# * {Types::StartNotebookImportOutput#source_location #source_location} => Types::SourceLocation
|
|
13455
|
+
# * {Types::StartNotebookImportOutput#created_at #created_at} => Time
|
|
13456
|
+
# * {Types::StartNotebookImportOutput#created_by #created_by} => String
|
|
13457
|
+
#
|
|
13458
|
+
# @example Request syntax with placeholder values
|
|
13459
|
+
#
|
|
13460
|
+
# resp = client.start_notebook_import({
|
|
13461
|
+
# domain_identifier: "DomainId", # required
|
|
13462
|
+
# owning_project_identifier: "ProjectId", # required
|
|
13463
|
+
# source_location: { # required
|
|
13464
|
+
# s3: "S3SourceLocation",
|
|
13465
|
+
# },
|
|
13466
|
+
# name: "NotebookName", # required
|
|
13467
|
+
# description: "Description",
|
|
13468
|
+
# client_token: "ClientToken",
|
|
13469
|
+
# })
|
|
13470
|
+
#
|
|
13471
|
+
# @example Response structure
|
|
13472
|
+
#
|
|
13473
|
+
# resp.notebook_id #=> String
|
|
13474
|
+
# resp.status #=> String, one of "ACTIVE", "ARCHIVED"
|
|
13475
|
+
# resp.domain_id #=> String
|
|
13476
|
+
# resp.owning_project_id #=> String
|
|
13477
|
+
# resp.name #=> String
|
|
13478
|
+
# resp.description #=> String
|
|
13479
|
+
# resp.source_location.s3 #=> String
|
|
13480
|
+
# resp.created_at #=> Time
|
|
13481
|
+
# resp.created_by #=> String
|
|
13482
|
+
#
|
|
13483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/StartNotebookImport AWS API Documentation
|
|
13484
|
+
#
|
|
13485
|
+
# @overload start_notebook_import(params = {})
|
|
13486
|
+
# @param [Hash] params ({})
|
|
13487
|
+
def start_notebook_import(params = {}, options = {})
|
|
13488
|
+
req = build_request(:start_notebook_import, params)
|
|
13489
|
+
req.send_request(options)
|
|
13490
|
+
end
|
|
13491
|
+
|
|
13492
|
+
# Starts a notebook run in Amazon SageMaker Unified Studio. A notebook
|
|
13493
|
+
# run represents the execution of an [Amazon SageMaker notebook][1]
|
|
13494
|
+
# within a project. You can configure compute, network, timeout, and
|
|
13495
|
+
# environment settings for the run.
|
|
13496
|
+
#
|
|
13497
|
+
#
|
|
13498
|
+
#
|
|
13499
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
12993
13500
|
#
|
|
12994
13501
|
# @option params [required, String] :domain_identifier
|
|
12995
|
-
# The identifier of the Amazon
|
|
12996
|
-
# is started.
|
|
13502
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
13503
|
+
# the notebook run is started.
|
|
12997
13504
|
#
|
|
12998
13505
|
# @option params [required, String] :owning_project_identifier
|
|
12999
13506
|
# The identifier of the project that owns the notebook run.
|
|
@@ -13140,11 +13647,15 @@ module Aws::DataZone
|
|
|
13140
13647
|
req.send_request(options)
|
|
13141
13648
|
end
|
|
13142
13649
|
|
|
13143
|
-
# Stops a running notebook run in
|
|
13650
|
+
# Stops a running [notebook run][1] in Amazon SageMaker Unified Studio.
|
|
13651
|
+
#
|
|
13652
|
+
#
|
|
13653
|
+
#
|
|
13654
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
13144
13655
|
#
|
|
13145
13656
|
# @option params [required, String] :domain_identifier
|
|
13146
|
-
# The identifier of the Amazon
|
|
13147
|
-
# is stopped.
|
|
13657
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
13658
|
+
# the notebook run is stopped.
|
|
13148
13659
|
#
|
|
13149
13660
|
# @option params [required, String] :identifier
|
|
13150
13661
|
# The identifier of the notebook run to stop.
|
|
@@ -14731,6 +15242,133 @@ module Aws::DataZone
|
|
|
14731
15242
|
req.send_request(options)
|
|
14732
15243
|
end
|
|
14733
15244
|
|
|
15245
|
+
# Updates a [notebook][1] in Amazon SageMaker Unified Studio.
|
|
15246
|
+
#
|
|
15247
|
+
#
|
|
15248
|
+
#
|
|
15249
|
+
# [1]: https://docs.aws.amazon.com/sagemaker-unified-studio/latest/userguide/notebooks.html
|
|
15250
|
+
#
|
|
15251
|
+
# @option params [required, String] :domain_identifier
|
|
15252
|
+
# The identifier of the Amazon SageMaker Unified Studio domain in which
|
|
15253
|
+
# the notebook exists.
|
|
15254
|
+
#
|
|
15255
|
+
# @option params [required, String] :identifier
|
|
15256
|
+
# The identifier of the notebook to update.
|
|
15257
|
+
#
|
|
15258
|
+
# @option params [String] :description
|
|
15259
|
+
# The updated description of the notebook.
|
|
15260
|
+
#
|
|
15261
|
+
# @option params [String] :status
|
|
15262
|
+
# The updated status of the notebook.
|
|
15263
|
+
#
|
|
15264
|
+
# @option params [String] :name
|
|
15265
|
+
# The updated name of the notebook.
|
|
15266
|
+
#
|
|
15267
|
+
# @option params [Array<Types::CellInformation>] :cell_order
|
|
15268
|
+
# The updated ordered list of cells in the notebook.
|
|
15269
|
+
#
|
|
15270
|
+
# @option params [Hash<String,String>] :metadata
|
|
15271
|
+
# The updated metadata for the notebook, specified as key-value pairs.
|
|
15272
|
+
#
|
|
15273
|
+
# @option params [Hash<String,String>] :parameters
|
|
15274
|
+
# The updated sensitive parameters for the notebook, specified as
|
|
15275
|
+
# key-value pairs.
|
|
15276
|
+
#
|
|
15277
|
+
# @option params [Types::EnvironmentConfig] :environment_configuration
|
|
15278
|
+
# The updated environment configuration for the notebook.
|
|
15279
|
+
#
|
|
15280
|
+
# @option params [String] :client_token
|
|
15281
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
|
15282
|
+
# request. This field is automatically populated if not provided.
|
|
15283
|
+
#
|
|
15284
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
15285
|
+
# not need to pass this option.**
|
|
15286
|
+
#
|
|
15287
|
+
# @return [Types::UpdateNotebookOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
15288
|
+
#
|
|
15289
|
+
# * {Types::UpdateNotebookOutput#id #id} => String
|
|
15290
|
+
# * {Types::UpdateNotebookOutput#name #name} => String
|
|
15291
|
+
# * {Types::UpdateNotebookOutput#owning_project_id #owning_project_id} => String
|
|
15292
|
+
# * {Types::UpdateNotebookOutput#domain_id #domain_id} => String
|
|
15293
|
+
# * {Types::UpdateNotebookOutput#cell_order #cell_order} => Array<Types::CellInformation>
|
|
15294
|
+
# * {Types::UpdateNotebookOutput#status #status} => String
|
|
15295
|
+
# * {Types::UpdateNotebookOutput#description #description} => String
|
|
15296
|
+
# * {Types::UpdateNotebookOutput#created_at #created_at} => Time
|
|
15297
|
+
# * {Types::UpdateNotebookOutput#created_by #created_by} => String
|
|
15298
|
+
# * {Types::UpdateNotebookOutput#updated_at #updated_at} => Time
|
|
15299
|
+
# * {Types::UpdateNotebookOutput#updated_by #updated_by} => String
|
|
15300
|
+
# * {Types::UpdateNotebookOutput#locked_by #locked_by} => String
|
|
15301
|
+
# * {Types::UpdateNotebookOutput#locked_at #locked_at} => Time
|
|
15302
|
+
# * {Types::UpdateNotebookOutput#lock_expires_at #lock_expires_at} => Time
|
|
15303
|
+
# * {Types::UpdateNotebookOutput#compute_id #compute_id} => String
|
|
15304
|
+
# * {Types::UpdateNotebookOutput#metadata #metadata} => Hash<String,String>
|
|
15305
|
+
# * {Types::UpdateNotebookOutput#parameters #parameters} => Hash<String,String>
|
|
15306
|
+
# * {Types::UpdateNotebookOutput#environment_configuration #environment_configuration} => Types::EnvironmentConfig
|
|
15307
|
+
# * {Types::UpdateNotebookOutput#error #error} => Types::NotebookError
|
|
15308
|
+
#
|
|
15309
|
+
# @example Request syntax with placeholder values
|
|
15310
|
+
#
|
|
15311
|
+
# resp = client.update_notebook({
|
|
15312
|
+
# domain_identifier: "DomainId", # required
|
|
15313
|
+
# identifier: "NotebookId", # required
|
|
15314
|
+
# description: "Description",
|
|
15315
|
+
# status: "ACTIVE", # accepts ACTIVE, ARCHIVED
|
|
15316
|
+
# name: "NotebookName",
|
|
15317
|
+
# cell_order: [
|
|
15318
|
+
# {
|
|
15319
|
+
# },
|
|
15320
|
+
# ],
|
|
15321
|
+
# metadata: {
|
|
15322
|
+
# "MetadataKey" => "MetadataValue",
|
|
15323
|
+
# },
|
|
15324
|
+
# parameters: {
|
|
15325
|
+
# "ParameterKey" => "ParameterValue",
|
|
15326
|
+
# },
|
|
15327
|
+
# environment_configuration: {
|
|
15328
|
+
# image_version: "String",
|
|
15329
|
+
# package_config: {
|
|
15330
|
+
# package_manager: "UV", # required, accepts UV
|
|
15331
|
+
# package_specification: "PackageConfigPackageSpecificationString",
|
|
15332
|
+
# },
|
|
15333
|
+
# },
|
|
15334
|
+
# client_token: "ClientToken",
|
|
15335
|
+
# })
|
|
15336
|
+
#
|
|
15337
|
+
# @example Response structure
|
|
15338
|
+
#
|
|
15339
|
+
# resp.id #=> String
|
|
15340
|
+
# resp.name #=> String
|
|
15341
|
+
# resp.owning_project_id #=> String
|
|
15342
|
+
# resp.domain_id #=> String
|
|
15343
|
+
# resp.cell_order #=> Array
|
|
15344
|
+
# resp.status #=> String, one of "ACTIVE", "ARCHIVED"
|
|
15345
|
+
# resp.description #=> String
|
|
15346
|
+
# resp.created_at #=> Time
|
|
15347
|
+
# resp.created_by #=> String
|
|
15348
|
+
# resp.updated_at #=> Time
|
|
15349
|
+
# resp.updated_by #=> String
|
|
15350
|
+
# resp.locked_by #=> String
|
|
15351
|
+
# resp.locked_at #=> Time
|
|
15352
|
+
# resp.lock_expires_at #=> Time
|
|
15353
|
+
# resp.compute_id #=> String
|
|
15354
|
+
# resp.metadata #=> Hash
|
|
15355
|
+
# resp.metadata["MetadataKey"] #=> String
|
|
15356
|
+
# resp.parameters #=> Hash
|
|
15357
|
+
# resp.parameters["ParameterKey"] #=> String
|
|
15358
|
+
# resp.environment_configuration.image_version #=> String
|
|
15359
|
+
# resp.environment_configuration.package_config.package_manager #=> String, one of "UV"
|
|
15360
|
+
# resp.environment_configuration.package_config.package_specification #=> String
|
|
15361
|
+
# resp.error.message #=> String
|
|
15362
|
+
#
|
|
15363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateNotebook AWS API Documentation
|
|
15364
|
+
#
|
|
15365
|
+
# @overload update_notebook(params = {})
|
|
15366
|
+
# @param [Hash] params ({})
|
|
15367
|
+
def update_notebook(params = {}, options = {})
|
|
15368
|
+
req = build_request(:update_notebook, params)
|
|
15369
|
+
req.send_request(options)
|
|
15370
|
+
end
|
|
15371
|
+
|
|
14734
15372
|
# Updates the specified project in Amazon DataZone.
|
|
14735
15373
|
#
|
|
14736
15374
|
# @option params [required, String] :domain_identifier
|
|
@@ -15579,7 +16217,7 @@ module Aws::DataZone
|
|
|
15579
16217
|
tracer: tracer
|
|
15580
16218
|
)
|
|
15581
16219
|
context[:gem_name] = 'aws-sdk-datazone'
|
|
15582
|
-
context[:gem_version] = '1.
|
|
16220
|
+
context[:gem_version] = '1.77.0'
|
|
15583
16221
|
Seahorse::Client::Request.new(handlers, context)
|
|
15584
16222
|
end
|
|
15585
16223
|
|