aws-sdk-finspacedata 1.5.0 → 1.9.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.
@@ -121,7 +121,9 @@ module Aws::FinSpaceData
121
121
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
122
122
  # are very aggressive. Construct and pass an instance of
123
123
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
124
- # enable retries and extended timeouts.
124
+ # enable retries and extended timeouts. Instance profile credential
125
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
126
+ # to true.
125
127
  #
126
128
  # @option options [required, String] :region
127
129
  # The AWS region to connect to. The configured `:region` is
@@ -338,84 +340,76 @@ module Aws::FinSpaceData
338
340
 
339
341
  # @!group API Operations
340
342
 
341
- # Creates a new changeset in a FinSpace dataset.
343
+ # Creates a new Changeset in a FinSpace Dataset.
344
+ #
345
+ # @option params [String] :client_token
346
+ # A token used to ensure idempotency.
347
+ #
348
+ # **A suitable default value is auto-generated.** You should normally
349
+ # not need to pass this option.**
342
350
  #
343
351
  # @option params [required, String] :dataset_id
344
- # The unique identifier for the FinSpace dataset in which the changeset
352
+ # The unique identifier for the FinSpace Dataset where the Changeset
345
353
  # will be created.
346
354
  #
347
355
  # @option params [required, String] :change_type
348
- # Option to indicate how a changeset will be applied to a dataset.
356
+ # Option to indicate how a Changeset will be applied to a Dataset.
349
357
  #
350
358
  # * `REPLACE` - Changeset will be considered as a replacement to all
351
- # prior loaded changesets.
359
+ # prior loaded Changesets.
352
360
  #
353
361
  # * `APPEND` - Changeset will be considered as an addition to the end of
354
- # all prior loaded changesets.
362
+ # all prior loaded Changesets.
355
363
  #
356
- # @option params [required, String] :source_type
357
- # Type of the data source from which the files to create the changeset
358
- # will be sourced.
364
+ # * `MODIFY` - Changeset is considered as a replacement to a specific
365
+ # prior ingested Changeset.
359
366
  #
360
- # * `S3` - Amazon S3.
367
+ # @option params [required, Hash<String,String>] :source_params
368
+ # Options that define the location of the data being ingested.
361
369
  #
362
- # ^
370
+ # @option params [required, Hash<String,String>] :format_params
371
+ # Options that define the structure of the source file(s) including the
372
+ # format type (`formatType`), header row (`withHeader`), data separation
373
+ # character (`separator`) and the type of compression (`compression`).
363
374
  #
364
- # @option params [required, Hash<String,String>] :source_params
365
- # Source path from which the files to create the changeset will be
366
- # sourced.
375
+ # `formatType` is a required attribute and can have the following
376
+ # values:
367
377
  #
368
- # @option params [String] :format_type
369
- # Format type of the input files being loaded into the changeset.
378
+ # * `PARQUET` - Parquet source file format.
370
379
  #
371
- # @option params [Hash<String,String>] :format_params
372
- # Options that define the structure of the source file(s).
380
+ # * `CSV` - CSV source file format.
381
+ #
382
+ # * `JSON` - JSON source file format.
373
383
  #
374
- # @option params [Hash<String,String>] :tags
375
- # Metadata tags to apply to this changeset.
384
+ # * `XML` - XML source file format.
385
+ #
386
+ # For example, you could specify the following for `formatParams`\: `
387
+ # "formatParams": \{ "formatType": "CSV", "withHeader": "true",
388
+ # "separator": ",", "compression":"None" \} `
376
389
  #
377
390
  # @return [Types::CreateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
391
  #
379
- # * {Types::CreateChangesetResponse#changeset #changeset} => Types::ChangesetInfo
392
+ # * {Types::CreateChangesetResponse#dataset_id #dataset_id} => String
393
+ # * {Types::CreateChangesetResponse#changeset_id #changeset_id} => String
380
394
  #
381
395
  # @example Request syntax with placeholder values
382
396
  #
383
397
  # resp = client.create_changeset({
384
- # dataset_id: "IdType", # required
398
+ # client_token: "ClientToken",
399
+ # dataset_id: "DatasetId", # required
385
400
  # change_type: "REPLACE", # required, accepts REPLACE, APPEND, MODIFY
386
- # source_type: "S3", # required, accepts S3
387
401
  # source_params: { # required
388
- # "stringMapKey" => "stringMapValue",
389
- # },
390
- # format_type: "CSV", # accepts CSV, JSON, PARQUET, XML
391
- # format_params: {
392
- # "stringMapKey" => "stringMapValue",
402
+ # "StringMapKey" => "StringMapValue",
393
403
  # },
394
- # tags: {
395
- # "stringMapKey" => "stringMapValue",
404
+ # format_params: { # required
405
+ # "StringMapKey" => "StringMapValue",
396
406
  # },
