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