aws-sdk-finspacedata 1.4.0 → 1.8.0

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