397
407
  # })
398
408
  #
399
409
  # @example Response structure
400
410
  #
401
- # resp.changeset.id #=> String
402
- # resp.changeset.changeset_arn #=> String
403
- # resp.changeset.dataset_id #=> String
404
- # resp.changeset.change_type #=> String, one of "REPLACE", "APPEND", "MODIFY"
405
- # resp.changeset.source_type #=> String, one of "S3"
406
- # resp.changeset.source_params #=> Hash
407
- # resp.changeset.source_params["stringMapKey"] #=> String
408
- # resp.changeset.format_type #=> String, one of "CSV", "JSON", "PARQUET", "XML"
409
- # resp.changeset.format_params #=> Hash
410
- # resp.changeset.format_params["stringMapKey"] #=> String
411
- # resp.changeset.create_timestamp #=> Time
412
- # resp.changeset.status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED"
413
- # resp.changeset.error_info.error_message #=> String
414
- # resp.changeset.error_info.error_category #=> String, one of "The_inputs_to_this_request_are_invalid", "Service_limits_have_been_exceeded", "Missing_required_permission_to_perform_this_request", "One_or_more_inputs_to_this_request_were_not_found", "The_system_temporarily_lacks_sufficient_resources_to_process_the_request", "An_internal_error_has_occurred", "Cancelled", "A_user_recoverable_error_has_occurred"
415
- # resp.changeset.changeset_labels #=> Hash
416
- # resp.changeset.changeset_labels["stringMapKey"] #=> String
417
- # resp.changeset.updates_changeset_id #=> String
418
- # resp.changeset.updated_by_changeset_id #=> String
411
+ # resp.dataset_id #=> String
412
+ # resp.changeset_id #=> String
419
413
  #
420
414
  # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateChangeset AWS API Documentation
421
415
  #
@@ -426,13 +420,369 @@ module Aws::FinSpaceData
426
420
  req.send_request(options)
427
421
  end
428
422
 
429
- # Request programmatic credentials to use with Habanero SDK.
423
+ # Creates a Dataview for a Dataset.
424
+ #
425
+ # @option params [String] :client_token
426
+ # A token used to ensure idempotency.
427
+ #
428
+ # **A suitable default value is auto-generated.** You should normally
429
+ # not need to pass this option.**
430
+ #
431
+ # @option params [required, String] :dataset_id
432
+ # The unique Dataset identifier that is used to create a Dataview.
433
+ #
434
+ # @option params [Boolean] :auto_update
435
+ # Flag to indicate Dataview should be updated automatically.
436
+ #
437
+ # @option params [Array<String>] :sort_columns
438
+ # Columns to be used for sorting the data.
439
+ #
440
+ # @option params [Array<String>] :partition_columns
441
+ # Ordered set of column names used to partition data.
442
+ #
443
+ # @option params [Integer] :as_of_timestamp
444
+ # Beginning time to use for the Dataview. The value is determined as
445
+ # Epoch time in milliseconds. For example, the value for Monday,
446
+ # November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
447
+ #
448
+ # @option params [required, Types::DataViewDestinationTypeParams] :destination_type_params
449
+ # Options that define the destination type for the Dataview.
450
+ #
451
+ # @return [Types::CreateDataViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
+ #
453
+ # * {Types::CreateDataViewResponse#dataset_id #dataset_id} => String
454
+ # * {Types::CreateDataViewResponse#data_view_id #data_view_id} => String
455
+ #
456
+ # @example Request syntax with placeholder values
457
+ #
458
+ # resp = client.create_data_view({
459
+ # client_token: "ClientToken",
460
+ # dataset_id: "DatasetId", # required
461
+ # auto_update: false,
462
+ # sort_columns: ["StringValueLength1to255"],
463
+ # partition_columns: ["StringValueLength1to255"],
464
+ # as_of_timestamp: 1,
465
+ # destination_type_params: { # required
466
+ # destination_type: "DataViewDestinationType", # required
467
+ # s3_destination_export_file_format: "PARQUET", # accepts PARQUET, DELIMITED_TEXT
468
+ # s3_destination_export_file_format_options: {
469
+ # "StringMapKey" => "StringMapValue",
470
+ # },
471
+ # },
472
+ # })
473
+ #
474
+ # @example Response structure
475
+ #
476
+ # resp.dataset_id #=> String
477
+ # resp.data_view_id #=> String
478
+ #
479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataView AWS API Documentation
480
+ #
481
+ # @overload create_data_view(params = {})
482
+ # @param [Hash] params ({})
483
+ def create_data_view(params = {}, options = {})
484
+ req = build_request(:create_data_view, params)
485
+ req.send_request(options)
486
+ end
487
+
488
+ # Creates a new FinSpace Dataset.
489
+ #
490
+ # @option params [String] :client_token
491
+ # A token used to ensure idempotency.
492
+ #
493
+ # **A suitable default value is auto-generated.** You should normally
494
+ # not need to pass this option.**
495
+ #
496
+ # @option params [required, String] :dataset_title
497
+ # Display title for a FinSpace Dataset.
498
+ #
499
+ # @option params [required, String] :kind
500
+ # The format in which Dataset data is structured.
501
+ #
502
+ # * `TABULAR` - Data is structured in a tabular format.
503
+ #
504
+ # * `NON_TABULAR` - Data is structured in a non-tabular format.
505
+ #
506
+ # @option params [String] :dataset_description
507
+ # Description of a Dataset.
508
+ #
509
+ # @option params [Types::DatasetOwnerInfo] :owner_info
510
+ # Contact information for a Dataset owner.
511
+ #
512
+ # @option params [required, Types::PermissionGroupParams] :permission_group_params
513
+ # Permission group parameters for Dataset permissions.
514
+ #
515
+ # @option params [String] :alias
516
+ # The unique resource identifier for a Dataset.
517
+ #
518
+ # @option params [Types::SchemaUnion] :schema_definition
519
+ # Definition for a schema on a tabular Dataset.
520
+ #
521
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
522
+ #
523
+ # * {Types::CreateDatasetResponse#dataset_id #dataset_id} => String
524
+ #
525
+ # @example Request syntax with placeholder values
526
+ #
527
+ # resp = client.create_dataset({
528
+ # client_token: "ClientToken",
529
+ # dataset_title: "DatasetTitle", # required
530
+ # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
531
+ # dataset_description: "DatasetDescription",
532
+ # owner_info: {
533
+ # name: "OwnerName",
534
+ # phone_number: "PhoneNumber",
535
+ # email: "Email",
536
+ # },
537
+ # permission_group_params: { # required
538
+ # permission_group_id: "PermissionGroupId",
539
+ # dataset_permissions: [
540
+ # {
541
+ # permission: "StringValueLength1to250",
542
+ # },
543
+ # ],
544
+ # },
545
+ # alias: "AliasString",
546
+ # schema_definition: {
547
+ # tabular_schema_config: {
548
+ # columns: [
549
+ # {
550
+ # data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
551
+ # column_name: "ColumnName",
552
+ # column_description: "ColumnDescription",
553
+ # },
554
+ # ],
555
+ # primary_key_columns: ["ColumnName"],
556
+ # },
557
+ # },
558
+ # })
559
+ #
560
+ # @example Response structure
561
+ #
562
+ # resp.dataset_id #=> String
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateDataset AWS API Documentation
565
+ #
566
+ # @overload create_dataset(params = {})
567
+ # @param [Hash] params ({})
568
+ def create_dataset(params = {}, options = {})
569
+ req = build_request(:create_dataset, params)
570
+ req.send_request(options)
571
+ end
572
+
573
+ # Deletes a FinSpace Dataset.
574
+ #
575
+ # @option params [String] :client_token
576
+ # A token used to ensure idempotency.
577
+ #
578
+ # **A suitable default value is auto-generated.** You should normally
579
+ # not need to pass this option.**
580
+ #
581
+ # @option params [required, String] :dataset_id
582
+ # The unique identifier of the Dataset to be deleted.
583
+ #
584
+ # @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
585
+ #
586
+ # * {Types::DeleteDatasetResponse#dataset_id #dataset_id} => String
587
+ #
588
+ # @example Request syntax with placeholder values
589
+ #
590
+ # resp = client.delete_dataset({
591
+ # client_token: "ClientToken",
592
+ # dataset_id: "DatasetId", # required
593
+ # })
594
+ #
595
+ # @example Response structure
596
+ #
597
+ # resp.dataset_id #=> String
598
+ #
599
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset AWS API Documentation
600
+ #
601
+ # @overload delete_dataset(params = {})
602
+ # @param [Hash] params ({})
603
+ def delete_dataset(params = {}, options = {})
604
+ req = build_request(:delete_dataset, params)
605
+ req.send_request(options)
606
+ end
607
+
608
+ # Get information about a Changeset.
609
+ #
610
+ # @option params [required, String] :dataset_id
611
+ # The unique identifier for the FinSpace Dataset where the Changeset is
612
+ # created.
613
+ #
614
+ # @option params [required, String] :changeset_id
615
+ # The unique identifier of the Changeset for which to get data.
616
+ #
617
+ # @return [Types::GetChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
618
+ #
619
+ # * {Types::GetChangesetResponse#changeset_id #changeset_id} => String
620
+ # * {Types::GetChangesetResponse#changeset_arn #changeset_arn} => String
621
+ # * {Types::GetChangesetResponse#dataset_id #dataset_id} => String
622
+ # * {Types::GetChangesetResponse#change_type #change_type} => String
623
+ # * {Types::GetChangesetResponse#source_params #source_params} => Hash&lt;String,String&gt;
624
+ # * {Types::GetChangesetResponse#format_params #format_params} => Hash&lt;String,String&gt;
625
+ # * {Types::GetChangesetResponse#create_time #create_time} => Integer
626
+ # * {Types::GetChangesetResponse#status #status} => String
627
+ # * {Types::GetChangesetResponse#error_info #error_info} => Types::ChangesetErrorInfo
628
+ # * {Types::GetChangesetResponse#active_until_timestamp #active_until_timestamp} => Integer
629
+ # * {Types::GetChangesetResponse#active_from_timestamp #active_from_timestamp} => Integer
630
+ # * {Types::GetChangesetResponse#updates_changeset_id #updates_changeset_id} => String
631
+ # * {Types::GetChangesetResponse#updated_by_changeset_id #updated_by_changeset_id} => String
632
+ #
633
+ # @example Request syntax with placeholder values
634
+ #
635
+ # resp = client.get_changeset({
636
+ # dataset_id: "DatasetId", # required
637
+ # changeset_id: "ChangesetId", # required
638
+ # })
639
+ #
640
+ # @example Response structure
641
+ #
642
+ # resp.changeset_id #=> String
643
+ # resp.changeset_arn #=> String
644
+ # resp.dataset_id #=> String
645
+ # resp.change_type #=> String, one of "REPLACE", "APPEND", "MODIFY"
646
+ # resp.source_params #=> Hash
647
+ # resp.source_params["StringMapKey"] #=> String
648
+ # resp.format_params #=> Hash
649
+ # resp.format_params["StringMapKey"] #=> String
650
+ # resp.create_time #=> Integer
651
+ # resp.status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED"
652
+ # resp.error_info.error_message #=> String
653
+ # resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
654
+ # resp.active_until_timestamp #=> Integer
655
+ # resp.active_from_timestamp #=> Integer
656
+ # resp.updates_changeset_id #=> String
657
+ # resp.updated_by_changeset_id #=> String
658
+ #
659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset AWS API Documentation
660
+ #
661
+ # @overload get_changeset(params = {})
662
+ # @param [Hash] params ({})
663
+ def get_changeset(params = {}, options = {})
664
+ req = build_request(:get_changeset, params)
665
+ req.send_request(options)
666
+ end
667
+
668
+ # Gets information about a Dataview.
669
+ #
670
+ # @option params [required, String] :data_view_id
671
+ # The unique identifier for the Dataview.
672
+ #
673
+ # @option params [required, String] :dataset_id
674
+ # The unique identifier for the Dataset used in the Dataview.
675
+ #
676
+ # @return [Types::GetDataViewResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
677
+ #
678
+ # * {Types::GetDataViewResponse#auto_update #auto_update} => Boolean
679
+ # * {Types::GetDataViewResponse#partition_columns #partition_columns} => Array&lt;String&gt;
680
+ # * {Types::GetDataViewResponse#dataset_id #dataset_id} => String
681
+ # * {Types::GetDataViewResponse#as_of_timestamp #as_of_timestamp} => Integer
682
+ # * {Types::GetDataViewResponse#error_info #error_info} => Types::DataViewErrorInfo
683
+ # * {Types::GetDataViewResponse#last_modified_time #last_modified_time} => Integer
684
+ # * {Types::GetDataViewResponse#create_time #create_time} => Integer
685
+ # * {Types::GetDataViewResponse#sort_columns #sort_columns} => Array&lt;String&gt;
686
+ # * {Types::GetDataViewResponse#data_view_id #data_view_id} => String
687
+ # * {Types::GetDataViewResponse#data_view_arn #data_view_arn} => String
688
+ # * {Types::GetDataViewResponse#destination_type_params #destination_type_params} => Types::DataViewDestinationTypeParams
689
+ # * {Types::GetDataViewResponse#status #status} => String
690
+ #
691
+ # @example Request syntax with placeholder values
692
+ #
693
+ # resp = client.get_data_view({
694
+ # data_view_id: "DataViewId", # required
695
+ # dataset_id: "DatasetId", # required
696
+ # })
697
+ #
698
+ # @example Response structure
699
+ #
700
+ # resp.auto_update #=> Boolean
701
+ # resp.partition_columns #=> Array
702
+ # resp.partition_columns[0] #=> String
703
+ # resp.dataset_id #=> String
704
+ # resp.as_of_timestamp #=> Integer
705
+ # resp.error_info.error_message #=> String
706
+ # resp.error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
707
+ # resp.last_modified_time #=> Integer
708
+ # resp.create_time #=> Integer
709
+ # resp.sort_columns #=> Array
710
+ # resp.sort_columns[0] #=> String
711
+ # resp.data_view_id #=> String
712
+ # resp.data_view_arn #=> String
713
+ # resp.destination_type_params.destination_type #=> String
714
+ # resp.destination_type_params.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
715
+ # resp.destination_type_params.s3_destination_export_file_format_options #=> Hash
716
+ # resp.destination_type_params.s3_destination_export_file_format_options["StringMapKey"] #=> String
717
+ # resp.status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"
718
+ #
719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView AWS API Documentation
720
+ #
721
+ # @overload get_data_view(params = {})
722
+ # @param [Hash] params ({})
723
+ def get_data_view(params = {}, options = {})
724
+ req = build_request(:get_data_view, params)
725
+ req.send_request(options)
726
+ end
727
+
728
+ # Returns information about a Dataset.
729
+ #
730
+ # @option params [required, String] :dataset_id
731
+ # The unique identifier for a Dataset.
732
+ #
733
+ # @return [Types::GetDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
734
+ #
735
+ # * {Types::GetDatasetResponse#dataset_id #dataset_id} => String
736
+ # * {Types::GetDatasetResponse#dataset_arn #dataset_arn} => String
737
+ # * {Types::GetDatasetResponse#dataset_title #dataset_title} => String
738
+ # * {Types::GetDatasetResponse#kind #kind} => String
739
+ # * {Types::GetDatasetResponse#dataset_description #dataset_description} => String
740
+ # * {Types::GetDatasetResponse#create_time #create_time} => Integer
741
+ # * {Types::GetDatasetResponse#last_modified_time #last_modified_time} => Integer
742
+ # * {Types::GetDatasetResponse#schema_definition #schema_definition} => Types::SchemaUnion
743
+ # * {Types::GetDatasetResponse#alias #alias} => String
744
+ # * {Types::GetDatasetResponse#status #status} => String
745
+ #
746
+ # @example Request syntax with placeholder values
747
+ #
748
+ # resp = client.get_dataset({
749
+ # dataset_id: "StringValueLength1to255", # required
750
+ # })
751
+ #
752
+ # @example Response structure
753
+ #
754
+ # resp.dataset_id #=> String
755
+ # resp.dataset_arn #=> String
756
+ # resp.dataset_title #=> String
757
+ # resp.kind #=> String, one of "TABULAR", "NON_TABULAR"
758
+ # resp.dataset_description #=> String
759
+ # resp.create_time #=> Integer
760
+ # resp.last_modified_time #=> Integer
761
+ # resp.schema_definition.tabular_schema_config.columns #=> Array
762
+ # resp.schema_definition.tabular_schema_config.columns[0].data_type #=> String, one of "STRING", "CHAR", "INTEGER", "TINYINT", "SMALLINT", "BIGINT", "FLOAT", "DOUBLE", "DATE", "DATETIME", "BOOLEAN", "BINARY"
763
+ # resp.schema_definition.tabular_schema_config.columns[0].column_name #=> String
764
+ # resp.schema_definition.tabular_schema_config.columns[0].column_description #=> String
765
+ # resp.schema_definition.tabular_schema_config.primary_key_columns #=> Array
766
+ # resp.schema_definition.tabular_schema_config.primary_key_columns[0] #=> String
767
+ # resp.alias #=> String
768
+ # resp.status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING"
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset AWS API Documentation
771
+ #
772
+ # @overload get_dataset(params = {})
773
+ # @param [Hash] params ({})
774
+ def get_dataset(params = {}, options = {})
775
+ req = build_request(:get_dataset, params)
776
+ req.send_request(options)
777
+ end
778
+
779
+ # Request programmatic credentials to use with FinSpace SDK.
430
780
  #
431
781
  # @option params [Integer] :duration_in_minutes
432
782
  # The time duration in which the credentials remain valid.
433
783
  #
434
784
  # @option params [required, String] :environment_id
435
- # The habanero environment identifier.
785
+ # The FinSpace environment identifier.
436
786
  #
437
787
  # @return [Types::GetProgrammaticAccessCredentialsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
438
788
  #
@@ -462,8 +812,9 @@ module Aws::FinSpaceData
462
812
  req.send_request(options)
463
813
  end
464
814
 
465
- # A temporary Amazon S3 location to copy your files from a source
466
- # location to stage or use as a scratch space in Habanero notebook.
815
+ # A temporary Amazon S3 location, where you can copy your files from a
816
+ # source location to stage or use as a scratch space in FinSpace
817
+ # notebook.
467
818
  #
468
819
  # @option params [String] :location_type
469
820
  # Specify the type of the working location.
@@ -473,7 +824,7 @@ module Aws::FinSpaceData
473
824
  # SageMaker studio.
474
825
  #
475
826
  # * `INGESTION` - Use the Amazon S3 location as a staging location to
476
- # copy your data content and then use the location with the changeset
827
+ # copy your data content and then use the location with the Changeset
477
828
  # creation operation.
478
829
  #
479
830
  # @return [Types::GetWorkingLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -503,6 +854,298 @@ module Aws::FinSpaceData
503
854
  req.send_request(options)
504
855
  end
505
856
 
857
+ # Lists the FinSpace Changesets for a Dataset.
858
+ #
859
+ # @option params [required, String] :dataset_id
860
+ # The unique identifier for the FinSpace Dataset to which the Changeset
861
+ # belongs.
862
+ #
863
+ # @option params [Integer] :max_results
864
+ # The maximum number of results per page.
865
+ #
866
+ # @option params [String] :next_token
867
+ # A token indicating where a results page should begin.
868
+ #
869
+ # @return [Types::ListChangesetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
870
+ #
871
+ # * {Types::ListChangesetsResponse#changesets #changesets} => Array&lt;Types::ChangesetSummary&gt;
872
+ # * {Types::ListChangesetsResponse#next_token #next_token} => String
873
+ #
874
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
875
+ #
876
+ # @example Request syntax with placeholder values
877
+ #
878
+ # resp = client.list_changesets({
879
+ # dataset_id: "DatasetId", # required
880
+ # max_results: 1,
881
+ # next_token: "PaginationToken",
882
+ # })
883
+ #
884
+ # @example Response structure
885
+ #
886
+ # resp.changesets #=> Array
887
+ # resp.changesets[0].changeset_id #=> String
888
+ # resp.changesets[0].changeset_arn #=> String
889
+ # resp.changesets[0].dataset_id #=> String
890
+ # resp.changesets[0].change_type #=> String, one of "REPLACE", "APPEND", "MODIFY"
891
+ # resp.changesets[0].source_params #=> Hash
892
+ # resp.changesets[0].source_params["StringMapKey"] #=> String
893
+ # resp.changesets[0].format_params #=> Hash
894
+ # resp.changesets[0].format_params["StringMapKey"] #=> String
895
+ # resp.changesets[0].create_time #=> Integer
896
+ # resp.changesets[0].status #=> String, one of "PENDING", "FAILED", "SUCCESS", "RUNNING", "STOP_REQUESTED"
897
+ # resp.changesets[0].error_info.error_message #=> String
898
+ # resp.changesets[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
899
+ # resp.changesets[0].active_until_timestamp #=> Integer
900
+ # resp.changesets[0].active_from_timestamp #=> Integer
901
+ # resp.changesets[0].updates_changeset_id #=> String
902
+ # resp.changesets[0].updated_by_changeset_id #=> String
903
+ # resp.next_token #=> String
904
+ #
905
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets AWS API Documentation
906
+ #
907
+ # @overload list_changesets(params = {})
908
+ # @param [Hash] params ({})
909
+ def list_changesets(params = {}, options = {})
910
+ req = build_request(:list_changesets, params)
911
+ req.send_request(options)
912
+ end
913
+
914
+ # Lists all available Dataviews for a Dataset.
915
+ #
916
+ # @option params [required, String] :dataset_id
917
+ # The unique identifier of the Dataset for which to retrieve Dataviews.
918
+ #
919
+ # @option params [String] :next_token
920
+ # A token indicating where a results page should begin.
921
+ #
922
+ # @option params [Integer] :max_results
923
+ # The maximum number of results per page.
924
+ #
925
+ # @return [Types::ListDataViewsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
926
+ #
927
+ # * {Types::ListDataViewsResponse#next_token #next_token} => String
928
+ # * {Types::ListDataViewsResponse#data_views #data_views} => Array&lt;Types::DataViewSummary&gt;
929
+ #
930
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
931
+ #
932
+ # @example Request syntax with placeholder values
933
+ #
934
+ # resp = client.list_data_views({
935
+ # dataset_id: "DatasetId", # required
936
+ # next_token: "PaginationToken",
937
+ # max_results: 1,
938
+ # })
939
+ #
940
+ # @example Response structure
941
+ #
942
+ # resp.next_token #=> String
943
+ # resp.data_views #=> Array
944
+ # resp.data_views[0].data_view_id #=> String
945
+ # resp.data_views[0].data_view_arn #=> String
946
+ # resp.data_views[0].dataset_id #=> String
947
+ # resp.data_views[0].as_of_timestamp #=> Integer
948
+ # resp.data_views[0].partition_columns #=> Array
949
+ # resp.data_views[0].partition_columns[0] #=> String
950
+ # resp.data_views[0].sort_columns #=> Array
951
+ # resp.data_views[0].sort_columns[0] #=> String
952
+ # resp.data_views[0].status #=> String, one of "RUNNING", "STARTING", "FAILED", "CANCELLED", "TIMEOUT", "SUCCESS", "PENDING", "FAILED_CLEANUP_FAILED"
953
+ # resp.data_views[0].error_info.error_message #=> String
954
+ # resp.data_views[0].error_info.error_category #=> String, one of "VALIDATION", "SERVICE_QUOTA_EXCEEDED", "ACCESS_DENIED", "RESOURCE_NOT_FOUND", "THROTTLING", "INTERNAL_SERVICE_EXCEPTION", "CANCELLED", "USER_RECOVERABLE"
955
+ # resp.data_views[0].destination_type_properties.destination_type #=> String
956
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format #=> String, one of "PARQUET", "DELIMITED_TEXT"
957
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options #=> Hash
958
+ # resp.data_views[0].destination_type_properties.s3_destination_export_file_format_options["StringMapKey"] #=> String
959
+ # resp.data_views[0].auto_update #=> Boolean
960
+ # resp.data_views[0].create_time #=> Integer
961
+ # resp.data_views[0].last_modified_time #=> Integer
962
+ #
963
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews AWS API Documentation
964
+ #
965
+ # @overload list_data_views(params = {})
966
+ # @param [Hash] params ({})
967
+ def list_data_views(params = {}, options = {})
968
+ req = build_request(:list_data_views, params)
969
+ req.send_request(options)
970
+ end
971
+
972
+ # Lists all of the active Datasets that a user has access to.
973
+ #
974
+ # @option params [String] :next_token
975
+ # A token indicating where a results page should begin.
976
+ #
977
+ # @option params [Integer] :max_results
978
+ # The maximum number of results per page.
979
+ #
980
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
981
+ #
982
+ # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::Dataset&gt;
983
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
984
+ #
985
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
986
+ #
987
+ # @example Request syntax with placeholder values
988
+ #
989
+ # resp = client.list_datasets({
990
+ # next_token: "PaginationToken",
991
+ # max_results: 1,
992
+ # })
993
+ #
994
+ # @example Response structure
995
+ #
996
+ # resp.datasets #=> Array
997
+ # resp.datasets[0].dataset_id #=> String
998
+ # resp.datasets[0].dataset_arn #=> String
999
+ # resp.datasets[0].dataset_title #=> String
1000
+ # resp.datasets[0].kind #=> String, one of "TABULAR", "NON_TABULAR"
1001
+ # resp.datasets[0].dataset_description #=> String
1002
+ # resp.datasets[0].owner_info.name #=> String
1003
+ # resp.datasets[0].owner_info.phone_number #=> String
1004
+ # resp.datasets[0].owner_info.email #=> String
1005
+ # resp.datasets[0].create_time #=> Integer
1006
+ # resp.datasets[0].last_modified_time #=> Integer
1007
+ # resp.datasets[0].schema_definition.tabular_schema_config.columns #=> Array
1008
+ # resp.datasets[0].schema_definition.tabular_schema_config.columns[0].data_type #=> String, one of "STRING", "CHAR", "INTEGER", "TINYINT", "SMALLINT", "BIGINT", "FLOAT", "DOUBLE", "DATE", "DATETIME", "BOOLEAN", "BINARY"
1009
+ # resp.datasets[0].schema_definition.tabular_schema_config.columns[0].column_name #=> String
1010
+ # resp.datasets[0].schema_definition.tabular_schema_config.columns[0].column_description #=> String
1011
+ # resp.datasets[0].schema_definition.tabular_schema_config.primary_key_columns #=> Array
1012
+ # resp.datasets[0].schema_definition.tabular_schema_config.primary_key_columns[0] #=> String
1013
+ # resp.datasets[0].alias #=> String
1014
+ # resp.next_token #=> String
1015
+ #
1016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets AWS API Documentation
1017
+ #
1018
+ # @overload list_datasets(params = {})
1019
+ # @param [Hash] params ({})
1020
+ def list_datasets(params = {}, options = {})
1021
+ req = build_request(:list_datasets, params)
1022
+ req.send_request(options)
1023
+ end
1024
+
1025
+ # Updates a FinSpace Changeset.
1026
+ #
1027
+ # @option params [String] :client_token
1028
+ # A token used to ensure idempotency.
1029
+ #
1030
+ # **A suitable default value is auto-generated.** You should normally
1031
+ # not need to pass this option.**
1032
+ #
1033
+ # @option params [required, String] :dataset_id
1034
+ # The unique identifier for the FinSpace Dataset in which the Changeset
1035
+ # is created.
1036
+ #
1037
+ # @option params [required, String] :changeset_id
1038
+ # The unique identifier for the Changeset to update.
1039
+ #
1040
+ # @option params [required, Hash<String,String>] :source_params
1041
+ # Options that define the location of the data being ingested.
1042
+ #
1043
+ # @option params [required, Hash<String,String>] :format_params
1044
+ # Options that define the structure of the source file(s).
1045
+ #
1046
+ # @return [Types::UpdateChangesetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1047
+ #
1048
+ # * {Types::UpdateChangesetResponse#changeset_id #changeset_id} => String
1049
+ # * {Types::UpdateChangesetResponse#dataset_id #dataset_id} => String
1050
+ #
1051
+ # @example Request syntax with placeholder values
1052
+ #
1053
+ # resp = client.update_changeset({
1054
+ # client_token: "ClientToken",
1055
+ # dataset_id: "DatasetId", # required
1056
+ # changeset_id: "ChangesetId", # required
1057
+ # source_params: { # required
1058
+ # "StringMapKey" => "StringMapValue",
1059
+ # },
1060
+ # format_params: { # required
1061
+ # "StringMapKey" => "StringMapValue",
1062
+ # },
1063
+ # })
1064
+ #
1065
+ # @example Response structure
1066
+ #
1067
+ # resp.changeset_id #=> String
1068
+ # resp.dataset_id #=> String
1069
+ #
1070
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset AWS API Documentation
1071
+ #
1072
+ # @overload update_changeset(params = {})
1073
+ # @param [Hash] params ({})
1074
+ def update_changeset(params = {}, options = {})
1075
+ req = build_request(:update_changeset, params)
1076
+ req.send_request(options)
1077
+ end
1078
+
1079
+ # Updates a FinSpace Dataset.
1080
+ #
1081
+ # @option params [String] :client_token
1082
+ # A token used to ensure idempotency.
1083
+ #
1084
+ # **A suitable default value is auto-generated.** You should normally
1085
+ # not need to pass this option.**
1086
+ #
1087
+ # @option params [required, String] :dataset_id
1088
+ # The unique identifier for the Dataset to update.
1089
+ #
1090
+ # @option params [required, String] :dataset_title
1091
+ # A display title for the Dataset.
1092
+ #
1093
+ # @option params [required, String] :kind
1094
+ # The format in which the Dataset data is structured.
1095
+ #
1096
+ # * `TABULAR` - Data is structured in a tabular format.
1097
+ #
1098
+ # * `NON_TABULAR` - Data is structured in a non-tabular format.
1099
+ #
1100
+ # @option params [String] :dataset_description
1101
+ # A description for the Dataset.
1102
+ #
1103
+ # @option params [String] :alias
1104
+ # The unique resource identifier for a Dataset.
1105
+ #
1106
+ # @option params [Types::SchemaUnion] :schema_definition
1107
+ # Definition for a schema on a tabular Dataset.
1108
+ #
1109
+ # @return [Types::UpdateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1110
+ #
1111
+ # * {Types::UpdateDatasetResponse#dataset_id #dataset_id} => String
1112
+ #
1113
+ # @example Request syntax with placeholder values
1114
+ #
1115
+ # resp = client.update_dataset({
1116
+ # client_token: "ClientToken",
1117
+ # dataset_id: "DatasetId", # required
1118
+ # dataset_title: "DatasetTitle", # required
1119
+ # kind: "TABULAR", # required, accepts TABULAR, NON_TABULAR
1120
+ # dataset_description: "DatasetDescription",
1121
+ # alias: "AliasString",
1122
+ # schema_definition: {
1123
+ # tabular_schema_config: {
1124
+ # columns: [
1125
+ # {
1126
+ # data_type: "STRING", # accepts STRING, CHAR, INTEGER, TINYINT, SMALLINT, BIGINT, FLOAT, DOUBLE, DATE, DATETIME, BOOLEAN, BINARY
1127
+ # column_name: "ColumnName",
1128
+ # column_description: "ColumnDescription",
1129
+ # },
1130
+ # ],
1131
+ # primary_key_columns: ["ColumnName"],
1132
+ # },
1133
+ # },
1134
+ # })
1135
+ #
1136
+ # @example Response structure
1137
+ #
1138
+ # resp.dataset_id #=> String
1139
+ #
1140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset AWS API Documentation
1141
+ #
1142
+ # @overload update_dataset(params = {})
1143
+ # @param [Hash] params ({})
1144
+ def update_dataset(params = {}, options = {})
1145
+ req = build_request(:update_dataset, params)
1146
+ req.send_request(options)
1147
+ end
1148
+
506
1149
  # @!endgroup
507
1150
 
508
1151
  # @param params ({})
@@ -516,7 +1159,7 @@ module Aws::FinSpaceData
516
1159
  params: params,
517
1160
  config: config)
518
1161
  context[:gem_name] = 'aws-sdk-finspacedata'
519
- context[:gem_version] = '1.5.0'
1162
+ context[:gem_version] = '1.9.0'
520
1163
  Seahorse::Client::Request.new(handlers, context)
521
1164
  end
522
1165